本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DeleteEdgeConfiguration
非同步 API,可刪除串流的現有邊緣組態,以及 Edge Agent 中的對應媒體。
當您呼叫此 API 時,同步狀態會設為 DELETING
。刪除程序會開始,其中作用中的邊緣任務會停止,且所有媒體都會從邊緣裝置刪除。刪除的時間會有所不同,取決於儲存媒體的總數量。如果刪除程序失敗,同步狀態會變更為 DELETE_FAILED
。您將需要重試刪除。
當刪除程序成功完成時,就無法再存取邊緣組態。
注意
此 API 不適用於 AWS 非洲 (開普敦) 區域 af-south-1。
請求語法
POST /deleteEdgeConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string
",
"StreamName": "string
"
}
URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- StreamARN
-
串流的 Amazon Resource Name (ARN)。指定
StreamName
或StreamARN
。類型:字串
長度限制:長度下限為 1。長度上限為 1024。
模式:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
必要:否
- StreamName
-
要從中刪除邊緣組態的串流名稱。指定
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
-
Amazon Kinesis Video Streams 找不到您指定的串流。
HTTP 狀態碼:404
- StreamEdgeConfigurationNotFoundException
-
當 Amazon Kinesis Video Stream 找不到您指定的串流邊緣組態時所產生的例外狀況。
HTTP 狀態碼:404
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: