DescribeSQLPlans - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the information about the SQL execution plans stored in the diagnostic system based on an SQL ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	The ID of the tenant.	t2mr3oae0****
SQLId	string	Yes	SQLID.	8D6E84**0B8FB1823D199E2CA1**

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
SQLPlans	object []	The information about the execution plan.
HitCount	integer	The number of hits.	3
OutlineData	string	The outline data.	/+ BEGIN_OUTLINE_DATA FULL(@\"SEL$1\" \"testdb1.bmsql_order_line\"@\"SEL$1\") END_OUTLINE_DATA/
AvgExecutionMS	float	The average execution duration, in ms.	1
PlanUnionHash	string	The unique identifier of the SQL execution plan in the diagnostic system.	859ef7ee**b23ac98cdeb2476f**
OutlineId	long	OutlineID.	-1
AvgExecutionTimeMS	long	The average execution duration when the database uses this execution plan, in ms.	288
PlanId	integer	The ID of the SQL execution plan in the database.	9114
OutlineTime	long	The time when the plan was bound.	1641492303000
OutlineTimeUTCString	string	The time when the plan was bound, in UTC +0.	2022-01-06T18:05:03Z
PlanFull	string	The complete execution plan of the SQL statement.	PHY_TABLE_SCAN \| bmsql_order_line \| 40 ******
NodeIp	string	The IP address of the node.	i-bp16niirq4zdmgvm****
MergedVersion	integer	The major compaction version.	132
QuerySQL	string	The query SQL statement.	SELECT ol_i_id, *, * FROM aaa
FirstLoadTimeUTCString	string	The time when the plan was loaded for the first time, in UTC +0.	2022-01-06T18:05:03Z
FirstLoadTime	long	The time when the plan was loaded for the first time, .	1641492303000
PlanInfo	string	The information about the plan.	PHY_TABLE_SCAN

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "SQLPlans": [
    {
      "HitCount": 3,
      "OutlineData": "/*+ BEGIN_OUTLINE_DATA FULL(@\\\"SEL$1\\\" \\\"testdb1.bmsql_order_line\\\"@\\\"SEL$1\\\") END_OUTLINE_DATA*/",
      "AvgExecutionMS": 1,
      "PlanUnionHash": "859ef7ee****b23ac98cdeb2476f****",
      "OutlineId": -1,
      "AvgExecutionTimeMS": 288,
      "PlanId": 9114,
      "OutlineTime": 1641492303000,
      "OutlineTimeUTCString": "2022-01-06T18:05:03Z",
      "PlanFull": "PHY_TABLE_SCAN | bmsql_order_line | 40 ******",
      "NodeIp": "i-bp16niirq4zdmgvm****",
      "MergedVersion": 132,
      "QuerySQL": "SELECT ol_i_id, ***, *** FROM aaa",
      "FirstLoadTimeUTCString": "2022-01-06T18:05:03Z",
      "FirstLoadTime": 1641492303000,
      "PlanInfo": "PHY_TABLE_SCAN"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
2014	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-01-17

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 2014
Output Parameters	The response structure of the API has changed.