すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeSQLPlan

    ドキュメントセンター

    AnalyticDB:DescribeSQLPlan

    最終更新日:Feb 26, 2026

    クエリ文や抽出・変換・ロード（ETL）タスク文などの 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeSQLPlan

    get

    DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID です。

    説明

    DescribeDBClusters 操作を呼び出して、リージョン内の AnalyticDB for MySQL クラスターの情報をすべて照会できます。クラスター ID も含まれます。

    am-****************
    ProcessId

    string

    必須

    クエリ ID です。

    説明

    DescribeProcessList 操作を呼び出して、現在実行中のクエリの ID を照会できます。

    202105271604431720161662490345*******

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    RequestId

    string

    リクエスト ID です。

    22D6DEF0-CBC7-4388-A41C-D5FD62******
    StageList

    array<object>

    各ステージにおける照会された実行計画です。

    object

    State

    string

    ステージの最終的な実行状態です。有効な値は次のとおりです。

    • FINISHED

    • CANCELED

    • ABORTED

    • FAILED

    FINISHED
    CPUTimeAvg

    integer

    ステージ内の各コンピュートノードにおける平均 CPU 時間 値です。単位：ミリ秒。

    5984
    CPUTimeMax

    integer

    ステージ内の各コンピュートノードにおける最大 CPU 時間 値です。単位：ミリ秒。

    5984
    OperatorCost

    integer

    ステージ内のすべてのオペレーターが消費した合計 CPU 時間で、ステージ全体の合計 CPU 時間に相当します。このパラメーターを使用して、ステージのどの部分が大量のコンピューティングリソースを消費しているかを判断できます。単位：ミリ秒。

    5984
    ScanTimeMax

    integer

    ステージ内の各ストレージノードにおいて、スキャンオペレーターがデータを読み取るのに要した最大時間です。単位：ミリ秒。

    0
    InputSizeMax

    integer

    ステージ内の各コンピュートノードにおける最大入力データ量です。単位：バイト。

    173
    StageId

    integer

    ステージ ID です。

    1
    ScanSizeMax

    integer

    ステージ内の各ストレージノードにおいて、スキャンオペレーターがスキャンした最大データ量です。単位：バイト。

    0
    CPUTimeMin

    integer

    ステージ内の各コンピュートノードにおける最小 CPU 時間 値です。単位：ミリ秒。

    47
    ScanTimeMin

    integer

    ステージ内の各ストレージノードにおいて、スキャンオペレーターがデータを読み取るのに要した最小時間です。単位：ミリ秒。

    0
    ScanSizeMin

    integer

    ステージ内の各ストレージノードにおいて、スキャンオペレーターがスキャンした最小データ量です。単位：バイト。

    0
    InputSizeMin

    integer

    ステージ内の各コンピュートノードにおける最小入力データ量です。単位：バイト。

    173
    PeakMemory

    integer

    SQL 文の実行時の最大メモリ使用量です。単位：バイト。

    74208
    ScanTimeAvg

    integer

    ステージ内の各ストレージノードにおいて、スキャンオペレーターがデータを読み取るのに要した平均時間です。単位：ミリ秒。

    0
    ScanSizeAvg

    integer

    ステージ内の各ストレージノードにおいて、スキャンオペレーターがスキャンした平均データ量です。単位：バイト。

    0
    InputSizeAvg

    integer

    ステージ内の各コンピュートノードにおける平均入力データ量です。単位：バイト。

    173
    OriginInfo

    string

    SQL 文に関する元の情報です。

    {\"queryId\":\"20210527_160443_10581_hdhzr\",\"session\":{\"queryId\":\"20210527_160443_10581_hdhzr\",\"hasSharedStage\":false,\"parentId\":0}}
    Detail

    object

    SQL 文の実行情報です。

    SQL

    string

    SQL 文です。

    INSERT OVERWRITE INTO hdfs_import_external\nSELECT *\nFROM adb_hdfs_import_source
    OutputSize

    integer

    SQL 文によって生成されたデータの総量です。単位：バイト。

    9
    State

    string

    SQL 文の最終的な実行状態です。有効な値は次のとおりです。

    • FINISHED

    • FAILED

    FINISHED
    OutputRows

    integer

    SQL 文によって生成された行の総数です。

    1
    User

    string

    SQL 文を送信したユーザーの名前です。

    test_acc
    StartTime

    string

    SQL 文の実行開始時刻です。この値は UNIX タイムスタンプで、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表します。

    1622102683243
    TotalStage

    integer

    SQL 文に含まれるステージの総数です。

    4
    QueuedTime

    integer

    SQL 文をキューに入れるのに要した時間です。単位：ミリ秒。

    0
    TotalTime

    integer

    SQL 文を実行するのに要した合計時間です。単位：ミリ秒。

    2340
    TotalTask

    integer

    SQL 文に含まれるタスクの総数です。

    4
    Database

    string

    SQL 文が実行されたデータベースの名前です。

    adb_demo
    PeakMemory

    integer

    SQL 文の実行時の最大メモリ使用量です。単位：バイト。

    441802
    ClientIP

    string

    SQL 文を実行するために使用されたクライアントの IP アドレスです。

    172.16.***.***
    PlanningTime

    integer

    SQL 文の実行計画を生成するのに要した時間です。単位：ミリ秒。

    86
    CPUTime

    integer

    SQL 文の実行時にマルチスレッドサーバー上のすべてのオペレーターが消費した合計 CPU 時間です。単位：ミリ秒。

    6100

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "22D6DEF0-CBC7-4388-A41C-D5FD62******",
  "StageList": [
    {
      "State": "FINISHED",
      "CPUTimeAvg": 5984,
      "CPUTimeMax": 5984,
      "OperatorCost": 5984,
      "ScanTimeMax": 0,
      "InputSizeMax": 173,
      "StageId": 1,
      "ScanSizeMax": 0,
      "CPUTimeMin": 47,
      "ScanTimeMin": 0,
      "ScanSizeMin": 0,
      "InputSizeMin": 173,
      "PeakMemory": 74208,
      "ScanTimeAvg": 0,
      "ScanSizeAvg": 0,
      "InputSizeAvg": 173
    }
  ],
  "OriginInfo": "{\\\"queryId\\\":\\\"20210527_160443_10581_hdhzr\\\",\\\"session\\\":{\\\"queryId\\\":\\\"20210527_160443_10581_hdhzr\\\",\\\"hasSharedStage\\\":false,\\\"parentId\\\":0}}",
  "Detail": {
    "SQL": "INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source",
    "OutputSize": 9,
    "State": "FINISHED",
    "OutputRows": 1,
    "User": "test_acc",
    "StartTime": "1622102683243",
    "TotalStage": 4,
    "QueuedTime": 0,
    "TotalTime": 2340,
    "TotalTask": 4,
    "Database": "adb_demo",
    "PeakMemory": 441802,
    "ClientIP": "172.16.***.***",
    "PlanningTime": 86,
    "CPUTime": 6100
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

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

    変更履歴

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