DescribeSignalingChannel - Amazon Kinesis Video Streams

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeSignalingChannel

返回有關信令通道的最新信息。您必須指定要描述之通道的名稱或 Amazon 資源名稱 (ARN)。

請求語法

POST /describeSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "ChannelName": "string" }

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

ChannelARN

您要描述的訊號通道的 ARN。

類型:字串

長度限制:長度下限為 1。長度上限為 1024。

模式:arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

必要:否

ChannelName

您要描述的信令通道的名稱。

類型:字串

長度限制:長度下限為 1。長度上限為 256。

模式:[a-zA-Z0-9_.-]+

必要:否

回應語法

HTTP/1.1 200 Content-type: application/json { "ChannelInfo": { "ChannelARN": "string", "ChannelName": "string", "ChannelStatus": "string", "ChannelType": "string", "CreationTime": number, "SingleMasterConfiguration": { "MessageTtlSeconds": number }, "Version": "string" } }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

ChannelInfo

封裝指定信令通道的中繼資料和屬性的結構。

類型:ChannelInfo 物件

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

AccessDeniedException

您沒有執行此作業所需的權限。

狀態碼:

ClientLimitExceededException

Kinesis Video Streams 已限制要求,因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。

HTTP 狀態碼:400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼:400

ResourceNotFoundException

Amazon Kinesis Video Streams 找不到您指定的串流。

HTTP 狀態碼:404

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: