GetSignalingChannelEndpoint - Amazon Kinesis Video Streams
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

GetSignalingChannelEndpoint

为指定的信令通道提供一个用于发送和接收消息的端点。此 API 使用SingleMasterChannelEndpointConfiguration输入参数,该参数由ProtocolsRole属性组成。

Protocols用于确定通信机制。例如,如果您指定WSS为协议,则此 API 会生成一个安全的 websocket 端点。如果您指定HTTPS为协议,则此 API 会生成一个 HTTPS 终端节点。

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

您没有执行此操作所需的权限。

HTTP 状态代码:401

ClientLimitExceededException

Kinesis Video Streams 已限制该请求,因为你已超过允许的客户端调用限制。稍后再尝试拨打电话。

HTTP 状态代码:400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码:400

ResourceInUseException

如果输入StreamARNChannelARN输入已映射到其他 Kinesis Video Stream 资源,或者提供的输入StreamARN或未ChannelARN处于 “活动” 状态,请尝试以下方法之一:CLOUD_STORAGE_MODE

  1. 用于确定给定频道的直播映射到什么的 DescribeMediaStorageConfiguration API。

  2. 用于确定给定直播映射到哪个频道的 DescribeMappedResourceConfiguration API。

  3. DescribeStreamDescribeSignalingChannel API,用于确定资源状态。

HTTP 状态代码:400

ResourceNotFoundException

亚马逊 Kinesis Video Streams 找不到你指定的直播。

HTTP 状态代码:404

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: