文档首页/云数据库 GaussDB/API参考/API（推荐）/会话管理/查询SQL执行计划信息 - QueryingSQLExecutionPlanInformation
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

查询SQL执行计划信息 - QueryingSQLExecutionPlanInformation

功能介绍

查询等待事件的SQL执行计划信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/slow-sql/optimization/plan

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

表2 请求Query参数

名称

是否必选

参数类型

说明

pid

是

String

参数解释：

线程ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

node_id

是

String

参数解释：

节点ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

comp_id

否

String

参数解释：

节点上的组件ID，分布式只支持下发CN组件。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表4 响应Body参数

参数

参数类型

描述

gs_explain

String

参数解释：

执行计划信息。

取值范围：

不涉及。

请求示例

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/slow-sql/optimization/plan?pid=139898020947520&node_id=7bae4d3eedb840da95545569bd662d5ano14&comp_id=dn_6001

响应示例

{
    "gs_explain": ""
}

状态码

错误码

请参见错误码。

父主题：会话管理