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

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

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

您正在创建的信令通道的名称。此名称对于每个 Amazon Web Services 账户 和 Amazon Web Services 区域 必须唯一。

类型:字符串

长度限制:最小长度为 0。长度上限为 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

已创建频道的亚马逊资源名称 (ARN)。

类型:字符串

长度限制:最小长度为 1。长度上限为 1024。

模式:arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

AccessDeniedException

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

HTTP 状态代码:401

AccountChannelLimitExceededException

您已达到该区域Amazon Web Services 账户中此活动的信令通道的最大限制。

HTTP 状态代码:400

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

TagsPerResourceExceededLimitException

您已超出可以与资源关联的标签上限。一个 Kinesis 视频流最多可以支持 50 个标签。

HTTP 状态代码:400

另请参阅

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