本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
為指定的信令通道提供用於傳送和接收訊息的端點。此 API 使用SingleMasterChannelEndpointConfiguration輸入參數，該參數由Protocols和Role屬性組成。
Protocols用於確定通信機制。例如，如果您指定WSS為通訊協定，則此 API 會產生安全的 Websocket 端點。如果您指定HTTPS為通訊協定，則此 API 會產生一個 HTTPS 端點。如果您指定WEBRTC為通訊協定，但未設定訊號通道進行擷取，您將會收到錯誤訊息。InvalidArgumentException
Role決定訊息傳送權限。MASTER角色導致此 API 生成一個端點，客戶可以使用該端點與渠道上的任何觀眾進行通信。VIEWER角色導致此 API 生成一個端點，客戶端可用於僅與MASTER.
請求語法
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"SingleMasterChannelEndpointConfiguration": {
"Protocols": [ "string" ],
"Role": "string"
}
}URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- ChannelARN
-
您要取得端點之信號通道的 Amazon 資源名稱 (ARN)。
類型：字串
長度限制：長度下限為 1。長度上限為 1024。
模式：
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+必要：是
- SingleMasterChannelEndpointConfiguration
-
包含
SINGLE_MASTER通道類型的端點配置的結構。類型：SingleMasterChannelEndpointConfiguration 物件
必要：否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"ResourceEndpointList": [
{
"Protocol": "string",
"ResourceEndpoint": "string"
}
]
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- ResourceEndpointList
-
指定信令通道的端點清單。
類型：ResourceEndpointListItem 物件陣列
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- AccessDeniedException
-
您沒有執行此作業所需的權限。
狀態碼：
- ClientLimitExceededException
-
Kinesis Video Streams 已限制要求，因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。
HTTP 狀態碼：400
- InvalidArgumentException
-
此輸入參數的值無效。
HTTP 狀態碼：400
- ResourceInUseException
-
當輸入
StreamARN或ChannelARNinCLOUD_STORAGE_MODE已對應至不同的 Kinesis Video Stream 資源，或者如果提供的輸入StreamARN或不處ChannelARN於作用中狀態，請嘗試下列其中一種方法：-
用於確定給定通道的流映射到的
DescribeMediaStorageConfigurationAPI。 -
用於確定給定流映射到的信道的
DescribeMappedResourceConfigurationAPI。 -
DescribeSignalingChannel用來判斷資源狀態的DescribeStream或 API。
HTTP 狀態碼：400
-
- ResourceNotFoundException
-
Amazon Kinesis Video Streams 找不到您指定的串流。
HTTP 狀態碼：404
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
