# 查询直播播放在线人数
#### 功能介绍
查询加速的直播播放在线人数。
![](https://support.huaweicloud.com/api-live/public_sys-resources/note_3.0-zh-cn.png)
当前页面接口为历史版本API，仅供查询部署在旧版视频直播服务上的域名相关数据。此API未来可能停止维护，建议您使用[新版视频直播统计API](https://support.huaweicloud.com/api-live/ListUsersOfStream.html)。您也可以通过视频直播控制台使用新版直播统计功能，具体请参见[直播统计](https://support.huaweicloud.com/iLive-live/live_01_0062.html)。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=Live&api=ShowOnlineUsers)中调试该接口。
#### URI
GET /v1/{project_id}/stream/users
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 |
   
表2Query参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| 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 | 正在推流的音视频信息 |
   
 表5UserInfo 
| 参数        | 参数类型    | 描述                                    |
|:---|:---|:---|
| 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 | 查询直播播放在线人数失败 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。