本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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 区域 必须唯一。
类型:字符串
长度限制:最小长度为 1。长度上限为 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
-
当输入
StreamARN
或ChannelARN
输入已映射到不同CLOUD_STORAGE_MODE
的 Kinesis Video Stream 资源,或者提供的输入StreamARN
或未ChannelARN
处于活动状态时,请尝试以下操作之一:-
用于确定给定频道映射到什么的
DescribeMediaStorageConfiguration
API。 -
用于确定给定流映射到的频道的
DescribeMappedResourceConfiguration
API。 -
DescribeSignalingChannel
用于确定资源状态的DescribeStream
或 API。
HTTP 状态代码:400
-
- TagsPerResourceExceededLimitException
-
您已超过可以与资源关联的标签限制。一个 Kinesis 视频流最多可以支持 50 个标签。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: