---
title: "查询执行计划的性能统计 | OceanBase 文档中心"
description: "查询执行计划的性能统计 功能说明 查询指定 SQL 的关联的执行计划的性能统计。 调用说明 接口约束 调用者需具备指定租户的读权限。 请求路径 GET /api/v2/ob/clusters/{clusterId}/tenants/{tenantId}/sqls/{sqlId}/topPlan 请求参数 参数 类型 …"
---
切换语言

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

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

# 查询执行计划的性能统计

更新时间：2023-08-10 11:45:58

## **功能说明**

查询指定 SQL 的关联的执行计划的性能统计。

## **调用说明**

**接口约束**

调用者需具备指定租户的读权限。

**请求路径**

`GET /api/v2/ob/clusters/{clusterId}/tenants/{tenantId}/sqls/{sqlId}/topPlan`

**请求参数**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| clusterId | Integer | 是 | 1 | 集群的 Id |
| tenantId | Integer | 是 | 1001 | 租户的 Id |
| sqlId | String | 是 | C9B3A63AFF8F2A408CCF3D5B0F36682D | SQL的 Id |
| startTime | Datetime | 是 | 2020-02-16T05:32:16+08:00 | 开始时间 |
| endTime | Datetime | 是 | 2020-02-16T07:32:16+08:00 | 结束时间 |
| serverId | Integer | 否 | 300 | 查询在指定 OB 服务器上的计划的性能。不指定时，查询 SQL 在所有服务器上的计划的性能。 |

**返回结果**

- 基础数据结构

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

- 计划详情的数据结构

  | 参数 | 类型 | |
  | --- | --- | --- |
  | uid | String | 计划的 Uid |
  | server | String | OB 服务器的地址，包括 IP 和端口。 |
  | planId | Integer | 计划的原始 Id。OB服务器范围内的自增值。 |
  | firstLoadTime | Datetime | 计划首次被加载的时间 |
  | planType | String | 计划的类型： * LOCAL：本地计划； * REMOTE：远程计划； * DIST：分布式计划； |
  | planHash | Integer | 计划的哈希值 |
  | planSize | Integer | 计划的大小 |
  | schemaVersion | Integer | Schema的版本 |
  | mergedVersion | Integer | 合并版本 |
  | hitPercentage | Float | 计划在期间内的命中率 |
  | executions | Integer | 计划在期间内的执行次数 |
  | execPs | Float | 计划在期间内的平均每秒执行次数 |
  | maxExecTime | Float | 计划在期间内的最慢执行时间（毫秒） |
  | avgDiskReads | Float | 计划在期间内的平均磁盘读次数 |
  | avgDiskWrites | Float | 计划在期间内的平均磁盘写次数 |
  | avgBufferGets | Float | 计划在期间内的平均缓存读次数 |
  | avgApplicationWaitTime | Float | 计划在期间内的平均 Application 类事件等待时间（毫秒） |
  | avgConcurrencyWaitTime | Float | 计划在期间内的平均 Concurrency 类事件等待时间（毫秒） |
  | avgUserIoWaitTime | Float | 计划在期间内的平均 UserIO 类事件等待时间（毫秒） |
  | avgRowProcessed | Float | 计划在期间内的平均处理行数 |
  | avgElapsedTime | Float | 计划在期间内的平均响应时间 |
  | avgCpuTime | Float | 计划在期间内的平均 CPU 时间 |
  | largeQueryPercentage | Float | 计划在期间内的大查询百分比 |
  | delayedLargeQueryPercentage | Float | 计划在期间内被置入队列的大查询的百分比 |
  | timeoutPercentage | Float | 计划在期间内执行超时的百分比 |
  | tableScan | Boolean | 计划是否包含全表扫描 |

## **示例**

**请求示例**

查询集群 Id 为 1，租户Id 为 1，SQL ID 为 "520A740747059F992A31CE41876BB161" 的所有物理执行计划，时间范围为 "2020-11-11T11:30:00+08:00" 至 "2020-11-11T12:00:00+08:00"。

```code
GET /api/v2/ob/clusters/1/tenants/1/sqls/520A740747059F992A31CE41876BB161/topPlan?startTime=2020-11-11T11%3A30%3A00%2B08%3A00&endTime=2020-11-11T12%3A00%3A00%2B08%3A00

```

 上一篇 下一篇 ![有帮助](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) 咨询热线
