
# 查询实时规模分布 - ListRtcRealtimeScaleDimension
#### 功能介绍
对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudRTC/doc?api=ListRtcRealtimeScaleDimension)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rtc/rtc_07_0022.html)。
#### URI
GET /v1/{project_id}/rtc/realtime/scale/dimension
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                              |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-rtc/rtc_07_0015.html)。 |
   
表2Query参数 
| 参数        | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| app       | 是    | String | 应用标识                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| room_id   | 否    | String | 房间ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| metric    | 是    | String | 查询的数据类型 OnlineUsers:在线用户数                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| dimension | 是    | String | 维度类型: - region：省份   - access_net：网络类型   - platform：系统平台   - sdk：SDK版本    |
| time      | 是    | String | 查询时刻。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
   
#### 请求参数
表3请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                        |
|:---|:---|:---|:---|
| X-Auth-Token  | 否    | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
| Authorization | 否    | String | 使用AK/SK方式认证时必选，携带的鉴权信息。                                                                                                   |
| X-Sdk-Date    | 否    | String | 使用AK/SK方式认证时必选，请求的发生时间。                                                                                                   |
| X-Project-Id  | 否    | String | 使用AK/SK方式认证时必选，携带项目ID信息，与路径参数中的项目ID相同。                                                                                    |
   
#### 响应参数
**状态码：200**
表4响应Header参数 
| 参数           | 参数类型   | 描述      |
|:---|:---|:---|
| X-Request-Id | String | 请求的唯一标识 |
   
表5响应Body参数 
| 参数         | 参数类型                                                                                                                 | 描述     |
|:---|:---|:---|
| dimensions | Array of [RealtimeScaleDimensionValue] objects | 维度分布信息 |
   
 表6RealtimeScaleDimensionValue 
| 参数           | 参数类型   | 描述                          |
|:---|:---|:---|
| dimension    | String | 维度值，如查询维度为region，则此处取值可能为GD |
| online_users | Long   | 在线观众数                       |
   
**状态码：400**
表7响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误描述。 |
   
#### 请求示例
```
GET /v1/{project_id}/rtc/realtime/scale/dimension?app=5fa682b34a974f7ad24d223b
```
#### 响应示例
**状态码：200**
查询成功返回。
```
{
  "dimensions" : [ {
    "dimension" : "GD",
    "online_users" : 10
  } ]
}
```
**状态码：400**
查询失败返回
```
{
  "error_code" : "DATA.100011001",
  "error_msg" : "Required String parameter 'app' is not present"
}
```
#### 状态码
| 状态码 | 描述      |
|:---|:---|
| 200 | 查询成功返回。 |
| 400 | 查询失败返回  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rtc/ErrorCode.html)。
