# 查询桌面监控信息 - ShowDesktopMonitorData #### 功能介绍 该接口可获取某一计算机在一段时间段(范围：1小时到30天)的数据信息（例如CPU占用率、内存占用率、用户的在线时间段等），最长数据保存时间不能超过180天。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ShowDesktopMonitorData)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:desktops:getMonitor | Read | desktop \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | ces:metricData:get | #### URI GET /v2/{project_id}/desktop-monitor/{desktop_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | | desktop_id | 是 | String | 桌面ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 是 | String | 监控开始时间：由日期加时间组成，UTC格式，例如"2021-05-11T11:45:42Z"。 | | end_time | 是 | String | 监控结束时间：由日期加时间组成，UTC格式，例如"2021-05-11T11:45:42Z"。 | | metric_name | 否 | String | 监控查询指标：例如 "cpu_util"，详情见下表；当metric_name为空时，为批量查询\| 指标 \| 指标名称 \| 测量对象 \| 监控周期 \|\| ------------------------------------- \| ----------------- \| ------------ \| -------- \|\| cpu_util \| CPU使用率 \| 云桌面 \| 5分钟 \|\| mem_util \| 内存使用率 \| 云桌面 \| 5分钟 \|\| disk_util_inband \| 磁盘使用率 \| 云桌面 \| 5分钟 \|\| disk_read_bytes_rate \| 磁盘读带宽 \| 云桌面 \| 5分钟 \|\| disk_write_bytes_rate \| 磁盘写带宽 \| 云桌面 \| 5分钟 \|\| disk_read_requests_rate \| 磁盘读IOPS \| 云桌面 \| 5分钟 \|\| disk_write_requests_rate \| 磁盘写IOPS \| 云桌面 \| 5分钟 \|\| network_incoming_bytes_rate_inband \| 带内网络流入速率 \| 云桌面 \| 5分钟 \|\| network_outgoing_bytes_rate_inband \| 带内网络流出速率 \| 云桌面 \| 5分钟 \|\| network_incoming_bytes_aggregate_rate \| 带外网络流入速率 \| 云桌面 \| 5分钟 \|\| network_outgoing_bytes_aggregate_rate \| 带外网络流出速率 \| 云桌面 \| 5分钟 \|\| network_vm_connections \| 网络连接数 \| 云桌面 \| 5分钟 \|\| cpu_credit_usage \| CPU积分使用量 \| 云桌面 \| 5分钟 \|\| cpu_credit_balance \| CPU积分累积量 \| 云桌面 \| 5分钟 \|\| cpu_surplus_credit_balance \| CPU超额积分累积量 \| 云桌面 \| 5分钟 \|\| cpu_surplus_credit_charged \| CPU超额积分收费量 \| 云桌面 \| 5分钟 \|\| user_online_info \| 用户在线信息 \| 云桌面 \| - \| | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_online_info | Array of [MonitorUserOnlineInfo] objects | 在线信息。 | | online_status | Integer | 计算机登录状态，在线信息没值的情况下，查看计算机登录状态 0 未登录， 1 登录中, 2登录状态同当前。 | | cpu_info | Array of [Datapoints] objects | cpu使用率信息。 | | memory_info | Array of [Datapoints] objects | 内存使用率信息。 | | disk_util_inband | Array of [Datapoints] objects | 磁盘使用率。 | | disk_read_bytes_rate | Array of [Datapoints] objects | 磁盘读带宽。 | | disk_write_bytes_rate | Array of [Datapoints] objects | 磁盘写带宽。 | | disk_read_requests_rate | Array of [Datapoints] objects | 磁盘读IOPS。 | | disk_write_requests_rate | Array of [Datapoints] objects | 磁盘写IOPS。 | | network_incoming_bytes_rate_inband | Array of [Datapoints] objects | 带内网络流入速率。 | | network_outgoing_bytes_rate_inband | Array of [Datapoints] objects | 带内网络流出速率。 | | network_incoming_bytes_aggregate_rate | Array of [Datapoints] objects | 带外网络流入速率。 | | network_outgoing_bytes_aggregate_rate | Array of [Datapoints] objects | 带外网络流出速率。 | | network_vm_connections | Array of [Datapoints] objects | 网络连接数。 | 表4MonitorUserOnlineInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | | connection_setup_time | String | 建立连接时间。 | | connection_end_time | String | 结束连接时间。 | 表5Datapoints | 参数 | 参数类型 | 描述 | |:---|:---|:---| | average | Double | 平均数值。 | | timestamp | Long | 时间戳。 | **状态码：default** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 - ``` /v2/e3662787cb914315b85fd83aa53b93b1/desktop-monitor/a130ab3a-72bf-4b71-baa9-af4987c8e338?start_time=2021-10-11T06%3A56%3A56Z&end_time=2021-10-11T07%3A56%3A56Z ``` - ``` /v2/e3662787cb914315b85fd83aa53b93b1/desktop-monitor/a130ab3a-72bf-4b71-baa9-af4987c8e338?start_time=2021-10-11T06%3A56%3A56Z&end_time=2021-10-11T07%3A56%3A56Z&metric_name=cpu_util ``` #### 响应示例 **状态码：200** 导出桌面监控信息响应。 ``` { "cpu_info" : [ { "average" : 0.4832775919732441, "timestamp" : 1618810632000 }, { "average" : 0.4832775919732441, "timestamp" : 1618810931000 }, { "average" : 0.5018382352941176, "timestamp" : 1618811203000 }, { "average" : 0.4830508474576271, "timestamp" : 1618812396000 } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 导出桌面监控信息响应。 | | default | 默认错误响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。