功能介绍

该接口用于查询PromQL(Prometheus Query Language)在一段时间返回内的计算结果。（注：接口目前开放的region为：北京四、上海一和广州）。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/aom/api/v1/query_range

请求参数

响应参数

状态码： 200

状态码： 400

状态码： 403

状态码： 422

状态码： 503

请求示例

查询表达式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."
}

状态码

错误码

请参见错误码。