文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ Prometheus监控/ GET方法查询区间数据
更新时间：2025-08-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

GET方法查询区间数据

功能介绍

该接口使用GET方法查询PromQL(Prometheus Query Language)在一段时间返回内的计算结果。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

query

是

String

PromQL表达式，参考：Prometheus官方文档。

start

是

String

起始时间戳(Unix时间戳格式，单位：秒）。例如：2024-10-16 16:03:01需要通过工具转换成UNIX秒级时间戳：1729065781。

end

是

String

结束时间戳(Unix时间戳格式，单位：秒）。例如：2024-10-16 16:03:01需要通过工具转换成UNIX秒级时间戳：1729065781。

step

是

String

查询时间步长，step参数‌是指在执行range query时，查询解析度的设定。step参数定义了查询的时间间隔，用于将查询的时间范围分割成多个小段，然后对每个小段进行求值。step参数需要与数据采集的频率相匹配，以确保数据的准确性和一致性。如果step设置得太小，可能会导致查询性能下降；如果设置得太大，则可能错过某些细节。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。获取方式请参见：获取Token。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

响应状态。

data

Object

响应数据。

状态码：403

表5 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码：422

表6 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码：503

表7 响应Body参数

参数

参数类型

描述

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

响应示例

状态码：200

OK 请求响应成功。

{
  "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" ] ]
    } ]
  }
}

状态码：400

BadRequest 非法请求。建议直接修改该请求，不要重试该请求。

1:1: parse error: unexpected <op:*>

状态码：403

Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

{
  "status" : "error",
  "errorType" : "auth",
  "error" : "auth project_id not pass."
}

状态码：422

Unprocessable 表达式无法执行。

{
  "status" : "error",
  "errorType" : "excution",
  "error" : "expression can't be executed."
}

状态码：503

ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。

{
  "status" : "error",
  "errorType" : "timeout",
  "error" : "query timed out in query execution."
}

状态码

状态码

描述

200

OK 请求响应成功。

400

BadRequest 非法请求。建议直接修改该请求，不要重试该请求。

403

Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

422

Unprocessable 表达式无法执行。

503

ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题： Prometheus监控