首页 / API 文档 / 运维中心 / 监控指标 / 查看监控指标列表及详情

*查看监控指标列表及详情

请求信息

请求行

GET /v2/metrics/{cluster}/indicators

查看平台上指定集群的内置监控指标列表。

请求行参数

名称 类型 是否必填项 描述
cluster string 集群的名称。

请求参数

名称 类型 是否必填项 描述
kind string 资源的类型,设置后,仅返回该类型资源相关的监控指标。
alertEnabled string 是否仅返回正在告警的监控指标。

返回信息

Content-Type application/json

状态码: 200

OK

返回体示例

指标列表。

[
   {
     "alertEnabled": true,
     "annotations": {
       "cn": "集群内的处于告警状态的告警数",
       "en": "The total number of firing alerts"
     },
     "displayName": "集群内的处于告警状态的告警数",
     "kind": "cluster",
     "legend": "",
     "name": "cluster.alerts.firing",
     "query": "(sum(ALERTS{alertstate=\"firing\",alertname!=\"DeadMansSwitch\"}) or on() vector(0))",
     "summary": "",
     "type": "metric",
     "unit": "",
     "variables": []
   }
 ]

返回体说明

名称 类型 描述
[] object 指标名称。可通过 GET /v2/metrics/{cluster}/indicators 获取。
字段路径:[]
[].kind string 指标关联的资源类型,包含集群、节点、工作负载。
字段路径:[].kind
[].name string 指标名称。可通过 GET /v2/metrics/{cluster}/indicators 获取。
字段路径:[].name
[].query string 指标查询表达式。
字段路径:[].query
[].unit string 指标单位。
字段路径:[].unit
[].variables array 监控指标的变量(键/值对)。可通过 GET /v2/metrics/{cluster}/indicators 接口获取。
字段路径:[].variables

其他状态码