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

# GetSignalingChannelEndpoint
<a name="API_GetSignalingChannelEndpoint"></a>

為指定的訊號頻道提供端點，以傳送和接收訊息。此 API 使用`SingleMasterChannelEndpointConfiguration`輸入參數，其中包含 `Protocols`和 `Role` 屬性。

 `Protocols` 用於判斷通訊機制。例如，如果您指定 `WSS`做為通訊協定，此 API 會產生安全的 Websocket 端點。如果您指定 `HTTPS`做為通訊協定，此 API 會產生 HTTPS 端點。如果您將 指定`WEBRTC`為通訊協定，但訊號頻道未設定為擷取，則會收到錯誤 `InvalidArgumentException`。

 `Role` 會決定訊息許可。`MASTER` 角色會導致此 API 產生端點，用戶端可用來與頻道上的任何檢視器通訊。`VIEWER` 角色會導致此 API 產生端點，用戶端只能用來與 通訊`MASTER`。

## 請求語法
<a name="API_GetSignalingChannelEndpoint_RequestSyntax"></a>

```
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "{{string}}",
   "SingleMasterChannelEndpointConfiguration": { 
      "Protocols": [ "{{string}}" ],
      "Role": "{{string}}"
   }
}
```

## URI 請求參數
<a name="API_GetSignalingChannelEndpoint_RequestParameters"></a>

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

## 請求主體
<a name="API_GetSignalingChannelEndpoint_RequestBody"></a>

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

 ** [ChannelARN](#API_GetSignalingChannelEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-request-ChannelARN"></a>
您要取得端點之訊號管道的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：是

 ** [SingleMasterChannelEndpointConfiguration](#API_GetSignalingChannelEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-request-SingleMasterChannelEndpointConfiguration"></a>
包含`SINGLE_MASTER`頻道類型端點組態的結構。  
類型：[SingleMasterChannelEndpointConfiguration](API_SingleMasterChannelEndpointConfiguration.md) 物件  
必要：否

## 回應語法
<a name="API_GetSignalingChannelEndpoint_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ResourceEndpointList": [ 
      { 
         "Protocol": "string",
         "ResourceEndpoint": "string"
      }
   ]
}
```

## 回應元素
<a name="API_GetSignalingChannelEndpoint_ResponseElements"></a>

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

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

 ** [ResourceEndpointList](#API_GetSignalingChannelEndpoint_ResponseSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-response-ResourceEndpointList"></a>
指定訊號頻道的端點清單。  
類型：[ResourceEndpointListItem](API_ResourceEndpointListItem.md) 物件陣列

## 錯誤
<a name="API_GetSignalingChannelEndpoint_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
您沒有執行此操作所需的許可。  
HTTP 狀態碼：401

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
當輸入`StreamARN`或 `ChannelARN` 中的 `CLOUD_STORAGE_MODE` 已映射至不同的 Kinesis Video Stream 資源，或提供的輸入`StreamARN`或 `ChannelARN` 未處於作用中狀態時，請嘗試下列其中一個 ：  

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_GetSignalingChannelEndpoint_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 C\+\+ 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)