查询监控数据
功能介绍
该接口用于查询指定时间范围内指标的监控数据,可以通过参数指定需要查询的数据维度,数据周期等。(该接口已不再演进,建议使用 (推荐)POST方法查询区间数据接口。)
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/ams/metricdata
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
fillValue |
否 |
String |
用于对查询到的监控数据进行断点插值,默认值为-1。
缺省值:-1 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见:获取Token。 |
Content-Type |
是 |
String |
消息体的类型(格式)。指定类型为“application/json”。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
metrics |
是 |
Array of MetricQueryMetricParam objects |
指标对象列表。 取值范围 JSON数组大小不超过20 |
period |
是 |
Integer |
监控数据粒度。取值范围(枚举):
|
statistics |
是 |
Array of strings |
统计方式。 取值范围 maximum,minimum,sum,average,sampleCount |
timerange |
是 |
String |
查询时间范围,主要用于解决客户端时间和服务端时间不一致情况下,查询最近N分钟的数据。另可用于精确查询某一段时间的数据。 例如:
10:05:00指定的5分钟) 格式如下: startTimeInMillis.endTimeInMillis.durationInMinutes 参数解释:
约束与限制: 单次请求中,查询时长与周期需要满足以下条件: durationInMinutes * 60 / period <= 1440。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dimensions |
是 |
Array of Dimension objects |
时间序列维度列表。可通过调用查询时间序列接口,查询当前监控的时间序列名称的时间序列维度列表。取值范围:数组不能为空,同时数组中任何一个dimension对象name和value属性的值也不能为空。 |
metricName |
是 |
String |
指标名称。名称长度取值范围为1~255个字符。取值范围:AOM提供的基础指标,cpuUsage、cpuCoreUsed等,或用户上报的自定义指标名称。通过 查询标签值查询所有指标 |
namespace |
是 |
String |
指标命名空间。取值范围:
或用户自定义命名空间,通过 查询标签值查询所有命名空间的值 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
errorCode |
String |
响应码。 |
errorMessage |
String |
响应信息描述。 |
metrics |
Array of MetricDataValue objects |
指标对象列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
dataPoints |
Array of MetricDataPoints objects |
重点指标。 |
metric |
MetricQueryMetricParam object |
查询参数集。 |
参数 |
参数类型 |
描述 |
---|---|---|
statistics |
Array of StatisticValue objects |
统计方式。 |
timestamp |
Long |
时间戳。 |
unit |
String |
时间序列单位。 |
参数 |
参数类型 |
描述 |
---|---|---|
dimensions |
Array of Dimension objects |
时间序列维度列表。可通过调用查询时间序列接口,查询当前监控的时间序列名称的时间序列维度列表。取值范围:数组不能为空,同时数组中任何一个dimension对象name和value属性的值也不能为空。 |
metricName |
String |
指标名称。名称长度取值范围为1~255个字符。取值范围:AOM提供的基础指标,cpuUsage、cpuCoreUsed等,或用户上报的自定义指标名称。通过 查询标签值查询所有指标 |
namespace |
String |
指标命名空间。取值范围:
或用户自定义命名空间,通过 查询标签值查询所有命名空间的值 |
请求示例
查询指标名称"cpuUsage"且所属命名空间为"PAAS.CONTAINER"的指标在最近5分钟的监控数据。
https://{Endpoint}/v1/{project_id}/ams/metricdata { "metrics" : [ { "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ], "metricName" : "cpuUsage", "namespace" : "PAAS.CONTAINER" } ], "period" : 60, "statistics" : [ "maximum", "minimum", "sum" ], "timerange" : "-1.-1.5" }
响应示例
状态码:200
OK 请求执行完成。
{ "errorCode" : "SVCSTG_AMS_2000000", "errorMessage" : "success", "metrics" : [ { "metric" : { "namespace" : "PAAS.CONTAINER", "metricName" : "cpuUsage", "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ] }, "dataPoints" : [ { "timestamp" : "1467892800000", "unit" : "Percent", "statistics" : [ { "statistic" : "maximum", "value" : "23" } ] } ] } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求执行完成。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。