按标签查询监控数据 - 云平台 OCP V4.3.0

按标签查询监控数据

更新时间：2026-04-14 11:55:54

编辑

功能说明

查询指定指标的监控数据，同时附带分组标签的值。需要指定查询的时间区间，指标的数组。通过标签指定查询的范围，并将数据以指定的标签汇总。查询结果包含若干分组，每一分组内为时序数据。

调用说明

接口约束

调用者需要通过 OCP 应用服务鉴权。

请求路径

GET /api/v2/monitor/metricsWithLabel

请求参数

body：

参数	类型	必选	示例值	描述
startTime	Datetime	是	2020-02-16T05:32:16+08:00	监控数据的开始时间。
endTime	Datetime	是	2020-02-16T07:32:16+08:00	监控数据的结束时间。
metrics	StringArray	是	io_read_time,io_write_time	监控指标的数组。
groupBy	StringArray	是	app,ob_cluster_name,ob_cluster_id	监控数据的汇总标签。
interval	Integer	是	60	监控数据的时间粒度，单位为秒。
minStep	Integer	否	10	查询采样间隔，代表最小监控结果采样时间间隔，默认值为 0。
maxPoints	Integer	否	360	监控结果最大返回点数，默认值为 1440。
labels	StringArray	是	app:ob,ob_cluster_name=foo	监控数据的过滤条件。

说明

从 OCP V4.2.1 开始，obregion 参数名更新为 ob_cluster_name，已使用该参数进行接口调用的不受影响。

返回结果

基础数据结构

参数	类型	说明
data	Object	请求的数据。
├─ contents	Array	监控采样的数组，数据结构根据查询的监控指标来确定，详情参见监控采样组数据结构。
├─ page	Object	分页信息，详情参见 page 数据结构。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的服务端的地址。

监控采样组数据结构

参数	类型	说明
标签A	String	对应标签的值。
标签B	String	对应标签的值。
data	Array	监控采样的数组，数据结构根据查询的监控指标来确定，详情参见监控采样数据结构。

监控采样数据结构

参数	类型	说明
timestamp	Integer	采样的时间点，为距 1970-01-01 00:00:00 的秒数。
指标名A	Float	对应指标的采样值。
指标名B	Float	对应指标的采样值。

page 数据结构

参数	类型	说明
totalElements	Integer	总记录数。
totalPages	Integer	总页数。
number	Integer	当前页码。
size	Integer	当前页大小。

示例

请求示例

请求 2020-11-11 18:30:00.000+08:00 至 2020-11-11 19:00:00.000+08:00 的监控数据；请求的监控指标为 sql_all_count，输出监控数据的时间粒度为 1 秒；监控数据的过滤条件为 app=ob；监控数据以 app、ob_cluster_name、ob_cluster_id 三个标签来汇总：

api/v2/monitor/metricsWithLabel?labels=app%3Aob&groupBy=app%2Cob_cluster_name%2Cob_cluster_id&metrics=sql_all_count&interval=1&limit=5&startTime=2025-05-19T18%3A30%3A00.000%2B08%3A00&endTime=2025-05-19T19%3A00%3A00.000%2B08%3A00

返回示例

{
    "duration": 514,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2020-11-17T19:19:30.209+08:00",
    "traceId": "d972475d85b0405a",
    "data": {
        "contents": [
            {
                "app": "OB",
                "ob_cluster_name": "ob1",
               "ob_cluster_id": "2",
                "data": [
                    {
                        "sql_all_count": 38.00,
                        "timestamp": 1605608370
                    },
                    {
                        "sql_all_count": 43.50,
                        "timestamp": 1605608372
                    },
                    {
                        "sql_all_count": 38.50,
                        "timestamp": 1605608374
                    }
                ]
            },
            {
                "app": "OB",
                "ob_cluster_name": "ob2",
               "ob_cluster_id": "3",
                "data": [
                    {
                        "sql_all_count": 85.00,
                        "timestamp": 1605608370
                    },
                    {
                        "sql_all_count": 91.00,
                        "timestamp": 1605608372
                    },
                    {
                        "sql_all_count": 187.50,
                        "timestamp": 1605608374
                    }
                ]
            }
        ],
        "page": {
            "number": 2,
            "size": 2147483647,
            "totalElements": 3,
            "totalPages": 1
        }
    }
}