本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
DescribeSignalingChannel
返回有关信令通道的最新信息。您必须指定要描述的频道的名称或亚马逊资源名称 (ARN)。
请求语法
POST /describeSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ChannelName": "string"
}URI 请求参数
该请求不使用任何 URI 参数。
请求正文
请求接受采用 JSON 格式的以下数据。
- ChannelARN
-
您要描述的信令信道的 ARN。
类型：字符串
长度限制：最小长度为 1。长度上限为 1024。
模式：
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+必需：否
- ChannelName
-
您要描述的信令通道的名称。
类型：字符串
长度限制：最小长度为 0。长度上限为 256。
模式：
[a-zA-Z0-9_.-]+必需：否
响应语法
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfo": {
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "string"
}
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- ChannelInfo
-
一种封装指定信令通道的元数据和属性的结构。
类型：ChannelInfo 对象
错误
有关所有操作返回的常见错误的信息，请参阅常见错误。
- AccessDeniedException
-
您没有执行此操作所需的权限。
HTTP 状态代码：401
- ClientLimitExceededException
-
Kinesis Video Streams 已限制该请求，因为你已超过允许的客户端调用限制。稍后再尝试拨打电话。
HTTP 状态代码：400
- InvalidArgumentException
-
此输入参数的值无效。
HTTP 状态代码：400
- ResourceNotFoundException
-
亚马逊 Kinesis Video Streams 找不到你指定的直播。
HTTP 状态代码：404
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：