

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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 资源名称 (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`输入已映射到其他 Kinesis Video Stream 资源，或者提供的输入`StreamARN`或未`ChannelARN`处于 “活动” 状态，请尝试以下方法之一：`CLOUD_STORAGE_MODE`  

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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS Python 软件开发工具包](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) 