本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DeleteEdgeConfiguration
一种异步 API,用于从 Edge Agent 中删除流的现有边缘配置以及相应的媒体。
当您调用此 API 时,同步状态设置为DELETING
。删除过程开始,活动的 Edge 作业将停止,所有媒体都将从 Edge 设备中删除。删除时间会有所不同,具体取决于存储的媒体总量。如果删除过程失败,同步状态将更改为DELETE_FAILED
。你需要重试删除。
成功完成删除过程后,将无法再访问 Edge 配置。
注意
此 API 在Amazon非洲(开普敦)区域 af-south-1 不可用。
请求语法
POST /deleteEdgeConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string
",
"StreamName": "string
"
}
URI 请求参数
该请求不使用任何 URI 参数。
请求正文
请求接受采用 JSON 格式的以下数据。
- StreamARN
-
流的 Amazon 资源名称(ARN)。指定
StreamName
或StreamARN
。类型:字符串
长度限制:最小长度为 1。长度上限为 1024。
模式:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
必需:否
- StreamName
-
要从中删除 Edge 配置的流的名称。指定
StreamName
或StreamARN
。类型:字符串
长度限制:最小长度为 1。长度上限为 256。
模式:
[a-zA-Z0-9_.-]+
必需:否
响应语法
HTTP/1.1 200
响应元素
如果此操作成功,则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。
错误
有关所有操作常见错误的信息,请参阅常见错误。
- AccessDeniedException
-
您没有执行此操作所需的权限。
HTTP 状态码:401
- ClientLimitExceededException
-
Kinesis Video Streams 限制了该请求,因为您已超过允许的客户端呼叫限制。稍后再试打电话。
HTTP 状态代码:400
- InvalidArgumentException
-
此输入参数的值无效。
HTTP 状态代码:400
- ResourceNotFoundException
-
亚马逊 Kinesis Video Streams 找不到你指定的直播。
HTTP 状态代码:404
- StreamEdgeConfigurationNotFoundException
-
当 Amazon Kinesis 视频流找不到您指定的直播边缘配置时,会出现异常。
HTTP 状态代码:404
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: