文档首页> 视频直播 Live> API参考> 历史API> 流管理> 查询直播播放在线人数
更新时间:2022-04-11 GMT+08:00
分享

查询直播播放在线人数

功能介绍

当前页面接口为历史版本API,仅供查询部署在旧版视频直播服务上的域名相关数据。如何查询域名是新版还是旧版?此API未来可能停止维护,建议您使用新版视频直播统计API。您也可以通过视频直播控制台使用新版直播统计功能,具体请参见直播统计

查询加速的直播播放在线人数

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/stream/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

domain

String

直播播放域名

app_name

String

应用名称

stream_name

String

流名称

start_time

String

查询开始时间,UTC时间,格式:yyyy-mm-ddThh:mm:ssZ。

  • 无开始时间表示查询最近统计周期在线人数数据
  • 只能查询最近90天内的数据

end_time

String

查询结束时间,UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

  • start_time与end_time均不存在时,服务端从最近一个统计周期的数据里查询。
  • start_time存在、end_time不存在时,end_time取当前时间。
  • start_time不存在、end_time存在时,请求非法。
  • 只能查询最近90天内的数据,start_time和end_time的跨度不能大于30天。

step

Integer

统计周期。 单位:分钟, 最大为30天,且小于查询开始时间与结束时间的差值

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

查询结果的总元素数量

user_info

Array of UserInfo objects

正在推流的音视频信息

表5 UserInfo

参数

参数类型

描述

user_num

Integer

直播流的在线人数

timestamp

String

操作执行的时间,UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/{project_id}/stream/users?domain=play.example.huawei.com&app_name=live&stream_name=xxx

响应示例

状态码: 200

查询直播播放在线人数成功

{
  "total" : 1,
  "user_info" : [ {
    "user_num" : 1024,
    "timestamp" : "2018-05-19T21:10:15Z"
  } ]
}

状态码: 400

查询直播播放在线人数失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

状态码

状态码

描述

200

查询直播播放在线人数成功

400

查询直播播放在线人数失败

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读