GET方法查询Prometheus实例下瞬时数据 - ListInstantQueryAomPrometheusInstanceGet

功能介绍

该接口使用GET方法查询Prometheus实例中PromQL(Prometheus Query Language) 在特定时间点下的计算结果。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
aom:metric:list
List
-
-
aom:metric:get
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
aom:metric:list	List	-	-	aom:metric:get	-

URI

GET /v1/{project_id}/{prometheus_instance}/aom/api/v1/query

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。
prometheus_instance	是	String	Prometheus实例id。默认普罗实例id为0。

表2 Query参数
参数	是否必选	参数类型	描述
query	是	String	PromQL表达式，参考：Prometheus官方文档。
time	否	String	指定用于计算 PromQL 的时间戳。Unix时间戳格式，单位：秒。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token。获取方式请参见：获取Token。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
status	String	参数解释：响应状态。取值范围： success：返回成功。 error：返回失败。
data	Object	响应数据。

状态码：400

表5 响应Body参数
参数	参数类型	描述
status	String	参数解释：响应状态。取值范围： success：返回成功 error：返回失败。
errorType	String	错误类型。
error	String	错误信息。

状态码：403

表6 响应Body参数
参数	参数类型	描述
status	String	参数解释：响应状态。取值范围： success：返回成功 error：返回失败。
errorType	String	错误类型。
error	String	错误信息。

状态码：422

表7 响应Body参数
参数	参数类型	描述
status	String	参数解释：响应状态。取值范围： success：返回成功 error：返回失败。
errorType	String	错误类型。
error	String	错误信息。

状态码：503

表8 响应Body参数
参数	参数类型	描述
status	String	参数解释：响应状态。取值范围： success：返回成功 error：返回失败。
errorType	String	错误类型。
error	String	错误信息。

请求示例

查询在1630381536时刻的aom_node_status指标（前topk个）。

https://{EndPoint}/v1/{project_id}/{prometheus_instance}/aom/api/v1/query?query=topk(2,aom_node_status)&time=1630381536

响应示例

状态码：200

OK 请求响应成功。

{
  "status" : "success",
  "data" : {
    "resultType" : "vector",
    "result" : [ {
      "metric" : {
        "__name__" : "amm_node_status",
        "clusterId" : "00000000-0000-0000-0000-00000000",
        "hostID" : "g947xcxh-2xcxc-xxx-xxcd-f6xxx85",
        "nameSpace" : "default",
        "nodeIP" : "1x6.1xx.0.xxx",
        "nodeName" : "sdxx-jxxxgksi-axx"
      },
      "value" : [ 16303810036, "0" ]
    }, {
      "metric" : {
        "__name__" : "amm_node_status",
        "clusterId" : "00000000-0000-0000-0000-00000000",
        "hostID" : "dc1xxxf7e-b095-4e77-bxx-914dhlxxxbf7",
        "nameSpace" : "default",
        "nodeIP" : "1xx.1xx.0.xxx",
        "nodeName" : "sds-jixxxsi-texxt"
      },
      "value" : [ 1630381536, "0" ]
    } ]
  }
}

状态码：400

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

{
  "status" : "error",
  "errorType" : "bad_data",
  "error" : "invalid parameter \"query\": 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 被请求的服务无效。建议直接修改该请求，不要重试该请求。