帮你快速理解、总结文档立即下载

查询 SQL 执行计划V2

最近更新时间:2026-11-11 01:47:00
我的收藏

1. 接口描述

接口请求域名: dbbrain.tencentcloudapi.com 。

查询指定 SELECT SQL 在实例上的执行计划,常用于慢 SQL 分析、SQL 优化等场景。仅支持 SELECT 类语句

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeSqlExplainV2。
Version 是 String 公共参数,本接口取值:2021-05-27。
Region 是 String 公共参数,详见产品支持的 地域列表。
Product 是 String

服务产品类型。取值:mysql(云数据库 MySQL)、cynosdb(TDSQL-C MySQL 版)、dcdb(TDSQL MySQL 版)、mariadb(TDSQL MariaDB 版)。


示例值:mysql
SqlText 是 String

待分析的 SQL 语句。仅支持单条 SELECT 语句;若以 EXPLAIN 开头会自动剥离 EXPLAIN 前缀后分析。最大 4096 字符。


示例值:select * from tao_test.example_table LIMIT 1;
InstanceId 否 String

实例 ID。MySQL: cdb-xxxxxxx,TDSQL-C: cynosdbmysql-ins-xxxxxxx,MariaDB: tdsql-xxxxx,TDSQL-MySQL: '集群id&分片id',如果TDSQL-MySQL数据库类型同时传入了集群id则instanceId字段只需要传入分片id。最大 64 字符。与 ClusterId 至少需传入其一。


示例值:cdb-30p95ond
Schema 否 String

数据库名。可选;为空时按当前 SQL 上下文执行。最大 64 字符。


示例值:name
ClusterId 否 String

集群 ID。仅 TDSQL-MySQL时使用,与 InstanceId 至少需传入其一。最大 64 字符。


示例值:tdsqlshard-xxxxxxx
Visual 否 Boolean

是否输出可视化执行树

默认值:false


示例值:true

3. 输出参数

参数名称 类型 描述
Schema String

数据库名,回显请求中的 Schema。


示例值:name
SqlText String

SQL 文本,回显请求中的 SqlText。


示例值:select * from tao_test.example_table LIMIT 1;
Tables Array of SqlExplainTableRefV2

SQL 涉及的表名列表。

Explain SqlExplainResultV2

执行计划详细信息。由数据库 EXPLAIN 输出透传,内容为 JSON 字符串,包含 Meta(列定义)与 Data(执行计划行)两部分;Format=JSON 时为 EXPLAIN FORMAT=JSON 的原始结果。

FieldDesc Array of SqlExplainFieldDescV2

执行计划字段说明列表。仅当请求 Visual=true 或走 SqlTemplateKey 路径时返回,用于前端展示字段中文释义。

VisualExplain String

可视化执行计划树,当Visual=true时返回


示例值:{ }
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询执行计划V2

输入示例

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSqlExplainV2
<公共请求参数>

{
    "Product": "mysql",
    "SqlText": "select * from tao_test.example_table LIMIT 1;",
    "InstanceId": "cdb-30p95ond",
    "Visual": true
}

输出示例

{
    "Response": {
        "Explain": {
            "Data": [
                {}
            ],
            "Names": [
                "id"
            ]
        },
        "FieldDesc": [
            {
                "Desc": "表名",
                "Field": "table_name"
            }
        ],
        "Schema": "",
        "SqlText": "select * from tao_test.example_table LIMIT 1;",
        "Tables": [
            {
                "TableName": "example_table",
                "TableSchema": "tao_test"
            }
        ],
        "VisualExplain": "",
        "RequestId": "eeb978d7-7a58-4a1c-a22e-2a018c05424c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RegionError 地域错误
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。