DescribeOutlineBinding - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the outline binding information or throttling information of an SQL statement in the database based on an SQLID.

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****
TableName	string	Yes	The name of the tenant. It must start with a letter or an underscore (), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (). It cannot be set to SYS.	pay_online
DatabaseName	string	Yes	The name of the database.	testdb
SQLId	string	Yes	SQLID.	8D6E84**0B8FB1823D199E2CA1**
IsConcurrentLimit	boolean	No	When the value is set to True, the throttling information in the database is queried based on the SQL ID. When the value is set to False, the bound index or execution plan in the database is queried based on the SQL ID.	false
InstanceId	string	No	The ID of the OceanBase cluster.	ob317v4uif****

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
OutlineBinding	object	The binding information.
BindPlan	string	The bound plan.	PHY_TABLE_SCAN \| bmsql_order_line \| 40 ******
OutlineId	long	OutlineID.	-1
BindIndex	string	The bound index.	PRIMARY
MaxConcurrent	integer	The maximum number of concurrent tasks.	2
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Examples

Sample success responses

JSONformat

{
  "OutlineBinding": {
    "BindPlan": "PHY_TABLE_SCAN | bmsql_order_line | 40 ******",
    "OutlineId": -1,
    "BindIndex": "PRIMARY",
    "MaxConcurrent": 2,
    "TableName": ""
  },
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

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

2024-04-15

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 2014

2023-05-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.