Querying SQL Execution Plan Information

Function

This API is used to query SQL execution plan information of wait events. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Request query parameters
Parameter	Mandatory	Type	Description
pid	Yes	String	Definition Thread ID. Constraints N/A Range N/A Default Value N/A
node_id	Yes	String	Definition Node ID. Constraints N/A Range N/A Default Value N/A
comp_id	No	String	Definition ID of a component on a node. Only CN components are supported in distributed deployment model. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 4** Response body parameters
Parameter	Type	Description
gs_explain	String	Definition Execution plan information. Range N/A

Example Request

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