4.1 监控
4.1.1 查询时间序列
功能介绍
该接口用于查询系统当前可监控的时间序列列表，可以指定时间序列命名空间、名 称、维度、所属资源的编号（格式为：resType_resId），分页查询的起始位置和返回 的最大记录条数。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/series
表4-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户从IAM申请到的projectid，
一般为32位字符串。
表4-2 Query 参数
参数 是否必选 参数类型 描述
limit 否 String 用于限制本次返回的结果数据条
数。 取值范围(0,1000]，默认 值为1000。
参数 是否必选 参数类型 描述
offset 否 String 分页查询起始位置，为非负整
数。
请求参数
表4-3 请求 Body 参数
参数 是否必选 参数类型 描述
series 是 Array of QuerySeries OptionParam objects
通过该数组传递的参数信息进行 时间序列查询。
表4-4 QuerySeriesOptionParam
参数 是否必选 参数类型 描述
namespace 是 String 时间序列命名空间。 取值范 围：PAAS.CONTAINER、
PAAS.NODE、PAAS.SLA、
PAAS.AGGR、
CUSTOMMETRICS等。
PAAS.CONTAINER：应用时间 序列命名空间； PAAS.NODE：
节点时间序列命名空间；
PAAS.SLA：SLA时间序列命名空 间； PAAS.AGGR：集群时间序 列命名空间；
CUSTOMMETRICS：自定义时 间序列命名空间。
metric_name 否 String 时间序列名称，名称长度取值范 围为1~255个字符。 取值范 围： AOM提供的基础时间序列 名称，cpuUsage、
cpuCoreUsed等： cpuUage：
cpu使用率； cpuCoreUsed：
cpu内核占用； 用户上报的自定 义时间序列名称。
dimensions 否 Array of DimensionSe ries objects
时间序列维度列表。 可通 过/v2/{project_id}/series接口中 namespace+metric_name， 查 询当前监控的时间序列名称的时 间序列维度列表。
表4-5 DimensionSeries
参数 是否必选 参数类型 描述
name 否 String 维度名称。
value 否 String 维度取值。
响应参数
状态码： 200
表4-6 响应 Body 参数
参数 参数类型 描述
series Array of SeriesQueryIt emResult objects
时间序列对象列表。
meta_data MetaDataSer
ies object 查询结果元数据信息，包括分页信息等。
表4-7 SeriesQueryItemResult
参数 参数类型 描述
namespace String 命名空间。
dimensions Array of DimensionSe ries objects
维度列表。
metric_name String 时间序列名称。
unit String 时间序列单位。
dimension_val
ue_hash String 时间序列哈希值。
表4-8 DimensionSeries
参数 参数类型 描述
name String 维度名称。
value String 维度取值。
表4-9 MetaDataSeries
参数 参数类型 描述
count Integer 当前返回结果条数。
offset Integer 下一个开始的标记，用于分页，null表示无更多 数据。
total Integer 总条数。
nextToken Integer 偏移量。
状态码： 400
表4-10 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误信息描述。
error_type String 错误类型。
请求示例
通过namespace+metric_name查询系统当前可监控的时间序列列表
https://{Endpoint}/v2/{project_id}/series { "series" : [ {
"namespace" : "PAAS.CONTAINER", "metric_name" : "cpuUsage"
} ] }
响应示例
状态码： 200 OK 请求执行完成。
{ "meta_data" : { "count" : 1, "offset" : null, "total" : 1 }, "series" : [ {
"namespace" : "PAAS.CONTAINER", "metric_name" : "cpuUsage", "unit" : "Percent",
"dimensions" : [ { "name" : "appName", "value" : "appValue"
} ]
} ] }
状态码： 400
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
{ "error_code" : "AOM.04007500", "error_msg" : "internal server error", "error_type" : "INTERNAL_SERVER_ERROR"
}
状态码
状态码 描述
200 OK 请求执行完成。
400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
401 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提 供的认证信息不正确或非法。
403 Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务 端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求 被设置为拒绝访问，建议直接修改该请求，不要重试该请求。
500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的 请求。
503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重 试该请求。
错误码
请参见错误码。