DescribeLiveStreamHistoryUserNum - 查询直播流历史在线人数

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

接口说明

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

  • 该接口仅支持查询 FLV 和 RTMP 流的历史在线人数。

  • 该接口不支持查询转码流的播放人数。

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveStreamHistoryUserNumget
*全部资源
*

请求参数

名称类型必填描述示例值
DomainNamestring

播流域名。

example.com
AppNamestring

直播流所属应用名称。您可在流管理页面查看 AppName。

liveApp****
StreamNamestring

直播流名。您可在流管理页面查看 StreamName。

liveStream****
StartTimestring

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

说明 支持最大的查询范围是最近 30 天。
2017-12-21T08:00:00Z
EndTimestring

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F5FF8
LiveStreamUserNumInfosarray<object>

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

LiveStreamUserNumInfoobject
UserNumstring

当前时间点人数。

1
StreamTimestring

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

2017-10-20T06:20:00Z

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedSpecified StartTime is malformed.StartTime参数错误,请您确认该StartTime参数是否正确。
400InvalidEndTime.MalformedSpecified EndTime is malformed.结束时间错误,请您确认结束时间是否正确。
400InvalidEndTime.MismatchSpecified end time does not math the specified start time or current time.-

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