---
title: "查询监控指标的元数据 - 云平台 OCP V4.3.0 | OceanBase 文档中心"
description: 查询监控指标的元数据 功能说明 查询 OCP 应用当前提供的指标元数据。使用者可以根据这些元数据，继续查询相应的监控数据。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/monitor/metricGroups 请求参数 body： 参数 类型 必选 示例值 描述 pa…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.3.0

# 查询监控指标的元数据

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

[编辑](https://github.com/oceanbase/ocp-doc/edit/V4.3.0/zh-CN/1900.reference-guide/200.api-reference/900.monitoring/100.query-the-metadata-of-a-monitoring-metric.md)  

## **功能说明**

查询 OCP 应用当前提供的指标元数据。使用者可以根据这些元数据，继续查询相应的监控数据。

## **调用说明**

### 接口约束

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

### 请求路径

`GET /api/v2/monitor/metricGroups`

### 请求参数

**body：**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| page | Integer | 否 | 1 | 请求数据的分页页码。值从 1 开始，默认值为 1。 |
| size | Integer | 否 | 10 | 请求数据的分页大小。默认值为 10，最大值为 2000。 |
| sort | String | 否 | asc,name | 请求数据的排序规则，默认按 ID 升序排序。 |
| type | String | 是 | TOP | 查询的指标类型：- TOP：查询 Top 类指标的元数据。 - NORMAL：查询普通指标的元数据。 |
| scope | String | 是 | CLUSTER | 查询的指标范围：- CLUSTER：集群的指标。 - TENANT：租户的指标。 - HOST：主机的指标。 - OBPROXY：OBProxy 的指标。 |
| target | String | 否 | OBCLUSTER | 指标元信息类型：- OBCLUSTER：OceanBase 集群。 - OBPROXY：OBProxy 集群。 |
| targetId | Integer | 否 | 1 | 指标元信息 ID：- 当 `target` 为 OBCLUSTER 时，传入 OceanBase 集群 ID。 - 当 `target` 为 OBPROXY 时，传入 OBProxy 集群 ID。 |

### 返回结果

**基础数据结构**

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

**指标大类数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | Integer | 指标大类的 ID。 |
| key | String | 指标大类的编码名称。 |
| name | String | 指标大类的名称。支持国际化。 |
| description | String | 指标大类的说明信息。支持国际化。 |
| scope | String | 指标范围：- CLUSTER：集群的指标。 - TENANT：租户的指标。 - HOST：主机的指标。 - OBPROXY：OBProxy 的指标 |
| type | String | 指标类型：- TOP：查询 Top 类指标的元数据。 - NORMAL：查询普通指标的元数据。 |
| metricGroups | Array | 指标分组的数组，详情参见 **指标分组数据结构**。 |

**指标分组数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | Integer | 指标分组的 ID。 |
| key | String | 指标分组的编码名称。 |
| name | String | 指标分组的名称。支持国际化。 |
| description | String | 指标分组的说明信息。支持国际化。 |
| metrics | Array | 指标元数据的数组，详情参见 **指标元数据数据结构**。 |
| withLabel | Boolean | 是否为带标签的监控数据群组。 |

**指标元数据数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | Integer | 指标的 ID。 |
| key | String | 指标的编码名称。 |
| name | String | 指标的名称，支持国际化。 |
| description | String | 指标的说明信息，支持国际化。 |
| unit | String | 指标的单位。 |
| displayByDefault | Boolean | 是否默认展示。 |

**page 数据结构**

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

## 示例

### 请求示例

查询集群范围、Top 类型的指标的元数据：

```json
GET /api/v2/monitor/metricGroups?scope=CLUSTER&type=TOP

```

### 返回示例

```json
{
    "duration":5,
    "server": "a83ad33525",
    "status":200,
    "successful":true,
    "timestamp":"2020-11-11T15:46:03.216+08:00",
    "traceId":"2a37968df71c4912",
    "data":{
        "contents":[
            {
                "description":"集群TOP指标",
                "id":6,
                "key":"metric_cluster_top",
                "metricGroups":[
                    {
                        "description":"平均每秒处理 SQL 语句数",
                        "id":47,
                        "key":"QPS",
                        "metrics":[
                            {
                                "description":"每秒处理 SQL 语句数",
                                "displayByDefault":true,
                                "id":1000061,
                                "key":"sql_all_count",
                                "name":"all",
                                "unit":"times/s"
                            }
                        ],
                        "name":"QPS",
                        "withLabel":false
                    },
                    {
                        "description":"服务端每条 SQL 语句处理平均耗时",
                        "id":48,
                        "key":"QPS_RT",
                        "metrics":[
                            {
                                "description":"服务端每条 SQL 语句平均处理耗时",
                                "displayByDefault":true,
                                "id":1000062,
                                "key":"sql_all_rt",
                                "name":"all",
                                "unit":"us"
                            }
                        ],
                        "name":"查询响应时间",
                        "withLabel":false
                    },
                    {
                        "description":"活跃会话数",
                        "id":49,
                        "key":"active_session",
                        "metrics":[
                            {
                                "description":"当前活跃会话数",
                                "displayByDefault":true,
                                "id":1000063,
                                "key":"active_session",
                                "name":"active_session",
                                "unit":""
                            }
                        ],
                        "name":"活跃会话数",
                        "withLabel":false
                    },
                    {
                        "description":"CPU 使用率",
                        "id":50,
                        "key":"cpu_percent",
                        "metrics":[
                            {
                                "description":"CPU 使用率",
                                "displayByDefault":true,
                                "id":1000060,
                                "key":"cpu_percent",
                                "name":"cpu_percent",
                                "unit":"percent"
                            }
                        ],
                        "name":"CPU 使用率",
                        "withLabel":false
                    }
                ],
                "name":"集群TOP指标",
                "scope":"CLUSTER",
                "type":"TOP"
            }
        ],
        "page":{
            "number":1,
            "size":2000,
            "totalElements":1,
            "totalPages":1
        }
    }
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线