You need to enable JavaScript to run this app.
导航

查询流状态

最近更新时间2023.10.12 17:39:57

首次发布时间2022.02.09 20:37:39

调用接口查询指定流的当前推流状态。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询流状态接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:GET
  • 请求地址:https://live.volcengineapi.com?Action=DescribeLiveStreamState&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringDescribeLiveStreamState接口名称。当前 API 的名称为 DescribeLiveStreamState
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Vhost

String

push.example.com

域名空间名称

说明

VhostDomain 传且仅传一个。

Domain

String

push.example.com

推流域名。

说明

VhostDomain 传且仅传一个。

AppStringlive应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamStringstream001流名称。由 1 到 100 位数字、字母、下划线及"-"和"."组成,如果指定 Stream,必须同时指定 App 的值

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述

stream_state

String

online

直播流状态。

  • online:在线流;
  • offline:历史流;
  • forbidden:禁推流。

type

String

push

直播流类型。

  • push:直推直拉;
  • pull:回源拉流。

示例

请求示例

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"
  }
}

错误码

访问公共错误码获取详细信息。