查询Prometheus实例下符合指定标签筛选器条件的时间序列
功能介绍
该接口用于查询Prometheus实例中符合指定标签筛选器条件的时间序列。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/{prometheus_instance}/aom/api/v1/series
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。 |
|
prometheus_instance |
是 |
String |
Prometheus实例id。默认普罗实例id为0。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
match[] |
是 |
String |
标签匹配器。 |
|
start |
否 |
String |
开始时间。 |
|
end |
否 |
String |
结束时间。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
错误信息。 |
请求示例
-
查询所有包含标签 job="prometheus" 的时间序列。
https://{EndPoint}/v1/{project_id}/{prometheus_instance}/aom/api/v1/series?match[]={job="prometheus"} -
查询指标名称以 "http_request_" 开头且状态码为 "5xx" 的时间序列。
https://{EndPoint}/v1/{project_id}/{prometheus_instance}/aom/api/v1/series?match[]={__name__=~"http_request_.*", status=~"5.."}
响应示例
状态码：200
OK 请求响应成功。
{
"data" : [ {
"__name__" : "aom_node_cpu_usage",
"clusterId" : "00000000-0000-0000-0000-00000000",
"hostID" : "17558d48-****-44c0-****-0a4f9159b6e5",
"hostName" : "aomtest-console",
"nameSpace" : "default",
"nodeIP" : "10.**.1**.98",
"nodeName" : "aomtest-console"
} ],
"status" : "success"
}
状态码：400
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
{
"status" : "error",
"errorType" : "bad_data",
"error" : "invalid parameter \"match[]\": match[] must contain at least one non-empty matcher"
}
状态码：403
Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。
{
"status" : "error",
"errorType" : "auth",
"error" : "auth project_id not pass."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
|
400 |
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
|
403 |
Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
