调用DescribeLiveStreamState实时查询单路流状态。

使用说明

先获取直播域名，再调用本接口实时查询单路流状态。关于不在线状态（offline）的详细信息，请根据推流回调返回的数据获取，本接口不做细分。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeLiveStreamState

系统规定参数。取值：DescribeLiveStreamState。

AppName String 是 liveApp****

直播流所属应用名称。
DomainName String 是 demo.aliyundoc.com

直播推流域名或播流域名。
StreamName String 是 liveStream****

直播流名称。
RegionId String 否 cn-shanghai

域名所属地域。

返回数据

名称 类型 示例值 描述
RequestId String CE6CD79D-0A98-1F22-A15F-FADA74DF2729

请求ID。
StreamState String online

流状态。取值：

  • online：推流中，表示正常推流中。
  • offline：不在线（推流失败或者推流结束，具体状态根据推流回调返回，此API不细分）。
  • forbidden：已禁推。
Type String push

推流接入的类型。取值：

  • push：直播推流。
  • pull：触发拉流。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamState
&AppName=liveApp****
&DomainName=demo.aliyundoc.com
&StreamName=liveStream****
&<公共请求参数>

正常返回示例

XML格式 

<DescribeLiveStreamStateResponse>
  <StreamState>online</StreamState>
  <Type>push</Type>
  <RequestId>CE6CD79D-0A98-1F22-A15F-FADA74DF2729</RequestId>
</DescribeLiveStreamStateResponse>

JSON格式 

{
    "DescribeLiveStreamStateResponse": {
        "StreamState": "online",
        "Type": "push",
        "RequestId": "CE6CD79D-0A98-1F22-A15F-FADA74DF2729"
    }
}

错误码

访问错误中心查看更多错误码。