调用DescribeLiveDomainOnlineUserNum查询域名下所有流的在线人数信息。

使用说明

本接口目前只支持FLV、RTS和RTMP播放在线人数统计,暂不支持HLS播放在线人数统计。 数据采集和统计有一定延迟,建议您查询5分钟前的数据。

说明 请使用本接口替换原有的DescribeLiveStreamOnlineUserNum(已废弃)接口。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:DescribeLiveDomainOnlineUserNum

DomainName String example.com

主播流域名。

QueryTime String 2018-12-27T13:09:21Z

查询的时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

返回数据

名称 类型 示例值 描述
RequestId String 3A3A8C3D-F8B2-4FBF-9319-771A11B855FA

请求ID。

UserCount Integer 1

查询时间下域名的所有在线人数。

StreamCount Integer 1

流数。

OnlineUserInfo Array of LiveStreamOnlineUserNumInfo

流的信息。

LiveStreamOnlineUserNumInfo
StreamName String rtmp://example.com/test/liveStream****_3_1

流名称。

Infos Array of Info

流统计信息。

Info
UserNumber Long 1

转码流或原始流的人数

TranscodeTemplate String origin

转码模板。origin为原始流。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainOnlineUserNum
&DomainName=example.com
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveDomainOnlineUserNumResponse>
<StreamCount>1</StreamCount>
<OnlineUserInfo>
    <LiveStreamOnlineUserNumInfo>
        <StreamName>rtmp://example.com/test/liveStream****_3_1</StreamName>
        <Infos>
            <Info>
                <TranscodeTemplate>origin</TranscodeTemplate>
                <UserNumber>1</UserNumber>
            </Info>
        </Infos>
    </LiveStreamOnlineUserNumInfo>
</OnlineUserInfo>
<RequestId>3A3A8C3D-F8B2-4FBF-9319-771A11B855FA</RequestId>
<UserCount>1</UserCount>
</DescribeLiveDomainOnlineUserNumResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeLiveDomainOnlineUserNumResponse" : {
    "StreamCount" : 1,
    "OnlineUserInfo" : {
      "LiveStreamOnlineUserNumInfo" : {
        "StreamName" : "rtmp://example.com/test/liveStream****_3_1",
        "Infos" : {
          "Info" : {
            "TranscodeTemplate" : "origin",
            "UserNumber" : 1
          }
        }
      }
    },
    "RequestId" : "3A3A8C3D-F8B2-4FBF-9319-771A11B855FA",
    "UserCount" : 1
  }
}

错误码

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