GET方法查询瞬时数据
功能介绍
该接口使用GET方法查询PromQL(Prometheus Query Language)在特定时间点下的计算结果。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/aom/api/v1/query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
query |
是 |
String |
PromQL表达式,参考:Prometheus官方文档。 |
|
time |
否 |
String |
指定用于计算 PromQL 的时间戳,(Unix时间戳格式,单位:秒)。例如:2024-10-16 16:03:01需要通过工具转换成UNIX秒级时间戳:1729065781。不指定则查询当前时间数据。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见:获取Token。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
响应状态。 |
|
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 |
错误信息。 |
请求示例
查询表达式up在时间点1630124012的计算结果。
https://{EndPoint}/v1/{project_id}/aom/api/v1/query?query=up&time=1630124012
响应示例
状态码:200
OK 请求响应成功。
{
"status" : "success",
"data" : {
"resultType" : "vector",
"result" : [ ]
}
}
状态码:400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{
"status" : "error",
"errorType" : "bad_param",
"error" : "param is invalid."
}
状态码: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 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。