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

查询流状态

最近更新时间2023.11.13 19:57:29

首次发布时间2023.09.25 14:34:03

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeLiveStreamState接口名称。当前 API 的名称为 DescribeLiveStreamState
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-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 https://live.volcengineapi.com?Action=DescribeLiveStreamState&Version=2023-01-01&Domain=push.example.com&App=live&Stream=stream001

返回示例

{
  "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.AccountIDNotAllowthis 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.内部服务超时,请联系技术支持