すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribePatternPerformance

    ドキュメントセンター

    AnalyticDB:DescribePatternPerformance

    最終更新日:Apr 15, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribePatternPerformance

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、リージョン内のすべてのクラスターの詳細 (クラスター ID を含む) を照会できます。

    amv-uf6li1r3do8m****
    StartTime

    string

    任意

    照会する時間範囲の開始時刻。yyyy-MM-ddTHH:mm:ssZ 形式で協定世界時 (UTC) を指定します。

    説明

    • 過去 14 日間のデータを照会できます。この期間より前の開始時刻を指定すると、空の値が返されます。たとえば、現在の日付が 2022 年 8 月 22 日 (中国標準時) の場合、有効な最も早い開始時刻は 2022-08-08T16:00:00Z です。

    • 開始時刻と終了時刻の間隔は 24 時間を超えることはできません。

    2022-08-21T02:15:00Z
    EndTime

    string

    任意

    照会する時間範囲の終了時刻。yyyy-MM-ddTHH:mm:ssZ 形式で協定世界時 (UTC) を指定します。

    説明

    終了時刻は開始時刻より後である必要があります。

    2022-08-22T01:06:00Z
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    PatternId

    string

    任意

    SQL パターン ID。

    説明

    DescribeSQLPatterns 操作を呼び出して、指定された時間範囲内のクラスター内のすべての SQL パターンに関する情報 (各 SQL パターンの ID を含む) を照会できます。

    3847585356974******

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    EndTime

    string

    クエリ時間範囲の終了時刻。時刻は協定世界時 (UTC) で、yyyy-MM-ddTHH:mmZ 形式です。

    2022-08-22T01:06:00Z
    RequestId

    string

    リクエスト ID。

    F21AF487-B8C9-57E0-8E3A-A92BC3611FB6
    StartTime

    string

    クエリ時間範囲の開始時刻。時刻は協定世界時 (UTC) で、yyyy-MM-ddTHH:mmZ 形式です。

    2022-08-21T02:15:00Z
    Performances

    array<object>

    パフォーマンスメトリック。

    array<object>

    パフォーマンスメトリックの詳細。

    Key

    string

    パフォーマンスメトリック。有効な値：

    • AnalyticDB_PatternQueryCount：SQL パターンに一致するクエリの総数。

    • AnalyticDB_PatternQueryTime：SQL パターンに一致するクエリの合計時間。

    • AnalyticDB_PatternExecutionTime：SQL パターンに一致するクエリの合計実行時間。

    • AnalyticDB_PatternPeakMemory：SQL パターンに一致するクエリのピークメモリ使用量。

    • AnalyticDB_PatternScanSize：SQL パターンに一致するクエリの合計データスキャンサイズ。

    AnalyticDB_PatternExecutionTime
    Unit

    string

    パフォーマンスメトリックの単位。返される単位は Key の値によって異なります：

    • Key が AnalyticDB_PatternQueryTime または AnalyticDB_PatternExecutionTime の場合、単位は ms です。

    • Key が AnalyticDB_PatternPeakMemory の場合、単位は MB です。

    • Key が AnalyticDB_PatternScanSize の場合、単位は MB です。

    • Key が AnalyticDB_PatternQueryCount の場合、このパラメーターは空です。

    ms
    Series

    array<object>

    パフォーマンスメトリックの時系列データ。

    object

    特定のパフォーマンス値の時系列。

    Values

    array

    パフォーマンス値のリスト。

    string

    タイムスタンプとそれに対応するパフォーマンス値を含む配列であるデータポイント。

    [ "2021-11-18 13:38:00", "224" ]
    Name

    string

    パフォーマンス値の名前。このパラメーターの値は Key の値によって異なります：

    • Key が AnalyticDB_PatternQueryCount の場合、このパラメーターは SQL パターンのクエリ数を示す pattern_query_count を返します。

    • Key が AnalyticDB_PatternQueryTime の場合、このパラメーターは次のいずれかの値になります：

      • average_query_time：SQL パターンに一致するクエリの平均合計時間。

      • max_query_time：SQL パターンに一致するクエリの最大合計時間。

    • Key が AnalyticDB_PatternExecutionTime の場合、このパラメーターは次のいずれかの値になります：

      • average_execution_time：SQL パターンに一致するクエリの平均実行時間。

      • max_execution_time：SQL パターンに一致するクエリの最大実行時間。

    • Key が AnalyticDB_PatternPeakMemory の場合、このパラメーターは次のいずれかの値になります：

      • average_peak_memory：SQL パターンに一致するクエリの平均ピークメモリ使用量。

      • max_peak_memory：SQL パターンに一致するクエリの最大ピークメモリ使用量。

    • Key が AnalyticDB_PatternScanSize の場合、このパラメーターは次のいずれかの値になります：

      • average_scan_size：SQL パターンに一致するクエリの平均データスキャンサイズ。

      • max_scan_size：SQL パターンに一致するクエリの最大データスキャンサイズ。

    max_query_time
    User

    string

    SQL ステートメントを実行するデータベースアカウント。

    test_user
    AccessIp

    string

    SQL パターンに一致するクエリを送信したクライアント IP アドレス。

    172.16.14.*
    SQLPattern

    string

    SQL パターンの SQL ステートメント。

    SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?
    Tables

    string

    SQL パターンによって照会されたテーブル。

    tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation
    FailedCount

    integer

    クエリ時間範囲内での SQL パターンの失敗した実行回数。

    1
    QueryCount

    integer

    クエリ時間範囲内での SQL パターンの実行回数。

    1202

    例

    成功レスポンス

    JSONJSON

    {
  "EndTime": "2022-08-22T01:06:00Z",
  "RequestId": "F21AF487-B8C9-57E0-8E3A-A92BC3611FB6",
  "StartTime": "2022-08-21T02:15:00Z",
  "Performances": [
    {
      "Key": "AnalyticDB_PatternExecutionTime",
      "Unit": "ms",
      "Series": [
        {
          "Values": [
            "[               \"2021-11-18 13:38:00\",               \"224\"             ]"
          ],
          "Name": "max_query_time"
        }
      ]
    }
  ],
  "User": "test_user",
  "AccessIp": "172.16.14.*",
  "SQLPattern": "SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?",
  "Tables": "tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation",
  "FailedCount": 1,
  "QueryCount": 1202
}

    エラーコード

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

    変更履歴

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