区间数据查询
功能介绍
该接口用于查询PromQL(Prometheus Query Language)在一段时间返回内的计算结果。(注:接口目前开放的region为:北京四、上海一和广州)。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/aom/api/v1/query_range
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
query |
是 |
String |
PromQL表达式(参考https://prometheus.io/docs/prometheus/latest/querying/basics/)。 |
start |
是 |
String |
起始时间戳(Unix时间戳格式,单位:秒)。 |
end |
是 |
String |
结束时间戳(Unix时间戳格式,单位:秒)。 |
step |
是 |
String |
查询时间步长,时间区内每step秒执行一次。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
data |
Data object |
数据信息详情 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
状态码: 422
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
状态码: 503
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态。 |
errorType |
String |
错误类型。 |
error |
String |
错误信息。 |
请求示例
查询表达式up在start到end秒范围内以15秒为间隔计算PromQL表达式的结果。
https://{EndPoint}/v1/{project_id}/aom/api/v1/query_range?query=up&start=1630124012&end=1630127612&step=15s { "status" : "success", "data" : { "resultType" : "matrix", "result" : [ { "metric" : { "__name__" : "up", "job" : "prometheus", "instance" : "localhost:9090" }, "values" : [ [ 1.435781430781E9, "1" ], [ 1.435781445781E9, "1" ], [ 1.435781460781E9, "1" ] ] }, { "metric" : { "__name__" : "up", "job" : "node", "instance" : "localhost:9091" }, "values" : [ [ 1.435781430781E9, "0" ], [ 1.435781445781E9, "0" ], [ 1.435781460781E9, "1" ] ] } ] } }
响应示例
状态码: 200
请求响应成功。
{ "status": "success" , "data": <data> }
状态码: 400
非法请求。参数错误或者缺失,建议直接修改该请求,不要重试该请求。
{ "status" : "error", "errorType" : "bad_param", "error" : "param is invalid." }
状态码: 403
禁止访问。
{ "status" : "error", "errorType" : "auth", "error" : "auth project_id not pass." }
状态码: 422
表达式无法执行。
{ "status" : "error", "errorType" : "excution", "error" : "expression can't be executed." }
状态码: 503
被请求的服务无效。建议直接修改该请求,不要重试该请求。
{ "status" : "error", "errorType" : "timeout", "error" : "query timed out in query execution." }
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
400 |
非法请求。参数错误或者缺失,建议直接修改该请求,不要重试该请求。 |
403 |
禁止访问。 |
422 |
表达式无法执行。 |
503 |
被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。
