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

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

请求信息

请求行

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

查询一段时间内指定集群下指定表达式的监控数据。该 API 透传了 Prometheus 的 Query_range API(https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries)。

请求行参数

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

请求参数

名称 类型 是否必填项 描述
query string 监控指标的 Prometheus 查询表达式字。平台内置的监控指标表达式可通过 GET /v2/metrics/{cluster}/indicators 接口获取。例如:`up`、`min(node_memory_MemAvailable/node_memory_MemTotal)`。
start integer 开始时间,为 Unix 时间戳。
end integer 结束时间,为 Unix 时间戳。
step integer 查询结果数据的聚合时间,单位:秒。即使用查询时间前 xx 秒内数据进行聚合。
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.130.193:10250",
           "job": "kubelet",
           "namespace": "kube-system",
           "node": "192.168.130.193",
           "service": "kubelet"
         },
         "values": [
           [
             1640671200,
             "1"
           ],
           [
             1640671800,
             "1"
           ],
           [
             1640672400,
             "1"
           ],
           [
             1640673000,
             "1"
           ],
           [
             1640673600,
             "1"
           ],
           [
             1640674200,
             "1"
           ],
           [
             1640674800,
             "1"
           ]
         ]
       }
     ],
     "resultType": "matrix"
   },
   "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

其他状态码