查询时间序列
功能介绍
该接口用于查询系统当前可监控的时间序列列表，可以指定时间序列命名空间、名称、维度、所属资源的编号（格式为：resType_resId），分页查询的起始位置和返回的最大记录条数。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/series
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
String |
用于限制本次返回的结果数据条数。 取值范围(0,1000]，默认值为1000。 |
|
offset |
否 |
String |
分页查询起始位置，为非负整数。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
series |
是 |
Array of QuerySeriesOptionParam objects |
通过该数组传递的参数信息进行时间序列查询。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
namespace |
是 |
String |
时间序列命名空间。取值范围：PAAS.CONTAINER、PAAS.NODE、PAAS.SLA、PAAS.AGGR、CUSTOMMETRICS等。
或用户自定义命名空间 可通过查询标签值接口查询所有命名空间的值 |
|
metric_name |
否 |
String |
时间序列名称，名称长度取值范围为1~255个字符。取值范围：AOM提供的基础时间序列名称，cpuUsage、cpuCoreUsed等或用户上报的自定义时间序列名称。通过查询标签值接口查询所有时间序列名称 |
|
dimensions |
否 |
Array of DimensionSeries objects |
时间序列维度列表。可通过调用查询时间序列接口，查询当前监控的时间序列名称的时间序列维度列表。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
series |
Array of SeriesQueryItemResult objects |
时间序列对象列表。 |
|
meta_data |
MetaDataSeries object |
查询结果元数据信息，包括分页信息等。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
namespace |
String |
命名空间。 |
|
dimensions |
Array of DimensionSeries objects |
时间序列维度列表。 |
|
metric_name |
String |
时间序列名称。 |
|
unit |
String |
时间序列单位。 |
|
dimension_value_hash |
String |
时间序列哈希值。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
当前返回结果条数。 |
|
offset |
Integer |
下一个开始的标记，用于分页，null表示无更多数据。 |
|
total |
Integer |
总条数。 |
|
nextToken |
Integer |
偏移量。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息描述。 |
|
error_type |
String |
错误类型。 |
|
trace_id |
String |
请求id。 |
请求示例
通过namespace+metric_name查询系统当前可监控的时间序列列表
https://{Endpoint}/v2/{project_id}/series
{
"series" : [ {
"namespace" : "PAAS.CONTAINER",
"metric_name" : "aom_process_cpu_usage"
} ]
}
响应示例
状态码：200
OK 请求执行完成。
{
"meta_data" : {
"count" : 1,
"offset" : null,
"total" : 1,
"nextToken" : 0
},
"series" : [ {
"namespace" : "PAAS.CONTAINER",
"metric_name" : "cpuUsage",
"unit" : "Percent",
"dimensions" : [ {
"name" : "appName",
"value" : "appValue"
} ],
"dimension_value_hash" : null
} ]
}
状态码：400
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.04007101",
"error_msg" : "Invalid namespace",
"error_type" : "BAD_REQUEST",
"trace_id" : ""
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求执行完成。 |
|
400 |
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
|
401 |
Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 |
|
403 |
Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
|
500 |
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 |
|
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
