文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 报表统计/ 查询指标
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

查询指标

功能介绍

查询指标

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/statistics/metrics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

start_time

是

String

开始时间, UTC时间

end_time

是

String

结束时间,UTC时间

dim

否

String

指标维度 |

目前最大支持3个维度，必须从0开始；维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。

单维度：dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d

多维度：dim.0=key,value&dim.1=key,value

metric_names

是

Array of strings

指标名称列表，支持的指标名称参考Workspace运维监控指标。

period

否

String

数据周期 |

DAY - 天级数据

HOUR - 小时级数据

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of Metric objects

查询指标响应体
表5 Metric

参数

参数类型

描述

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

响应成功

400

客户端请求有误

401

鉴权失败

500

内部错误

错误码

请参见错误码。

父主题： 报表统计

相关文档