首页 / API 文档 / 运维中心 / 监控指标 / 查看指定表达式在某一时间点的监控数据

*查看指定表达式在某一时间点的监控数据

请求信息

请求行

GET /v2/metrics/{cluster}/prometheus/query

查询指定集群下,指定的表达式在某一时间点的监控数据,例如:查看某个时间点节点的 CPU 利用率。该 API 透传了 Prometheus 的 Query API(https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries)。

请求行参数

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

请求参数

名称 类型 是否必填项 描述
query string 监控指标的 Prometheus 查询表达式字。平台内置的监控指标表达式可通过 GET /v2/metrics/{cluster}/indicators 接口获取。例如:`up`、`min(node_memory_MemAvailable/node_memory_MemTotal)`。
time integer 查询时间,为 Unix 时间戳。
timeout integer 从 Prometheus 查询时,Prometheus 的超时时长。

返回信息

Content-Type application/json

状态码: 200

OK

返回体示例

Prometheus 返回的查询结果数据。字段说明请参考:https://prometheus.io/docs/concepts/jobs_instances/#jobs-and-instances

{
   "data": {
     "result": [
       {
         "metric": {
           "__name__": "up",
           "endpoint": "https-metrics",
           "instance": "192.168.12.23:10250",
           "job": "kubelet",
           "namespace": "kube-system",
           "node": "192.168.12.23",
           "service": "kubelet"
         },
         "value": [
           1640675426.462,
           "1"
         ]
       }
     ],
     "resultType": "vector"
   },
   "status": "success"
 }

返回体说明

名称 类型 描述
data object Prometheus 返回的查询结果数据。字段说明请参考:https://prometheus.io/docs/concepts/jobs_instances/#jobs-and-instances
字段路径:data
data.result array Prometheus 返回的查询结果数据。字段说明请参考:https://prometheus.io/docs/concepts/jobs_instances/#jobs-and-instances
字段路径:data.result
data.resultType string Prometheus 表达式数据类型。详细信息请参考:https://prometheus.io/docs/prometheus/latest/querying/basics/#expression-language-data-types
字段路径:data.resultType
data.result[] object Prometheus 返回的查询结果数据。
字段路径:data.result[]
status string 访问 Promtheus 的 API 的状态。
字段路径:status

其他状态码