機能の概要
指定されたSQLステートメントのアウトラインバインディング情報を照会するために使用されます。アウトラインバインディングはSQLの実行計画を固定するために使用されます。このインターフェースでは、バインドされた実行計画、アウトラインID、同時実行制限などの詳細情報を照会できます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/outline
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
| sqlId | String | はい | SQLステートメントの一意の識別子 | sql_123456789 |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
| tableName | String | いいえ | テーブル名パラメータ | なし |
| dbName | String | いいえ | データベース名 | なし |
| isConcurrentLimit | Boolean | いいえ | Is concurrent limitパラメータ | なし |
| dynamicSql | Boolean | いいえ | Dynamic sqlパラメータ | なし |
| formatSqlId | String | いいえ | Format sql idパラメータ | なし |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | Object | アウトラインのバインディング情報 |
| dbindPlan | String | バインド計画 |
| outlineId | String | アウトラインID |
| bindIndex | Integer | バインドインデックス |
| maxConcurrent | Integer | 最大同時実行数 |
| tableName | String | テーブル名 |
| requestId | String | リクエストID |
| success | Boolean | リクエストが成功したかどうか |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/outline?requestId={requestId}' \
-G \
-d 'dbName={dbName}' \
-d 'tableName={tableName}' \
-d 'isConcurrentLimit={isConcurrentLimit}' \
-d 'dynamicSql={dynamicSql}' \
-d 'formatSqlId={formatSqlId}'
レスポンス例
JSON形式
{
"data": {
"outlineId": "5******",
"bindIndex": "idx_name_8_1********",
"tableName": "plan_keep_******"
},
"requestId": "d87cedc5-b214-490b-b9c9-fccdb7160218",
"success": true
}