# 查询桌面使用情况统计数据 - ListDesktopUsageMetric #### 功能介绍 查询桌面使用统计信息; 云服务每天凌晨02:00进行聚合运算前一天00:00:00\~23:59:59的使用时长,并将周期范围内的数据聚合到周期边界上 跨天的记录会按照统计周期进行计算 假设一天内桌面登录多次，09:00\~12:00,13:00\~21:00,22:00\~01:00(次日): 则当天的累计使用时长数据会被汇聚到23:59:59这个点;总使用时长为 3hours(09:00\~12:00)+8hours(13:00\~21:00)+2hours(22:00\~00:00) 仅能查询最近180天已进行汇聚计算的数据 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListDesktopUsageMetric)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:statistics:listDesktopMetrics | List | - | - | - | - | #### URI GET /v2/{project_id}/statistics/metrics/desktops 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 是 | String | 查询起始时间(0时区) 云服务每天凌晨02:00进行聚合运算前一天00:00:00\~23:59:59的使用时长,并将周期范围内的数据聚合到周期边界上 跨天的记录会按照统计周期进行计算 假设一天内桌面登录多次，09:00\~12:00,13:00\~21:00,22:00\~01:00(次日): 则当天的累计使用时长数据会被汇聚到23:59:59这个点;总使用时长为 3hours(09:00\~12:00)+8hours(13:00\~21:00)+2hours(22:00\~00:00) 如果查询的from-to不足一个周期内，可能造成查询到数据为空； | | end_time | 是 | String | 查询截止时间(0时区)。 | | resource_name | 否 | String | 资源名称(模糊匹配)。 | | resource_id | 否 | String | 资源ID(精确匹配)。 | | min_idle_days | 否 | Integer | 最小空闲天数。 | | max_idle_days | 否 | Integer | 最大空闲天数 min_idle_days、max_idle_days都非空时,max_idle_days必须大于等于min_idle_days否则可能查询不到数据 | | usage_min_hours | 否 | Integer | 使用时长(hour)最小值。 | | usage_max_hours | 否 | Integer | 使用时长(hour)最大值(必须大于等于usage_min_hours)。 | | enterprise_project_id | 否 | String | 企业项目ID。 | | sort_field | 否 | String | 按照指标进行排序 - *desktop_usage* - 按照桌面使用时长排序 - *desktop_idle_duration* - 按照桌面空闲周期排序 | | sort_type | 否 | String | 按照指标进行排序的方向;需配合sort_field一起使用 - *DESC* - 降序返回数据 - *ASC* - 升序返回数据 | | offset | 否 | Integer | 查询的偏移量,默认值0。 | | limit | 否 | Integer | limit范围\[1-100\],默认值0。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 总数。 | | items | Array of [DesktopMetric] objects | 桌面统计指标。 | 表4DesktopMetric | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_id | String | 桌面ID。 | | resource_pool_id | String | 桌面池ID(仅桌面池中的桌面存在该字段)。 | | resource_pool_name | String | 桌面池名称(仅桌面池中的桌面存在该字段)。 | | resource_name | String | 桌面名称。 | | enterprise_project_id | String | 企业项目ID。 | | machine_sid | String | 虚机sid | | latest_connect_username | String | 最近一个登录的用户 | | metric | Array of [Metric] objects | 统计信息 - *desktop_usage* - 桌面使用时长(单位:秒) - *desktop_idle_duration* - 桌面空闲时长(单位:秒) | 表5Metric | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric_name | String | 指标名称。 | | metric_value | Double | 指标值。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 无 #### 响应示例 **状态码：200** 响应成功。 ``` { "count" : 0, "items" : [ { "resource_id" : "xxx-xxx-xxx", "resource_pool_id" : "xxx-xxx-xxx", "resource_name" : "xxxx", "metric" : [ { "metric_name" : "desktop_state", "metric_value" : 10 } ] } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 响应成功。 | | 400 | 客户端请求有误。 | | 401 | 鉴权失败。 | | 500 | 内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。