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

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

ListStreams

返回一个StreamInfo对象数组。每个对象都描述了一个流。要仅检索满足特定条件的直播,可以指定StreamNameCondition

请求语法

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

URI 请求参数

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

请求正文

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

MaxResults

响应中要返回的最大直播数量。默认值为 10,000。

类型:整数

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

必需:否

NextToken

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

类型:字符串

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

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

必需:否

StreamNameCondition

可选:仅返回满足特定条件的直播。目前,您只能将直播名称的前缀指定为条件。

类型:StreamNameCondition 对象

必需:否

响应语法

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "StreamInfoList": [ { "CreationTime": number, "DataRetentionInHours": number, "DeviceName": "string", "KmsKeyId": "string", "MediaType": "string", "Status": "string", "StreamARN": "string", "StreamName": "string", "Version": "string" } ] }

响应元素

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

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

NextToken

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

类型:字符串

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

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

StreamInfoList

StreamInfo 对象数组。

类型:StreamInfo 对象数组

错误

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

ClientLimitExceededException

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

HTTP 状态代码:400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码:400

另请参阅

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