You need to enable JavaScript to run this app.
文档中心
视频直播

视频直播

请输入
  • 文档首页
    • 视频直播API 参考流管理DescribeLiveStreamState - 查询流状态
复制全文
下载 pdf
我的收藏
流管理
DescribeLiveStreamState - 查询流状态
复制全文
下载 pdf
我的收藏
DescribeLiveStreamState - 查询流状态

调用 DescribeLiveStreamState 接口，查询直播流类型和状态。

使用说明

流状态不同，支持查询的范围也不同。

  • 在线流（stream_state 为 online）：支持查询当前在线的直推流或回源流。
  • 历史流（stream_state 为 offline）：仅支持查询近 7 天内的历史直推流或回源流。
  • 禁推流（stream_state 为 forbidden）：支持查询当前处于禁推有效期内的直推流。禁推有效期可通过 ForbidStream - 禁推直播流 接口的 EndTime 参数自定义，最长为 90 天。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Vhost

String

否

push.example.com

域名空间，即直播流地址的域名（Domain）所属的域名空间（Vhost）。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的直播流使用的域名所属的域名空间。

说明

Vhost 和 Domain 传且仅传一个。

Domain

String

否

push.example.com

填写直播流使用的域名，默认为空，表示查询所有直推流和回源流的状态和类型。 您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的直播流使用的域名。

说明

Vhost 和 Domain 传且仅传一个。

AppString是live应用名称，取值与直播流地址的 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
StreamString是example_stream流名称，取值与直播流地址的 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。

返回参数

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

参数类型示例值描述

stream_state

String

online

直播流状态。取值如下：

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

type

String

push

直播流类型。取值如下：

  • push：直推流，即推流端主动向视频直播推送的直播流。
  • pull：回源流，即视频直播从自有源站或第三方源站拉取并提供播放的直播流。

请求示例 

GET https://live.volcengineapi.com?Action=DescribeLiveStreamState&Version=2023-01-01&Vhost=push.example.com&App=live&Stream=example_stream

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeLiveStreamState",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "stream_state": "offline",
        "type": "push"
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowedthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.VhostOrDomainan internal error related to vhost or domain occurred, please contact the administrator.出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。
500InternalError.Streaman internal error related to stream occurred, please contact the administrator.出现与流相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

最近更新时间：2026.09.23 16:06:01
这个页面对您有帮助吗？
有用
有用
无用
无用