4.2 prometheus 监控
4.2.3 瞬时数据查询
状态码： 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 被请求的服务无效。建议直接修改该请求，不要重试该请求。
错误码
请参见错误码。
4.2.3 瞬时数据查询
功能介绍
该接口用于查询PromQL(Prometheus Query Language)在特定时间点下的计算结 果。（注：接口目前开放的region为：北京四、上海一和广州）。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/aom/api/v1/query
表4-131 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户从IAM申请到的projectid，
一般为32位字符串。
表4-132 Query 参数
参数 是否必选 参数类型 描述
query 是 String PromQL表达式(参考https://
prometheus.io/docs/
prometheus/latest/querying/
basics/)。
time 否 String 指定用于计算 PromQL 的时间
戳，(Unix时间戳格式，单位：
秒）。
请求参数
表4-133 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 从IAM服务获取的用户Token。
响应参数
状态码： 200
表4-134 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
data Data object 数据信息详情
表4-135 Data
参数 参数类型 描述
resultType String 返回值类型。
result Array of
strings 数据信息。
状态码： 400
表4-136 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 403
表4-137 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 422
表4-138 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 503
表4-139 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
请求示例
查询表达式up在时间点1630124012的计算结果。
https://{EndPoint}/v1/{project_id}/aom/api/v1/query?query=up&time=1630124012 { "status" : "success",
"data" : {
"resultType" : "vector", "result" : [ ]
}}
响应示例
状态码： 200 请求响应成功。
"{\n \"status\": \"success\" ,\n \"data\": <data>\n}"
状态码： 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 被请求的服务无效。建议直接修改该请求，不要重试该请求。
错误码
请参见错误码。
4.2.4 瞬时数据查询
功能介绍
该接口用于查询PromQL(Prometheus Query Language) 在特定时间点下的计算结 果。（注：接口目前开放的region为：北京四、上海一和广州）
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/aom/api/v1/query
表4-140 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户从IAM申请到的projectid，
一般为32位字符串。
表4-141 Query 参数
参数 是否必选 参数类型 描述
query 是 String PromQL表达式(参考https://
prometheus.io/docs/
prometheus/latest/querying/
basics/)。
time 否 String 指定用于计算 PromQL 的时间
戳，(Unix时间戳格式，单位：
秒）。
请求参数
表4-142 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 从IAM服务获取的用户Token。
响应参数
状态码： 200
表4-143 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
data Data object 数据信息详情
表4-144 Data
参数 参数类型 描述
resultType String 返回值类型。
result Array of
strings 数据信息。
状态码： 400
表4-145 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 403
表4-146 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 422
表4-147 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 503
表4-148 响应 Body 参数
参数 参数类型 描述
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 { "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",
"clusterId" : "00000000-0000-0000-0000-00000000", "hostID" : "dc1xxxf7e-b095-4e77-bxx-914dhlxxxbf7", "nameSpace" : "default",
"{\n \"status\": \"success\" ,\n \"data\": <data>\n}"
状态码： 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 被请求的服务无效。建议直接修改该请求，不要重试该请求。
错误码
请参见错误码。