4.2 prometheus 监控
4.2.1 区间数据查询
状态码
状态码 描述
200 OK 请求响应成功。
400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出 客户端所提供的认证信息不正确或非法。
403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端, 且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置 为拒绝访问,建议直接修改该请求,不要重试该请求。
500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的 请求。
503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试 该请求。
错误码
请参见错误码。
4.2 prometheus 监控
4.2.1 区间数据查询
功能介绍
该接口用于查询PromQL(Prometheus Query Language)在一段时间返回内的计算结 果。（注：接口目前开放的region为：北京四、上海一和广州）。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/aom/api/v1/query_range
表4-113 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户从IAM申请到的projectid，
一般为32位字符串。
表4-114 Query 参数
参数 是否必选 参数类型 描述
query 是 String PromQL表达式(参考https://
prometheus.io/docs/
prometheus/latest/querying/
basics/)。
start 是 String 起始时间戳(Unix时间戳格式，
单位：秒）。
end 是 String 结束时间戳(Unix时间戳格式，
单位：秒）。
step 是 String 查询时间步长，时间区内每step
秒执行一次。
请求参数
表4-115 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 从IAM服务获取的用户Token。
响应参数
状态码： 200
表4-116 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
data Data object 数据信息详情
表4-117 Data
参数 参数类型 描述
resultType String 返回值类型。
result Array of
strings 数据信息。
状态码： 400
表4-118 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 403
表4-119 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 422
表4-120 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 503
表4-121 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
请求示例
查询表达式up在start到end秒范围内以15秒为间隔计算PromQL表达式的结果。
https://{EndPoint}/v1/{project_id}/aom/api/v1/query_range?
query=up&start=1630124012&end=1630127612&step=15s { "status" : "success",
"data" : {
"resultType" : "matrix", "result" : [ {
"metric" : { "__name__" : "up", "job" : "prometheus", "instance" : "localhost:9090"
},
"values" : [ [ 1.435781430781E9, "1" ], [ 1.435781445781E9, "1" ], [ 1.435781460781E9, "1" ] ] }, {
"metric" : { "__name__" : "up", "job" : "node",
"instance" : "localhost:9091"
},
"values" : [ [ 1.435781430781E9, "0" ], [ 1.435781445781E9, "0" ], [ 1.435781460781E9, "1" ] ] } ]
}}
响应示例
状态码： 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.2 区间数据查询
功能介绍
该接口用于查询PromQL(Prometheus Query Language)在一段时间返回内的计算结 果。（注：接口目前开放的region为：北京四、上海一和广州）。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/aom/api/v1/query_range
表4-122 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户从IAM申请到的projectid，
一般为32位字符串。
表4-123 Query 参数
参数 是否必选 参数类型 描述
query 是 String PromQL表达式(参考https://
prometheus.io/docs/
prometheus/latest/querying/
basics/)。
start 是 String 起始时间戳(Unix时间戳格式，
单位：秒）。
end 是 String 结束时间戳(Unix时间戳格式，
单位：秒）。
step 是 String 查询时间步长，时间区内每step
秒执行一次。
请求参数
表4-124 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 从IAM服务获取的用户Token。
响应参数
状态码： 200
表4-125 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
data Data object 数据信息详情
表4-126 Data
参数 参数类型 描述
resultType String 返回值类型。
result Array of
strings 数据信息。
状态码： 400
表4-127 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 403
表4-128 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 422
表4-129 响应 Body 参数
参数 参数类型 描述
status String 响应状态。
errorType String 错误类型。
error String 错误信息。
状态码： 503
表4-130 响应 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 { "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",
"clusterId" : "00000000-0000-0000-0000-00000000", "hostID" : "ec5xxxb-0xx8-4xxx-bxx-9ecxxf",
"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 被请求的服务无效。建议直接修改该请求，不要重试该请求。
错误码
请参见错误码。