本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
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
通道類型配置的結構。類型:SingleMasterConfiguration 物件
必要:否
- Tags
-
您要與此通道關聯的一組標籤(鍵值對)。
類型:Tag 物件陣列
陣列成員:項目數下限為 0。項目數上限為 50。
必要:否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"ChannelARN": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- ChannelARN
-
Amazon 資源名稱(ARN)創建的渠道。
類型:字串
長度限制:長度下限為 1。長度上限為 1024。
模式:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- AccessDeniedException
-
您沒有執行此作業所需的權限。
狀態碼:
- AccountChannelLimitExceededException
-
您已達到此區域的有效信號通道 AWS 帳戶 上限。
HTTP 狀態碼:400
- ClientLimitExceededException
-
Kinesis Video Streams 已限制要求,因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。
HTTP 狀態碼:400
- InvalidArgumentException
-
此輸入參數的值無效。
HTTP 狀態碼:400
- ResourceInUseException
-
當輸入
StreamARN
或ChannelARN
inCLOUD_STORAGE_MODE
已對應至不同的 Kinesis Video Stream 資源,或者如果提供的輸入StreamARN
或不處ChannelARN
於作用中狀態,請嘗試下列其中一種方法:-
用於確定給定通道的流映射到的
DescribeMediaStorageConfiguration
API。 -
用於確定給定流映射到的信道的
DescribeMappedResourceConfiguration
API。 -
DescribeSignalingChannel
用來判斷資源狀態的DescribeStream
或 API。
HTTP 狀態碼:400
-
- TagsPerResourceExceededLimitException
-
您已超過可與資源關聯的標籤限制。Kinesis 影片串流最多可支援 50 個標籤。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: