ListSignalingChannels - Amazon Kinesis Video Streams

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

ListSignalingChannels

返回一个ChannelInfo对象数组。每个对象都描述了一个信令信道。要仅检索满足特定条件的频道,可以指定ChannelNameCondition

请求语法

POST /listSignalingChannels HTTP/1.1 Content-type: application/json { "ChannelNameCondition": { "ComparisonOperator": "string", "ComparisonValue": "string" }, "MaxResults": number, "NextToken": "string" }

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

ChannelNameCondition

可选:仅返回满足特定条件的频道。

类型:ChannelNameCondition 对象

必需:否

MaxResults

响应中要返回的最大频道数。默认值为 500。

类型:整数

有效范围:最小值为 1。最大值为 10000。

必需:否

NextToken

如果您指定此参数,则当ListSignalingChannels操作的结果被截断时,调用将在响应NextToken中返回。要获得另一批频道,请在下次请求中提供此令牌。

类型:字符串

长度约束:最小长度为 0。最大长度为 512。

模式:[a-zA-Z0-9+/=]*

必需:否

响应语法

HTTP/1.1 200 Content-type: application/json { "ChannelInfoList": [ { "ChannelARN": "string", "ChannelName": "string", "ChannelStatus": "string", "ChannelType": "string", "CreationTime": number, "SingleMasterConfiguration": { "MessageTtlSeconds": number }, "Version": "string" } ], "NextToken": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

ChannelInfoList

ChannelInfo 对象数组。

类型:ChannelInfo 对象数组

NextToken

如果响应被截断,则调用会返回带有令牌的此元素。要获取下一批直播,请在下一个请求中使用此令牌。

类型:字符串

长度约束:最小长度为 0。最大长度为 512。

模式:[a-zA-Z0-9+/=]*

错误

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

AccessDeniedException

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

HTTP 状态代码:401

ClientLimitExceededException

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

HTTP 状态代码:400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: