
# 桌面统计 - ListDesktopsStatistics
#### 功能介绍
统计租户下的普通桌面、桌面池状态，默认仅统计总数。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListDesktopsStatistics)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                    | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:statistics:listDesktopStatus | List | -           | -   | -  | -      |
     
  
 
#### URI
GET /v2/{project_id}/statistics
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
表2Query参数 
| 参数               | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| desktop_type     | 否    | Array of strings | 桌面类型，为空时查所有桌面。 - DEDICATED：普通桌面，包括专享桌面、专属桌面等   - POOLED：池桌面，即桌面池里的桌面    |
| statistics_type  | 否    | Array of strings | 统计类型，为空时仅统计桌面总数 \|- - attach-state 按照分配状态统计 - login-state 按照登录状态统计 - run-state 按照运行状态统计。                                                                                                                                                                                                                                                                                                                                                                    |
| desktop_pool_ids | 否    | Array of strings | 待查询的桌面池ID列表                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数                      | 参数类型                                                                                              | 描述                                  |
|:---|:---|:---|
| total_num               | Integer                                                                                           | 桌面总数。                               |
| attach_statistics       | [AttachStatistics] object                     | 分配情况统计。                             |
| run_state_statistics    | [DesktopRunStatisticsRsp] object       | 运行情况统计。                             |
| login_state_statistics  | [DesktopLoginStatisticsRsp] object   | 登录情况统计。                             |
| desktop_pool_statistics | Array of [DesktopPoolStatistics] objects | 每个桌面池的情况统计，当desktop_type指定为POOL时返回。 |
   
 表4DesktopPoolStatistics 
| 参数                     | 参数类型                                                                                            | 描述      |
|:---|:---|:---|
| desktop_pool_id        | String                                                                                          | 桌面池id。  |
| desktop_pool_name      | String                                                                                          | 桌面池名称。  |
| total_num              | Integer                                                                                         | 桌面总数。   |
| attach_statistics      | [AttachStatistics] object                   | 分配情况统计。 |
| run_state_statistics   | [DesktopRunStatisticsRsp] object     | 运行情况统计。 |
| login_state_statistics | [DesktopLoginStatisticsRsp] object | 登录情况统计。 |
   
 表5AttachStatistics 
| 参数               | 参数类型    | 描述       |
|:---|:---|:---|
| attached_num     | Integer | 已分配个数。   |
| unattached_num   | Integer | 未分配个数。   |
| attaching_num    | Integer | 分配中个数。   |
| attach_error_num | Integer | 分配失败的个数。 |
   
 表6DesktopRunStatisticsRsp 
| 参数             | 参数类型    | 描述     |
|:---|:---|:---|
| stop_num       | Integer | 已关机个数。 |
| active_num     | Integer | 运行中个数。 |
| error_num      | Integer | 故障个数。  |
| hibernated_num | Integer | 已休眠个数。 |
   
 表7DesktopLoginStatisticsRsp 
| 参数                    | 参数类型    | 描述      |
|:---|:---|:---|
| in_use_num            | Integer | 使用中个数。  |
| unregistered_num      | Integer | 未注册个数。  |
| unable_to_connect_num | Integer | 无法连接个数。 |
| ready_num             | Integer | 就绪个数。   |
| disconnected_num      | Integer | 断开连接个数。 |
   
**状态码：default**
表8响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
#### 请求示例
```
GET /v2/9565be6e740941c493b38a1f46ecae6f/statistics
```
#### 响应示例
**状态码：200**
状态统计响应。
```
{
  "total_num" : 1
}
```
#### 状态码
| 状态码     | 描述      |
|:---|:---|
| 200     | 状态统计响应。 |
| default | 错误响应。   |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。
