DescribeStream - Amazon Kinesis Video Streams

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

DescribeStream

返回有关指定直播的最新信息。必须指定StreamNameStreamARN

请求语法

POST /describeStream HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" }

URI 请求参数

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

请求体

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

StreamARN

流的 Amazon 资源名称(ARN)。

类型:字符串

长度限制:长度下限为 1。长度上限为 1024。

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

必需:否

StreamName

流的名称。

类型:字符串

长度限制:最小长度为 1。最大长度为 256。

模式:[a-zA-Z0-9_.-]+

必需:否

响应语法

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

响应元素

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

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

StreamInfo

描述直播的对象。

类型:StreamInfo 对象

错误

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

ClientLimitExceededException

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

HTTP 状态代码:400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码:400

NotAuthorizedException

呼叫者无权执行此操作。

HTTP 状态代码:401

ResourceNotFoundException

亚马逊 Kinesis Video Streams 找不到你指定的直播。

HTTP 状态代码:404

另请参阅

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