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

ApsaraDB for OceanBase (Deprecated):DescribeOasSQLPlans

最終更新日:May 27, 2026

SQLID を指定して、診断システムから SQL 実行計画を取得します。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeOasSQLPlans

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

OceanBase クラスターの ID。

ob317v4uif****

TenantId

string

必須

テナントの ID。

t4louaeei****

StartTime

string

必須

SQL 実行計画を照会する時間範囲の開始時刻。

時刻は UTC であり、YYYY-MM-DDThh:mm:ssZ 形式である必要があります。

2023-04-12T04:38:38Z

EndTime

string

必須

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

2023-04-12T05:38:38Z

DbName

string

必須

データベースの名前。

test_db

SqlId

string

必須

SQL ID。

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

AcceptLanguage

string

任意

レスポンスの言語。有効な値:

  • zh-CN:中国語

  • en-US:英語

zh-CN

DynamicSql

boolean

任意

SQL ステートメントが動的 SQL であるかどうかを示します。

false

PlanUnionHash

string

任意

実行計画の一意の識別子。

c4e9aaa797428df9a5a41828********

ReturnBriefInfo

boolean

任意

実行計画の簡易情報を返すかどうかを示します。

true

FormatSqlId

string

任意

フォーマット済み SQL ID。

レスポンスフィールド

フィールド

説明

object

返されるデータ。

RequestId

string

リクエスト ID。

EE205C00-30E4-****-****-87E3A8A2AA0C

Data

array<object>

SQL 実行計画のリスト。

array<object>

SQL 実行計画。

PlanHash

string

診断システムでの SQL 実行計画の一意な識別子。

1758****24913166****

Plans

array<object>

実行計画のリスト。

object

実行計画の詳細。

Uid

string

プランの一意の識別子。

AAAAAAAAAAI****AAFoT2QAF--7W****

PlanId

integer

プラン ID。

590****

FirstLoadTime

string

実行計画の初回ロード時刻。

2023-04-12T04:46:38Z

PlanType

string

プランタイプ。有効な値:LOCALREMOTEDIST

LOCAL

PlanHash

string

診断システムでの SQL 実行計画の一意な識別子。

-86290582****886880

PlanSize

integer

プランサイズ。

10****

SchemaVersion

integer

スキーマバージョン。

16838****3550464

MergedVersion

integer

マージバージョン。

513

ObServerId

integer

サーバー ID。

2

ObDbId

integer

データベース ID。

11006****828

ServerId

integer

バックエンドサーバーのインスタンス ID。

2

FirstLoadTimeUs

integer

初回ロード時刻 (マイクロ秒)。

1684****03289441

HitDiagnosis

boolean

プランが診断をトリガーしたかどうか。

false

OutlineData

string

SQL 実行計画の outline_data フィールド。

/*+ BEGIN_OUTLINE_DATA INDEX(@\"SEL$1\

OutlineId

integer

アウトライン ID。

-1

CollectTimeUs

integer

収集時刻 (マイクロ秒)。

1684368****00000

Server

string

SQL ステートメントが実行されたサーバー。

i-bp1db1a9us038****jio

HitPercentage

number

ヒット率。

100.0

Executions

integer

指定された時間範囲内の総実行回数。

1

ExecPs

number

指定された時間範囲内の 1 秒あたりの平均実行回数。

0.31

AvgDiskReads

number

指定された時間範囲内の平均物理読み込み数。

0.0

AvgDiskWrites

number

指定された時間範囲内の平均物理書き込み数。

0.0

AvgBufferGets

number

指定された時間範囲内の平均バッファ取得数。

30137.03

AvgApplicationWaitTime

number

指定された時間範囲内の平均アプリケーション待機時間 (ミリ秒)。

0.0

AvgConcurrencyWaitTime

number

指定された時間範囲内の平均同時実行待機時間 (ミリ秒)。

0.0

AvgUserIoWaitTime

number

指定された時間範囲内の平均ユーザー I/O 待機時間 (ミリ秒)。

0.0

AvgRowProcessed

number

指定された時間範囲内の平均処理行数。

1.0

AvgElapsedTime

number

指定された時間範囲内の平均経過時間 (ミリ秒)。

1876.78

AvgCpuTime

number

指定された時間範囲内の平均 CPU 時間 (ミリ秒)。

1875.34

LargeQueryPercentage

number

長時間実行クエリの割合。

0.0

DelayedLargeQueryPercentage

number

遅延した長時間実行クエリの割合。

0.0

TimeoutPercentage

number

タイムアウト率。

0.0

TableScan

boolean

プランに全表スキャンが含まれるかどうか。

false

PlanUnionHash

string

類似した SQL 実行計画のグループの識別子。

"52c7c53****53e61b3f7586b17****ad"

SqlId

string

SQL ID。

46939C87ECA****95ED0FF64F44B****

SqlText

string

SQL ステートメントのテキスト。

MergedVersion

integer

マージバージョン。

513

FirstLoadTime

string

初回ロード時刻。

2023-04-12T04:46:38Z

PlanType

string

プランタイプ。有効な値:LOCALREMOTEDIST

LOCAL

HitDiagnosis

boolean

プランが診断をトリガーしたかどうか。

false

HitPercentage

number

ヒット率。

100.0

AvgCpuTime

number

指定された時間範囲内の平均 CPU 時間 (ミリ秒)。

1875.34

PlanExplain

object

実行計画。

PlanJsonString

string

SQL 実行計画の JSON 文字列。

"PlanJsonString":"{\"RootOperations\":[{\"Children\":[{\"Children\":[{\"Cost\":2000,\"ObjectName\":\"TR\",\"Operator\":\"PHY_TABLE_SCAN\",\"Property\":\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\",\"Rows\":86},{\"Children\":[{\"Cost\":2000,\"ObjectName\":\"NA\",\"Operator\":\"PHY_TABLE_SCAN\",\"Property\":\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\",\"Rows\":18}],\"Cost\":2013,\"ObjectName\":\"NULL\",\"Operator\":\"PHY_SORT\",\"Property\":\"NULL\",\"Rows\":18}],\"Cost\":4024,\"ObjectName\":\"NULL\",\"Operator\":\"PHY_MERGE_JOIN\",\"Property\":\"NULL\",\"Rows\":26}],\"Cost\":4025,\"ObjectName\":\"NULL\",\"Operator\":\"PHY_SCALAR_AGGREGATE\",\"Property\":\"NULL\",\"Rows\":1}]}"

Executions

integer

指定された時間範囲内の総実行回数。

1

PlanUnionHash

string

類似した SQL 実行計画のグループの識別子。

"52c7c53****53e61b3f7586b17****ad"

QuerySql

string

クエリ文。

説明

このパラメーターは使用されません。常に空です。

"select 1 from t"

Bounded

boolean

この実行計画で実行計画バインドが有効になっているかどうか。

false

TableScan

boolean

プランに全表スキャンが含まれるかどうか。

false

OutlineId

string

プランが使用するアウトライン ID。

3********

OutlineStatus

string

プランが使用するアウトラインのステータス。Effective は、プランの outline_data がアウトラインの outline_content と完全に一致することを意味します。Unknown は、ステータスを判断できないことを意味します。

已生效

ByFormatSqlId

boolean

ファジーバインドが有効になっているかどうか。

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "PlanHash": "1758****24913166****",
      "Plans": [
        {
          "Uid": "AAAAAAAAAAI****AAFoT2QAF--7W****",
          "PlanId": 0,
          "FirstLoadTime": "2023-04-12T04:46:38Z",
          "PlanType": "LOCAL",
          "PlanHash": "-86290582****886880",
          "PlanSize": 0,
          "SchemaVersion": 0,
          "MergedVersion": 513,
          "ObServerId": 2,
          "ObDbId": 0,
          "ServerId": 2,
          "FirstLoadTimeUs": 0,
          "HitDiagnosis": false,
          "OutlineData": "/*+ BEGIN_OUTLINE_DATA INDEX(@\\\"SEL$1\\",
          "OutlineId": -1,
          "CollectTimeUs": 0,
          "Server": "i-bp1db1a9us038****jio",
          "HitPercentage": 100,
          "Executions": 1,
          "ExecPs": 0.31,
          "AvgDiskReads": 0,
          "AvgDiskWrites": 0,
          "AvgBufferGets": 30137.03,
          "AvgApplicationWaitTime": 0,
          "AvgConcurrencyWaitTime": 0,
          "AvgUserIoWaitTime": 0,
          "AvgRowProcessed": 1,
          "AvgElapsedTime": 1876.78,
          "AvgCpuTime": 1875.34,
          "LargeQueryPercentage": 0,
          "DelayedLargeQueryPercentage": 0,
          "TimeoutPercentage": 0,
          "TableScan": false,
          "PlanUnionHash": "\"52c7c53****53e61b3f7586b17****ad\"",
          "SqlId": "46939C87ECA****95ED0FF64F44B****",
          "SqlText": ""
        }
      ],
      "MergedVersion": 513,
      "FirstLoadTime": "2023-04-12T04:46:38Z",
      "PlanType": "LOCAL",
      "HitDiagnosis": false,
      "HitPercentage": 100,
      "AvgCpuTime": 1875.34,
      "PlanExplain": {
        "PlanJsonString": "\"PlanJsonString\":\"{\\\"RootOperations\\\":[{\\\"Children\\\":[{\\\"Children\\\":[{\\\"Cost\\\":2000,\\\"ObjectName\\\":\\\"TR\\\",\\\"Operator\\\":\\\"PHY_TABLE_SCAN\\\",\\\"Property\\\":\\\"table_rows:8593, physical_range_rows:85, logical_range_rows:85, index_back_rows:0, output_rows:85, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\",\\\"Rows\\\":86},{\\\"Children\\\":[{\\\"Cost\\\":2000,\\\"ObjectName\\\":\\\"NA\\\",\\\"Operator\\\":\\\"PHY_TABLE_SCAN\\\",\\\"Property\\\":\\\"table_rows:1750, physical_range_rows:17, logical_range_rows:17, index_back_rows:0, output_rows:17, est_method:default_stat, avaiable_index_name[ALL_VIRTUAL_AGENT]\\\",\\\"Rows\\\":18}],\\\"Cost\\\":2013,\\\"ObjectName\\\":\\\"NULL\\\",\\\"Operator\\\":\\\"PHY_SORT\\\",\\\"Property\\\":\\\"NULL\\\",\\\"Rows\\\":18}],\\\"Cost\\\":4024,\\\"ObjectName\\\":\\\"NULL\\\",\\\"Operator\\\":\\\"PHY_MERGE_JOIN\\\",\\\"Property\\\":\\\"NULL\\\",\\\"Rows\\\":26}],\\\"Cost\\\":4025,\\\"ObjectName\\\":\\\"NULL\\\",\\\"Operator\\\":\\\"PHY_SCALAR_AGGREGATE\\\",\\\"Property\\\":\\\"NULL\\\",\\\"Rows\\\":1}]}\""
      },
      "Executions": 1,
      "PlanUnionHash": "\"52c7c53****53e61b3f7586b17****ad\"",
      "QuerySql": "\"select 1 from t\"",
      "Bounded": false,
      "TableScan": false,
      "OutlineId": "3********",
      "OutlineStatus": "已生效",
      "ByFormatSqlId": false
    }
  ]
}

エラーコード

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

変更履歴

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