文档首页/ 应用运维管理 AOM/ API参考（安卡拉区域）/ API/ Prometheus监控/ 根据Prometheus实例查询区间数据
更新时间：2024-04-15 GMT+08:00
查看PDF
分享

根据Prometheus实例查询区间数据

功能介绍

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

URI

POST /v1/{project_id}/{prometheus_instance}/aom/api/v1/query_range

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

prometheus_instance

是

String

Prometheus实例ID
表2 Query参数

参数

是否必选

参数类型

描述

query

是

String

PromQL表达式(参考https://prometheus.io/docs/prometheus/latest/querying/basics/)。

start

是

String

起始时间戳(Unix时间戳格式，单位：秒）。

end

是

String

结束时间戳(Unix时间戳格式，单位：秒）。

step

是

String

查询时间步长，时间区内每step秒执行一次。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

status

String

响应状态。

data

Data object

响应数据。
表5 Data

参数

参数类型

描述

resultType

String

返回值类型。

result

Array of objects

数据信息。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码： 422

表8 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码： 503

表9 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

请求示例

查询在start到end时间范围内每隔step秒的aom_node_status指标（前topk个）。

https://{EndPoint}/v1/{project_id}/aom/api/v1/query_range?query=topk(2,aom_node_status)&start=1630386780&end=1630390380&step=15

响应示例

状态码： 200

请求响应成功。

{
  "status" : "success",
  "data" : {
    "resultType" : "matrix",
    "result" : [ {
      "metric" : {
        "__name__" : "amm_node_status",
        "clusterId" : "000000-0000-0000-0000-0000000",
        "hostID" : "c9xxcb-2x6c-4h54-8fcd-f68xx85",
        "nameSpace" : "default",
        "nodeIP" : "1xx.1xx.0.1xx",
        "nodeName" : "sis-xxn-amm"
      },
      "values" : [ [ 1630386780, "0" ], [ 1630388610, "0" ], [ 1630388625, "0" ] ]
    }, {
      "metric" : {
        "__name__" : "amm_node_status",
        "clusterId" : "00000000-0000-0000-0000-00000000",
        "hostID" : "ec5xxxb-0xx8-4xxx-bxx-9ecxxf",
        "nameSpace" : "default",
        "nodeIP" : "1xx.168.0.1x",
        "nodeName" : "fdx-ibxxst"
      },
      "values" : [ [ 1630388265, "0" ], [ 1630388280, "0" ], [ 1630388295, "0" ] ]
    } ]
  }
}

状态码： 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

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

错误码

请参见错误码。

父主题： Prometheus监控