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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeOutlineBinding	get	All Resources ``	none	none

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	View Change Details
2023-05-17	The Error code has changed. The response structure of the API has changed	View Change Details