阅读587 返回首页    go 阿里云

查询在线人数__直播流操作接口_API 手册_CDN-阿里云

描述

获取在线直播流的在线人数，支持实时查询和基于时间范围的查询。

基于实时查询在线人数的请求参数

参数 类型 必须? 描述
Action String 是 操作接口名，系统规定参数，取值：DescribeLiveStreamOnlineUserNum
DomainName String 是 您的加速域名
AppName String 否 直播流所属应用名称
StreamName String 否 直播流名称

基于时间范围的分钟粒度的查询在线人数的请求参数

参数 类型 必须? 描述
Action String 是 操作接口名，系统规定参数，取值：DescribeLiveStreamOnlineUserNum
DomainName String 是 您的加速域名
AppName String 是 直播流所属应用名称
StreamName String 是 直播流名称
StartTime String 是 起始时间，UTC格式，例如：2016-06-29T19:00:00Z
EndTime String 是 结束时间，UTC格式，例如：2016-06-30T19:05:00Z

返回参数

名称 类型 描述
TotalUserNumber Long 所有流的用户数总和
OnlineUserInfo LiveStreamOnlineUserNumInfo[] 每条直播流的用户数信息

数据类型

LiveStreamOnlineUserNumInfo

名称 类型 描述
StreamUrl String 直播流的URL
UserNumber Long 直播流的在线人数
Time String 统计时刻 UTC时间

特殊错误码

错误代码 描述 Http 状态码 语义
InternalError The request processing has failed due to some unknown error. 500 后台发生未知错误
InvalidDomain.NotFound The domain provided does not exist in our records. 404 当前账户下未查到域名
IllegalOperation Illegal domain operate is not permitted. 403 不支持当前操作，如：非直播类域名
MissingParameter The input parameter parameter name that is mandatory for processing this request is not supplied 400 缺少参数

示例

请求示例：

  1. https://cdn.aliyuncs.com?Action=DescribeLiveStreamOnlineUserNum&DomainName=test101.cdnpe.com&<公共请求参数>

返回示例

JSON格式：

  1. {
  2.     "OnlineUserInfo": {
  3.         "LiveStreamOnlineUserNumInfo": [
  4.             {
  5.                 "StreamUrl": "rtmp://test101.cdnpe.com/live/test101", 
  6.                 "UserNumber": 2,
  7.                 "Time": 2016-06-29T19:05:00Z
  8.             }, 
  9.             {
  10.                 "StreamUrl": "rtmp://test101.cdnpe.com/live/test102", 
  11.                 "UserNumber": 5,
  12.                 "Time": 2016-06-29T19:04:00Z
  13.             }
  14.         ]
  15.     }, 
  16.     "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8", 
  17.     "TotalUserNumber": 7
  18. }

XML格式：

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2.   <DescribeLiveStreamOnlineUserNumResponse>
  3.     <OnlineUserInfo>
  4.         <LiveStreamOnlineUserNumInfo>
  5.             <StreamUrl>rtmp://test101.cdnpe.com/live/test101</StreamUrl>
  6.             <UserNumber>2</UserNumber>
  7.             <Time>2016-06-29T19:05:00Z</Time>
  8.         </LiveStreamOnlineUserNumInfo>
  9.         <LiveStreamOnlineUserNumInfo>
  10.             <StreamUrl>rtmp://test101.cdnpe.com/live/test102</StreamUrl>
  11.             <UserNumber>5</UserNumber>
  12.             <Time>2016-06-29T19:04:00Z</Time>
  13.         </LiveStreamOnlineUserNumInfo>
  14.     </OnlineUserInfo>
  15.     <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  16.     <TotalUserNumber>7</TotalUserNumber>
  17.   </DescribeLiveStreamOnlineUserNumResponse>

最后更新：2016-11-23 17:16:03

  上一篇：go 查询流控历史__直播流操作接口_API 手册_CDN-阿里云
  下一篇：go 禁止直播流推送__直播流操作接口_API 手册_CDN-阿里云