Overview
You can call this API to query SQL outline binding information.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/outline
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. |
| tenantId | String | Yes | The ID of the tenant. |
| sqlId | String | Yes | The ID of the SQL statement. |
Query
| Parameter | Type | Required | Description |
|---|---|---|---|
| dbName | String | No | The name of the database. |
| tableName | String | No | The name of the table. |
| isConcurrentLimit | Boolean | No | Specifies whether to enable the concurrency limit. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | The outline binding data. |
| dbindPlan | String | The binding plan. |
| outlineId | String | The ID of the outline. |
| bindIndex | Integer | The binding index. |
| maxConcurrent | Integer | The maximum number of concurrent connections. |
| tableName | String | The name of the table. |
| requestId | String | The ID of the request. |
| success | Boolean | Indicates whether the request was successful. |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/outline' \
-G -d 'dbName=testdb' \
-d 'tableName=testtable' \
-d 'isConcurrentLimit=false'
Response example
JSON format
{
"data": {
"outlineId": 5******,
"bindIndex": "idx_name_8_1********",
"tableName": "plan_keep_******"
},
"requestId": "d87cedc5-b214-490b-b9c9-fccdb7160218",
"success": true
}