调用DescribeLiveStreamHistoryUserNum查询直播流历史在线人数。

使用说明

调用本接口查询直播流历史在线人数,整体数据延时2~5分钟。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:DescribeLiveStreamHistoryUserNum

AppName String liveApp****

直播流所属应用名称。

DomainName String example.com

播流域名。

EndTime String 2017-12-22T08:00:00Z

结束时间。需晚于开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明 StartTime和EndTime时间间隔在一天内,且EndTime不超过当前时间。
StartTime String 2017-12-21T08:00:00Z

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明 支持最大的查询范围是最近30天。
StreamName String liveStream****

直播流名。

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F5FF8

请求ID。

LiveStreamUserNumInfos Array of LiveStreamUserNumInfo

直播流历史在线人数信息。

LiveStreamUserNumInfo
UserNum String 1

人数。

StreamTime String 2017-10-20T06:20:00Z

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

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamHistoryUserNum
&AppName=liveApp****
&DomainName=example.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&StreamName=liveStream****
&<公共请求参数>

正常返回示例

XML格式

<DescribeLiveStreamHistoryUserNumResponse>
  <LiveStreamUserNumInfos>
        <LiveStreamUserNumInfo>
              <StreamTime>2017-10-20T06:20:00Z</StreamTime>
              <UserNum>1</UserNum>
        </LiveStreamUserNumInfo>
  </LiveStreamUserNumInfos>
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F5FF8</RequestId>
</DescribeLiveStreamHistoryUserNumResponse>

JSON格式

{
    "DescribeLiveStreamHistoryUserNumResponse": {
        "LiveStreamUserNumInfos": {
            "LiveStreamUserNumInfo": {
                "StreamTime": "2017-10-20T06:20:00Z",
                "UserNum": 1
            }
        },
        "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F5FF8"
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidStartTime.Malformed Specified StartTime is malformed. StartTime参数错误,请您确认该StartTime参数是否正确。
400 InvalidEndTime.Malformed Specified EndTime is malformed. 结束时间错误,请您确认结束时间是否正确。

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