最近更新时间:2023.09.25 21:09:57
首次发布时间:2022.02.09 20:37:39
调用接口查询指定流的当前推流状态。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询流状态接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveStreamState | 接口名称。当前 API 的名称为 DescribeLiveStreamState 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
Vhost | String | 否 |
| 域名空间名称 说明
|
Domain | String | 否 |
| 推流域名。 说明
|
App | String | 是 | live | 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成 |
Stream | String | 是 | stream001 | 流名称。由 1 到 100 位数字、字母、下划线及"-"和"."组成,如果指定 Stream,必须同时指定 App 的值 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
stream_state | String |
| 直播流状态。
|
type | String |
| 直播流类型。
|
GET http://live.volcengineapi.com/?Action=DescribeLiveStreamState&Version=2020-08-01&Vhost=push.example.com&App=live&Stream=stream001
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeLiveStreamState", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "stream_state": "offline", "type": "push" } }
访问公共错误码获取详细信息。