DescribeOutlineBinding-阿里云帮助中心

Queries the bound Outline or throttling information for a SQL statement by its SQL ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeOutlineBinding

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	The tenant ID.	t2mr3oae0****
TableName	string	Yes	The tenant name. Note: Although this parameter is named TableName, it specifies the tenant name. The name must be 2–20 characters long, consist of letters, digits, and underscores (_), be case-sensitive, start with a letter or an underscore, and not be the reserved word sys.	pay_online
DatabaseName	string	Yes	The database name.	testdb
SQLId	string	Yes	The SQL ID.	8D6E84**0B8FB1823D199E2CA1**
IsConcurrentLimit	boolean	No	Set to `true` to query the throttling information. Set to `false` to query the bound index or bound execution plan.	false
InstanceId	string	No	The OceanBase instance ID.	ob317v4uif****
DynamicSql	boolean	No	Indicates whether the SQL is a template SQL.
FormatSqlId	string	No	The ID of the formatted SQL statement.

Response elements

Element	Type	Description	Example
	object	The data returned.
OutlineBinding	object	Details of the Outline binding.
BindPlan	string	The bound execution plan.	PHY_TABLE_SCAN \| bmsql_order_line \| 40 ******
OutlineId	integer	The Outline ID.	-1
BindIndex	string	The bound index.	PRIMARY
MaxConcurrent	integer	The maximum number of concurrent executions.	2
TableName	string	The table name.	cluster_info
SqlText	string	The SQL text used for throttling.
SqlTextConcurrentNum	integer	The concurrency limit for the SQL text.
ByFormatSqlId	boolean	Indicates whether the binding is a fuzzy binding.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.