根据Prometheus实例查询瞬时数据
功能介绍
该接口用于查询PromQL(Prometheus Query Language) 在特定时间点下的计算结果。
URI
POST /v1/{project_id}/{prometheus_instance}/aom/api/v1/query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
|
prometheus_instance |
是 |
String |
Prometheus实例ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
query |
是 |
String |
PromQL表达式(参考https://prometheus.io/docs/prometheus/latest/querying/basics/)。 |
|
time |
否 |
String |
指定用于计算 PromQL 的时间戳,(Unix时间戳格式,单位:秒)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
错误信息。 |
请求示例
查询在1630381536时刻的aom_node_status指标(前topk个)。
https://{EndPoint}/v1/{project_id}/aom/api/v1/query?query=topk(2,aom_node_status)&time=1630381536
响应示例
状态码: 200
请求响应成功。
{
"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
非法请求。参数错误或者缺失,建议直接修改该请求,不要重试该请求。
{
"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 |
被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。