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

ApsaraDB for OceanBase (Deprecated):DescribeSQLTuningAdvices

最終更新日:May 26, 2026

この オペレーション を呼び出すと、インデックス作成と実行計画のバインドのための 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:DescribeSQLTuningAdvices

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

OceanBase クラスターのID。

obsdf43****

TenantId

string

必須

テナントのID。

tsdc2s2****

DbName

string

必須

データベース名。

testdb

SqlId

string

必須

SQL ステートメントのID。

123456

StartTime

string

必須

開始時刻。

2023-04-12T04:38:38Z

EndTime

string

必須

終了時刻。

2023-04-12T05:38:38Z

AcceptLanguage

string

任意

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

  • zh-CN

  • en-US

zh-CN

レスポンスフィールド

フィールド

説明

object

リクエストの結果です。

RequestId

string

リクエストの ID です。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Data

array<object>

返されたデータです。

array<object>

SQL ステートメントの実行計画に関する情報です。

Type

string

最適化タイプです。有効な値は PLAN_BINDING および INDEX_CREATION です。

PLAN_BINDING/INDEX_CREATION

ColumnNames

string

インデックス列の順序です。

c1;c2;c3

LocalityType

string

インデックスのタイプです。有効な値は Local および Global です。

Local/Global

Columns

array<object>

インデックス列のリストです。

object

インデックス列に関する情報です。

ColumnName

string

列の名前です。

xxxx

Ndv

number

列の NDV です。

100

MinValue

string

列の最小値です。

1

MaxValue

string

列の最大値です。

100

DbName

string

データベースの名前です。

test_db

Table

string

テーブルの名前です。

test_table

Plan

object

実行計画です。

Executions

integer

指定期間内の総実行回数です。

2062

AvgCpuTime

number

指定期間内の平均 CPU 時間です。単位:ミリ秒。

100.36

PlanHash

string

診断システムにおける実行計画の一意の識別子です。

-86290582****886880

TimeoutPercentage

number

タイムアウトエラーが発生した実行の割合です。

0

AvgConcurrencyWaitTime

number

指定期間内に Concurrency 待機イベントに費やされた平均時間です。単位:ミリ秒。

0

FirstLoadTimeUs

integer

実行計画が初めてロードされた時刻 (マイクロ秒単位) です。

1672367130576163

AvgDiskWrites

number

指定期間内の平均物理書き込み数です。

0

AvgUserIoWaitTime

number

指定期間内に UserIo 待機イベントに費やされた平均時間です。単位:ミリ秒。

0

PlanSize

integer

実行計画のサイズです。

49216

ServerSn

string

ノードの ID です。

i-bp1*****sw64dhb*****

OutlineData

string

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

xxxxx

PlanType

string

実行計画のタイプです。有効な値は LOCALREMOTEDIST です。

LOCAL

ObDbId

integer

データベースの ID です。

1108307720799259

HitPercentage

number

ヒット率です。

66.8

AvgBufferGets

number

指定期間内の平均キャッシュ読み取り数です。

0

ExecPs

number

指定期間内の1秒あたりの平均実行回数です。

1.45

DelayedLargeQueryPercentage

number

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

0

TableScan

boolean

フルテーブルスキャンが実行されるかどうかを示します。

false

LargeQueryPercentage

number

完了した実行時間の長いクエリの割合です。

0

SchemaVersion

integer

スキーマのバージョンです。

1672367130529680

PlanId

integer

実行計画の ID です。

818

FirstLoadTime

string

実行計画が初めてロードされた時刻です。

2022-12-30T02:25:30.576Z

AvgRowProcessed

number

指定期間内の平均処理行数です。

1

MergedVersion

integer

メジャーコンパクションのバージョンです。

3

HitDiagnosis

boolean

診断がヒットしたかどうかを示します。

false

Uid

string

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

AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj

AvgApplicationWaitTime

number

指定期間内に Application 待機イベントに費やされた平均時間です。単位:ミリ秒。

0

CollectTimeUs

integer

データが収集された時刻 (マイクロ秒単位) です。

1672358400000000

AvgElapsedTime

number

指定期間内の平均経過時間です。単位:ミリ秒。

713.62

ObServerId

integer

サーバーの ID です。

1

OutlineId

integer

アウトラインの ID です。

1

AvgDiskReads

number

指定期間内の平均物理読み取り数です。

0

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": [
    {
      "Type": "PLAN_BINDING/INDEX_CREATION",
      "ColumnNames": "c1;c2;c3",
      "LocalityType": "Local/Global",
      "Columns": [
        {
          "ColumnName": "xxxx",
          "Ndv": 100,
          "MinValue": "1",
          "MaxValue": "100"
        }
      ],
      "DbName": "test_db",
      "Table": "test_table",
      "Plan": {
        "Executions": 2062,
        "AvgCpuTime": 100.36,
        "PlanHash": "-86290582****886880",
        "TimeoutPercentage": 0,
        "AvgConcurrencyWaitTime": 0,
        "FirstLoadTimeUs": 1672367130576163,
        "AvgDiskWrites": 0,
        "AvgUserIoWaitTime": 0,
        "PlanSize": 49216,
        "ServerSn": "i-bp1*****sw64dhb*****",
        "OutlineData": "xxxxx",
        "PlanType": "LOCAL",
        "ObDbId": 1108307720799259,
        "HitPercentage": 66.8,
        "AvgBufferGets": 0,
        "ExecPs": 1.45,
        "DelayedLargeQueryPercentage": 0,
        "TableScan": false,
        "LargeQueryPercentage": 0,
        "SchemaVersion": 1672367130529680,
        "PlanId": 818,
        "FirstLoadTime": "2022-12-30T02:25:30.576Z",
        "AvgRowProcessed": 1,
        "MergedVersion": 3,
        "HitDiagnosis": false,
        "Uid": "AAAAAAAAAAEAAAAAAAADMgAF8QJQwIUj",
        "AvgApplicationWaitTime": 0,
        "CollectTimeUs": 1672358400000000,
        "AvgElapsedTime": 713.62,
        "ObServerId": 1,
        "OutlineId": 1,
        "AvgDiskReads": 0
      }
    }
  ]
}

エラーコード

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

変更履歴

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