}
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。
5.2 指标管理
5.2.1 查询指标列表
功能介绍
查询系统当前可监控指标列表，可以指定指标命名空间、指标名称、维度、排序方 式，起始记录和最大记录条数过滤查询结果。
调试
您可以在API Explorer中调试该接口。
URI
GET /V1.0/{project_id}/metrics
● 参数说明
表5-8 参数说明
名称 是否必选 说明
project_id 是 项目ID。
获取方式请参见获取项目ID。
表5-9 查询检索参数说明
名称 是否必
选
参数类 型
说明
namespace 否 String 查询服务的命名空间，各服务命名空间请参考 支持监控的服务列表。
格式为service.item；service和item必须是字 符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为 32。
metric_na
me 否 String 指标ID，例如弹性云服务器的监控指标CPU使 用率，对应的metric_name为cpu_util。各服 务监控指标请参考支持监控的服务列表。
dim 否 String 监控维度，例如弹性云服务器的维度为 instance_id。各服务维度请参考支持监控的服 务列表。
目前最大支持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 start 否 String 分页起始值，格式为：
namespace.metric_name.key:value
例如：start=SYS.ECS.cpu_util.instance_id:d9112af5 -6913-4f3b-bd0a-3f96711e004d
limit 否 Intege
r 取值范围(0,1000]，默认值为1000。
用于限制结果数据条数。
order 否 String 用于标识结果排序方法，按时间戳排序。
取值说明，默认为desc：
● asc，升序
● desc，降序
● 请求样例
请求样例一：查询当前可监控所有指标列表。
GET https://{云监控的终端节点}/V1.0/{project_id}/metrics
请求样例二：查询弹性云服务器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
请求消息
无
响应消息
● 响应参数
表5-10 响应参数
名称 参数类型 说明
metrics Array of
objects 指标对象列表。
详细参数请参见表5-11。
meta_data Object 查询结果元数据信息，包括分页信息等。
详细参数请参见表5-13。
表5-11 metrics 字段数据结构说明
名称 参数类型 说明
namespace String 指标所属命名空间。
dimensions Array of
objects 指标维度列表。
详细参数请参见表5-12。
metric_name String 指标名称，如cpu_util。
unit String 指标单位。
表5-12 dimensions 字段数据结构说明
名称 参数类型 说明
name String 监控维度名称，例如弹性云服务器的维度为 instance_id。各服务维度请参考支持监控的服 务列表，可参考维度中key字段。
value String 维度取值，例如弹性云服务器的ID。
长度最短为1，最大为256。
表5-13 meta_data 字段数据结构说明
名称 参数类型 说明
count Integer 当前返回结果条数。
marker String 下一个开始的标记，用于分页。
如本次查询10条数据，第十条为cpu_util，下 次start配置为cpu_util可从该指标开始查询。
total Integer 指标总条数。
● 响应样例
{ "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
} }
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。