查询监控数据
功能介绍
该接口用于查询指定时间范围内指标的监控数据，可以通过参数指定需要查询的数据维度，数据周期等。
URI
POST /v1/{project_id}/ams/metricdata
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid，一般为32位字符串。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
fillValue |
否 |
String |
用于对查询到的监控数据进行断点插值，默认值为-1。 -1：断点处使用-1进行表示。 0 ：断点处使用0进行表示。 null：断点处使用null进行表示。 average：断点处使用前后邻近的有效数据的平均值进行表示，如果不存在有效数据则使用null进行表示。 枚举值：
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
Content-Type |
是 |
String |
指定类型为application/json。 枚举值：
|
X-Aom-Prometheus-Id |
否 |
String |
Prometheus实例ID，不填默认为默认prometheus实例 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
metrics |
是 |
Array of MetricQueryMeritcParam objects |
指标对象列表。 取值范围 JSON数组大小不超过20 |
period |
是 |
Integer |
监控数据粒度。 取值范围 枚举值，取值范围：
枚举值：
|
statistics |
是 |
Array of strings |
统计方式。 取值范围 maximum，minimum，sum，average，sampleCount |
timerange |
是 |
String |
timeRange用于指标查询时间范围，主要用于解决客户端时间和服务端时间不一致情况下，查询最近N分钟的数据。另可用于精确查询某一段时间的数据。 如： -1.-1.60(表示最近60分钟)，不管当前客户端是什么时间，都以服务端时间为准查询最近60分钟。 1650852000000.1650852300000.5(表示GMT+8 2022-04-25 10:00:00至2022-04-25 10:05:00指定的5分钟) 格式： startTimeInMillis.endTimeInMillis.durationInMinutes 参数解释： startTimeInMillis: 查询的开始时间，格式为UTC毫秒，如果指定为-1，服务端将按(endTimeInMillis - durationInMinutes * 60 * 1000)计算开始时间。如-1.1650852300000.5，则相当于1650852000000.1650852300000.5 endTimeInMillis: 查询的结束时间，格式为UTC毫秒，如果指定为-1，服务端将按(startTimeInMillis + durationInMinutes * 60 * 1000)计算结束时间，如果计算出的结束时间大于当前系统时间，则使用当前系统时间。如1650852000000.-1.5，则相当于1650852000000.1650852300000.5 durationInMinutes：查询时间的跨度分钟数。 取值范围大于0并且大于等于(endTimeInMillis - startTimeInMillis) / (60 * 1000) - 1。当开始时间与结束时间都设置为-1时，系统会将结束时间设置为当前时间UTC毫秒值，并按(endTimeInMillis - durationInMinutes * 60 * 1000)计算开始时间。如：-1.-1.60(表示最近60分钟) 约束： 单次请求中，查询时长与周期需要满足以下条件: durationInMinutes * 60 / period <= 1440 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
dimensions |
是 |
Array of Dimension objects |
指标维度列表。 取值范围： 数组不能为空，同时数组中任何一个dimension对象name和value属性的值也不能为空。 |
metricName |
是 |
String |
指标名称。名称长度取值范围为1~255个字符。 取值范围： AOM提供的基础指标， cpuUsage、cpuCoreUsed等 cpuUage：cpu使用率； cpuCoreUsed：cpu内核占用； 用户上报的自定义指标名称。 |
namespace |
是 |
String |
指标命名空间。 取值范围 ：
|
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
errorCode |
String |
响应码。 |
errorMessage |
String |
响应信息描述。 |
metrics |
Array of MetricDataValue objects |
指标对象列表。 |
参数 |
参数类型 |
描述 |
|---|---|---|
dataPoints |
Array of MetricDataPoints objects |
重点指标。 |
metric |
MetricQueryMeritcParam 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等 cpuUage：cpu使用率； cpuCoreUsed：cpu内核占用； 用户上报的自定义指标名称。 |
namespace |
String |
指标命名空间。 取值范围 ：
|
请求示例
查询指定指标最近5分钟的监控数据。
POST https://{Endpoint}/v1/{project_id}/ams/metricdata
{
"metrics" : [ {
"dimensions" : [ {
"name" : "instance_id",
"value" : "demo1"
} ],
"metricName" : "def",
"namespace" : "abc"
} ],
"period" : 60,
"statistics" : [ "maximum", "minimum", "sum" ],
"timerange" : "-1.-1.5"
}
响应示例
状态码： 200
OK
请求执行完成。
{
"errorCode" : "SVCSTG_AMS_2000000",
"errorMessage" : "success",
"metrics" : [ {
"metric" : {
"namespace" : "abc",
"metricName" : "def",
"dimensions" : [ {
"name" : "ghi",
"value" : "lmn"
} ]
},
"dataPoints" : [ {
"timestamp" : "1467892800000",
"unit" : "Percent",
"statistics" : [ {
"statistic" : "maximum",
"value" : "23"
} ]
} ]
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK 请求执行完成。 |
400 |
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 |
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
