すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for OceanBase (Deprecated):CreateOasOutlineTask

最終更新日:May 26, 2026

この API を呼び出して、アウトラインバインドタスクを開始できます。

操作説明

アウトラインのバインドは非同期で実行されます。バインド結果は、DescribeOutlineBinding API を呼び出して照会できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

ApsaraDB for OceanBase クラスターの ID。

ob317v4uif****

TenantId

string

必須

テナントの ID。

ob2mr3oae0****

SqlText

string

必須

SQL テキスト。
BySqlIdfalse の場合、このパラメーターは必須です。

SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC

DatabaseName

string

必須

データベースの名前。

test_data

TableName

string

任意

テーブルの名前。

test_1

SqlId

string

任意

SQL ステートメントの ID。
BySqlIdtrue (デフォルト) の場合、このパラメーターは必須です。

8D6E84****0B8FB1823D199E2CA1****

IsConcurrentLimit

boolean

任意

  • 値を True に設定すると、SQL ID に基づいてデータベース内のスロットリング情報が照会されます。

  • 値を False に設定すると、SQL ID に基づいてデータベース内のバインドされたインデックスまたは実行計画が照会されます。

true

DynamicSql

boolean

任意

指定された SQL ステートメントが動的 SQL ステートメントであるかどうかを指定します。

説明

このパラメーターは、SqlId パラメーターの値が動的 SQL ステートメントの ID であるかどうかを指定します。

false

UId

string

任意

OceanBase データベースのユーザー識別子 (UID)。

139*************

PlanData

string

任意

実行計画。

********

IndexName

string

任意

インデックスの名前。

idx_a

MaxConcurrent

integer

任意

一度に開始できるアウトラインバインドタスクの最大数。

2

StartTime

string

任意

TOPSQL パラメーターを照会する開始時刻。
値は YYYY-MM-DDThh:mm:ssZ 形式の UTC 時刻である必要があります。

2025-05-13T15:40:43Z

EndTime

string

任意

SQL 実行計画を照会する終了時刻。
値は YYYY-MM-DDThh:mm:ssZ 形式の UTC 時刻である必要があります。

2025-05-13T16:40:43Z

StatementId

string

任意

SQL テンプレートの ID。

********

BySqlId

boolean

任意

SQL を識別する方法を指定します。デフォルト値は true です。

true

  • スロットリングを開始する場合:IsConcurrentLimit および MaxConcurrent は必須です。

  • インデックスをバインドする場合:TableName および IndexName は必須です。

  • 実行計画をバインドする場合:PlanData は必須です。

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ

RequestId

string

リクエスト ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Success

boolean

呼び出しが成功したかどうかを示します。

true

Message

string

エラーの説明。

successful

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Success": true,
  "Message": "successful"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。