CreateSignalingChannel - Amazon Kinesis Video Streams

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

CreateSignalingChannel

建立訊號頻道。

CreateSignalingChannel 是一種非同步操作。

請求語法

POST /createSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelName": "string", "ChannelType": "string", "SingleMasterConfiguration": { "MessageTtlSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ] }

URI 請求參數

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

請求主體

請求接受以下JSON格式的資料。

ChannelName

您正在建立的訊號通道的名稱。每個 AWS 帳戶 和 都必須是唯一的 AWS 區域。

類型:字串

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

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

必要:是

ChannelType

您正在建立的訊號通道的類型。目前唯一支援的通道類型為 SINGLE_MASTER

類型:字串

有效值:SINGLE_MASTER | FULL_MESH

必要:否

SingleMasterConfiguration

包含SINGLE_MASTER頻道類型組態的結構。頻道訊息存留時間的預設組態為 60 秒 (1 分鐘)。

類型:SingleMasterConfiguration 物件

必要:否

Tags

您要與此頻道建立關聯的一組標籤 (鍵/值對)。

類型:Tag 物件陣列

陣列成員:項目數下限為 0。項目數上限為 50。

必要:否

回應語法

HTTP/1.1 200 Content-type: application/json { "ChannelARN": "string" }

回應元素

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

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

ChannelARN

所建立頻道的 Amazon Resource Name (ARN)。

類型:字串

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

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

錯誤

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

AccessDeniedException

您沒有執行此操作所需的許可。

HTTP 狀態碼:401

AccountChannelLimitExceededException

您已達到此區域中作用中訊號頻道 AWS 帳戶 的上限。

HTTP 狀態碼:400

ClientLimitExceededException

Kinesis Video Streams 已調節請求,因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。

HTTP 狀態碼:400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼:400

ResourceInUseException

當輸入StreamARNChannelARN中的 CLOUD_STORAGE_MODE 已映射至不同的 Kinesis Video Stream 資源,或提供的輸入StreamARNChannelARN 未處於作用中狀態時,請嘗試下列其中一個 :

  1. DescribeMediaStorageConfiguration API 決定串流指定頻道所對應的 。

  2. DescribeMappedResourceConfiguration API 決定指定串流對應的頻道。

  3. DescribeStreamDescribeSignalingChannelAPI來判斷資源的狀態。

HTTP 狀態碼:400

TagsPerResourceExceededLimitException

您已超過可與資源建立關聯的標籤限制。Kinesis 影片串流最多可支援 50 個標籤。

HTTP 狀態碼:400

另請參閱

如需在其中一種特定語言API中使用此功能的詳細資訊 AWS SDKs,請參閱以下內容: