查询指标列表
功能介绍
查询系统当前可监控指标列表，可以指定指标命名空间、指标名称、维度、排序方式，起始记录和最大记录条数过滤查询结果。
云服务资源删除后，会保留3个小时的数据缓存，在3小时之内还能查到资源对应的监控指标，属于正常现象。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /V1.0/{project_id}/metrics
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。
约束限制：
不涉及。
取值范围：
字符串长度在1 ~64 之间。
默认取值：
不涉及。
表2 查询检索参数说明 名称
是否必选
参数类型
说明
namespace
否
String
参数解释：
服务指标命名空间。各服务命名空间请参考支持监控的服务列表。
约束限制：
不涉及
取值范围：
格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，其中service不能为“SYS”、“AGT”和“SRE”，namespace不能为SERVICE.BMS，因为此namespace已被系统使用。总长度最短为3，最大为32。如：弹性云服务器的命名空间为SYS.ECS，文档数据库的命名空间为SYS.DDS。
默认取值：
不涉及。
metric_name
否
String
参数解释：
指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。各服务监控指标请参考支持监控的服务列表。
约束限制：
不涉及。
取值范围：
必须以字母开头，只能包含0-9/a-z/A-Z/_/-；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。字符长度最短为1，最大为96。
默认取值：
不涉及。
dim
否
String
参数解释：
指标的维度。若指标的维度存在层级关系，需要使用多层级维度方式进行查询。
约束限制：
目前最大支持4个层级维度，维度编号从0开始，编号3为最深层级。
取值范围：
维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。
CloudTable仅支持多层级维度查询。
以下维度说明仅为示例，具体是否支持多维度请参见各服务中监控指标说明中的维度说明。
- 单层级维度：如弹性云服务器的CPU使用率（cpu_util），其维度为instance_id，且instance_id为0层，维度信息代入方式如下：
- 多层级维度：如弹性云服务器的(Agent) 磁盘读速率（disk_agt_read_bytes_rate）维度为disk，disk上层维度为instance_id。instance_id为0层，disk为1层，其维度信息代入方式如下：
默认取值：
不涉及。
start
否
String
参数解释：
分页起始值。
约束限制：
不涉及。
取值范围：
格式为：namespace.metric_name.key:value
例如：start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d
默认取值：
不涉及。
limit
否
Integer
参数解释：
单次查询的条数限制，用于限制结果数据条数。
约束限制：
不涉及。
取值范围：
[1, 1000]
默认取值：
1000
order
否
String
参数解释：
用于标识结果排序方法，按时间戳排序。
约束限制：
不涉及。
取值范围：
只能是asc或者desc。
- asc为升序
- desc为降序
默认取值：
asc
- 请求样例
请求样例二：查询弹性云服务器ID为6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d的监控指标CPU使用率，结果按时间戳降序保留10条数据。
GET https://{云监控的终端节点}/V1.0/{project_id}/metrics?namespace=SYS.ECS&metric_name=cpu_util&dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d&limit=10&order=desc
请求消息
无
响应消息
- 响应参数
表3 响应参数 名称
参数类型
说明
metrics
Array of objects
参数解释：
指标对象列表。
详细参数请参见表4。
meta_data
Object
参数解释：
查询结果元数据信息，包括分页信息等。
详细参数请参见表6。
表4 metrics字段数据结构说明 名称
参数类型
说明
namespace
String
参数解释：
指标所属命名空间。
取值范围：
不涉及。
dimensions
Array of objects
参数解释：
指标维度列表。
详细参数请参见表5。
metric_name
String
参数解释：
指标名称，如cpu_util。
取值范围：
不涉及。
unit
String
参数解释：
指标单位。
取值范围：
不涉及。
表5 dimensions字段数据结构说明 名称
参数类型
说明
name
String
参数解释：
监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。
取值范围：
不涉及。
value
String
参数解释：
维度取值，例如弹性云服务器的ID。
取值范围：
不涉及。
- 响应样例
{ "metrics": [ { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "d9112af5-6913-4f3b-bd0a-3f96711e004d" } ], "metric_name": "cpu_util", "unit": "%" } ], "meta_data": { "count": 1, "marker": "SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d", "total": 7 } }
返回值
错误码
请参考返回错误码说明。
