更新时间:2024-04-15 GMT+08:00

根据Prometheus实例查询元数据

功能介绍

该接口用于查询序列及序列标签的元数据。

URI

GET /v1/{project_id}/{prometheus_instance}/aom/api/v1/metadata

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

prometheus_instance

String

Prometheus实例ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

响应状态。

data

Object

元数据信息。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码: 403

表5 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码: 422

表6 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

状态码: 503

表7 响应Body参数

参数

参数类型

描述

status

String

响应状态。

errorType

String

错误类型。

error

String

错误信息。

请求示例

获取指标元数据。

https://{EndPoint}/v1/{project_id}/aom/api/v1/metadata

响应示例

状态码: 200

请求响应成功。

{
  "status" : "success",
  "data" : {
    "aggregator_openapi_v2_regeneration_count" : [ {
      "type" : "counter",
      "help" : "[ALPHA] Counter of OpenAPI v2 spec regeneration count broken down by causing APIService name and reason.",
      "unit" : ""
    } ]
  }
}

状态码: 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

被请求的服务无效。建议直接修改该请求,不要重试该请求。

错误码

请参见错误码