直播TopN按流维度在线人数排名

最近更新时间:2021-04-10 09:41:54

查看PDF

GetLiveTopOnlineUserData

描述

本接口用于获取按域名维度统计流的直播在线人数排行

  • 只设置起始时间,代表起始时间这1分钟的数据。

  • 支持批量域名过滤查询,多个域名ID用逗号(半角)分隔

  • 最多可获取最近62天内的数据

  • 时效性:5-10分钟延迟

  • 接口性能:接口最大吞吐量为10000,即Region个数*DomainId下的流个数*(EndTime-StartTime) /统计粒度<= 10000。注:在获取多个区域合并值时,Region个数按照1计算

  • 只支持直播业务

  • 使用场景:

    • 客户查询一个单位时间(1分钟)内的TopN的直播流名,然后拿流名去调用“在线人数”的API来绘制单个流的曲线;
  • 说明:

    • 按流名维度的数据,返回时并不按照“域名”维度汇聚。如果需要按域名维度的数据,请按单个域名过滤。

请求语法 {#请求语法}

本接口请求需要包含指定目录 /2016-09-01/statistics/GetLiveTopOnlineUserData和公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名 必选 类型及范围 说明
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Regions String 区域名称,取值为CN:中国大陆,HK:中国香港,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲 ,支持多区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType Int 取值为0:多区域数据做合并;1:每个区域的数据分别返回。
LimitN Int Top条数,取值为1-10000,最大10000,默认100

返回参数

参数名 类型及范围 说明
StartTime String 开始时间
DomainIds String 域名ID列表,逗号(半角)间隔
Regions String 区域,逗号(半角)间隔
ResultType Int 0:多区域数据做合并返回;1:每个流名每个区域的数据分别返回
LimitN Int Top条数
Datas OnlineUserDataByStream[] 每个时间粒度的在线人数数据

OnlineUserDataByStream

参数名 类型及范围 说明
StreamUrl String 拉流URL;对于HLS格式,返回参数无后缀,即只返回http://domain/app/stream格式
OnlineUser Long 在线人数
Regions OnlineUserDataByByRegion[] 该域名在每个区域的详细数据(仅当ResultType取值为1时返回此数据)

OnlineUserDataByByRegion

参数 类型 描述
Region String 区域
OnlineUser Long 在线人数

示例

请求示例

POST方式:

POST  /2016-09-01/statistics/GetLiveTopOnlineUserData 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetLiveTopOnlineUserData
x-version: 2016-09-01
Content-Type: application/x-www-form-urlencoded

StartTime=2016-10-20T00:00+0800&ResultType=1&DomainIds=2D09SPW&Regions=CN&LimitN=100

返回示例

JSON格式:

{
  "StartTime": "2016-10-20T00:00+0800",
  "DomainIds": "2D09SPW",
  "Regions": "CN",
  "ResultType": 1,
  "LimitN": 100,
  "Datas": [
    {
      "StreamUrl": "http://test.ks-cdn.com/live/m_2d720db628d9e0321473268364621100.flv",
      "OnlineUser": 12,
      "Regions": [
        {
          "Region": "CN",
          "OnlineUser": 12
        }
      ]
    },
    {
      "StreamUrl": "http://test.ks-cdn.com/live/m_02370dbc72253cb51473083146466100.flv",
      "OnlineUser": 1,
      "Regions": [
        {
          "Region": "CN",
          "OnlineUser": 1
        }
      ]
    },
    {
      "StreamUrl": "http://test.ks-cdn.com/live/m_3d7206bc6085e1621471541327267100.flv",
      "OnlineUser": 1,
      "Regions": [
        {
          "Region": "CN",
          "OnlineUser": 1
        }
      ]
    },
    {
      "StreamUrl": "http://test.ks-cdn.com/live/m_bb8ccf86c5aa995d1471262600384100.flv",
      "OnlineUser": 1,
      "Regions": [
        {
          "Region": "CN",
          "OnlineUser": 1
        }
      ]
    },
    {
      "StreamUrl": "http://test.ks-cdn.com/live/m_bdbde132a294b5c51468166116193100.flv",
      "OnlineUser": 1,
      "Regions": [
        {
          "Region": "CN",
          "OnlineUser": 1
        }
      ]
    },
    {
      "StreamUrl": "http://test.ks-cdn.com/live/m_f72c81748e04ca2e1472148599628100.flv",
      "OnlineUser": 1,
      "Regions": [
        {
          "Region": "CN",
          "OnlineUser": 1
        }
      ]
    }
  ]
}

错误码

下方为接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误代码(Code) 错误消息(Message) HTTP 状态码 中文描述(语义)
InvalidStartTime.Malformed Specified start time is malformed.StartTime:%s 400 StartTime格式错误
NoDataProvided We do not provide data more than 1 year. 400 所查询的时间范围超过限制
InvalidEndTime.Mismatch Specified end time should not be earlier than start time.StartTime:%s, EndTime:%s 400 EndTime不应早于StartTime
InvalidTime Start time with the time difference is not more than 62 days. 400 不支持查询62天前的数据
InvalidRegion Invalid region.Expected:AF/AS/AU/CN/EU/NA/SA/HK/TW, but receive:%s 400 无效的区域名称
InvalidResultType Invalid result type.Expected:0/1, but receive:%s 400 无效的数据类型,应该为0/1
LimitNNumberOutOfRange Page number is out of range Expected:Between 1 and 10000, but receive:%s 400 limit超限
NoAvailableDomain No valid domain name was found according to the query criteria. 400 在当前查询条件下没发现目标域名
InvalidDomain.NotFound The domain provided does not belong to you or does not match the cdntype.Invalid domains:%s 400 直播业务不存在此域名
InvalidDomain.Offline The domain provided is offline.Offline domains:%s 400 所查询的域名已经停用
DomainCdnTypeNotMatch Domains and cdn type did not match.Invalid domains:%s 400 域名和域名类型不匹配
AccessDenied Access Denied.You are not authorized to perform:DomainIds:%s 403 权限不够,访问被拒绝

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

  • 内容不全,不深入
  • 内容更新不及时
  • 描述不清晰,比较混乱
  • 系统或功能太复杂,缺乏足够的引导
  • 内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈