本文导读

展开导读

文档首页/ 应用运维管理 AOM/ API参考（安卡拉区域）/ API/ Prometheus监控/ 根据Prometheus实例获取标签名列表

根据Prometheus实例获取标签名列表

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

查看PDF

功能介绍

该接口用于获取标签名列表。

URI

POST /v1/{project_id}/{prometheus_instance}/aom/api/v1/labels

表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	Array of strings	标签值信息。

状态码： 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/labels

{
  "status" : "success",
  "data" : [ "__name__", "alarm_level", "adfname", "alertstate", "ammApplicationID", "ammApplicationName", "appID", "appName", "clusterId", "clusterName", "cluster_id", "comparisonOperator", "containerID", "containerName", "nameSpace", "namespace", "netDevice", "nodeIP", "nodeName", "node_ip", "pailId", "pailName", "period_expr", "podID", "podName", "processCmd" ]
}

响应示例

状态码： 200

请求响应成功。

{
  "status" : "success",
  "data" : [ "__name__", "alarm_level", "adfname", "alertstate", "ammApplicationID", "ammApplicationName", "appID", "appName", "clusterId", "clusterName", "cluster_id", "comparisonOperator", "containerID", "containerName", "nameSpace", "namespace", "netDevice", "nodeIP", "nodeName", "node_ip", "pailId", "pailName", "period_expr", "podID", "podName", "processCmd" ]
}

状态码： 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	被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题： Prometheus监控

上一篇：根据Prometheus实例查询标签值

下一篇：根据Prometheus实例查询元数据

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消