すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeSQLPatterns

    ドキュメントセンター

    AnalyticDB:DescribeSQLPatterns

    最終更新日:Oct 21, 2026

    指定された日付範囲内の AnalyticDB for MySQL クラスターにおける SQL パターンを照会します。

    操作説明

    • 中央パブリックエンドポイント: adb.aliyuncs.com。

    • リージョンパブリックエンドポイント: adb.<region-id>.aliyuncs.com。例: adb.cn-hangzhou.aliyuncs.com。

    • リージョン VPC エンドポイント: adb-vpc.<region-id>.aliyuncs.com。例: adb-vpc.cn-hangzhou.aliyuncs.com。

    今すぐお試しください

    この 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:DescribeSQLPatterns

    list

    DBCluster。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、指定されたリージョン内のすべての AnalyticDB for MySQL クラスターの詳細 (クラスター ID を含む) をクエリできます。

    am-bp1r053byu48p****
    StartTime

    string

    必須

    クエリの開始時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。

    説明

    • 過去 14 日間のデータのクエリのみが可能です。たとえば、現在時刻が 2021-11-22T12:00:00Z の場合、データのクエリが可能な最も古いデータは 2021-11-09T12:00:00Z のものです。

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

    2021-09-30T00:10:00Z
    EndTime

    string

    必須

    クエリの終了時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。

    説明

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

    2021-09-30T00:15:00Z
    RegionId

    string

    必須

    リージョン ID。

    説明

    DescribeRegions 操作を呼び出して、AnalyticDB for MySQL でサポートされているリージョンとゾーン (リージョン ID を含む) をクエリできます。

    cn-hangzhou
    Keyword

    string

    任意

    SQL キーワード。

    SELECT
    Order

    string

    必須

    指定されたフィールドでクエリ結果をソートします。フォーマットは JSON 文字列です。例: [{"Field":"AverageQueryTime","Type":"Asc"}]。各項目は以下のとおりです。

    • Field: ソートフィールド。有効な値:

      • PatternCreationTime: クエリ時間範囲内におけるパターンの最も早いコミット時刻。

      • AverageQueryTime: クエリ時間範囲内においてパターンが消費した平均合計時間。

      • MaxQueryTime: クエリ時間範囲内においてパターンが消費した最大合計時間。

      • AverageExecutionTime: クエリ時間範囲内においてパターンを実行するのにかかった平均時間。

      • MaxExecutionTime: クエリ時間範囲内においてパターンを実行するのにかかった最大時間。

      • AveragePeakMemory: クエリ時間範囲内におけるパターンの平均ピークメモリ使用量。

      • MaxPeakMemory: クエリ時間範囲内におけるパターンの最大ピークメモリ使用量。

      • AverageScanSize: クエリ時間範囲内においてパターンが読み取りした平均データ量。

      • MaxScanSize: クエリ時間範囲内においてパターンが読み取りした最大データ量。

      • QueryCount: クエリ時間範囲内においてパターンを実行する回数。

      • FailedCount: クエリ時間範囲内においてパターンが失敗した回数。

    • Type: ソートメソッド。有効な値 (大文字と小文字は区別されません):

      • Asc: 昇順。

      • Desc: 降順。

    [{"Field":"AverageQueryTime","Type":"Asc"}]
    PageNumber

    integer

    任意

    ページ番号。値は、Integer データの型の最大値を超えない正の整数である必要があります。

    説明

    このパラメーターを指定しない場合、デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効な値:

    • 30

    • 50

    • 100

    説明

    このパラメーターを指定しない場合、デフォルト値は 30 です。

    30
    Lang

    string

    任意

    ダウンロードしたファイルのタイトルおよび一部のエラーメッセージの言語を指定します。有効な値:

    • zh: 簡体字中国語 (デフォルト)。

    • en: 英語。

    • ja: 日本語。

    • zh-tw: 繁体字中国語。

    zh
    UserName

    string

    任意

    ユーザー名。

    test_user
    SqlPatternHash

    integer

    任意

    SQL パターンのハッシュ値。特定の SQL パターンをフィルターするために使用されます。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リストのフォーマット情報。

    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    現在のページのエントリ数。

    30
    TotalCount

    integer

    エントリの総数。

    1
    PatternDetails

    array<object>

    SQL パターンの詳細。

    object

    リスト。

    SQLPattern

    string

    SQL パターンの特定の文。

    SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
    PatternId

    string

    SQL パターンの ID。

    5575924945138******
    User

    string

    パターンに関連する SQL ステートメントを送信したデータベースのユーザー名。

    reporter
    AccessIp

    string

    パターンに関連する SQL ステートメントを送信したクライアントの IP アドレス。

    192.168.xx.xx
    Tables

    string

    SQL パターンによってスキャンされたデータベーステーブルの名前。

    tpch.orders
    PatternCreationTime

    string

    クエリ時間範囲内におけるパターンの最も早い送信時刻。単位: ミリ秒。

    2021-11-12 03:06:00
    AverageQueryTime

    number

    クエリ時間範囲内においてパターンが消費した平均合計時間。単位: ミリ秒。

    4
    MaxQueryTime

    integer

    クエリ時間範囲内においてパターンが消費した最大合計時間。単位: ミリ秒。

    2341
    AverageExecutionTime

    number

    クエリ時間範囲内においてパターンを実行するのにかかった平均時間。単位: ミリ秒。

    234.78
    MaxExecutionTime

    integer

    クエリ時間範囲内においてパターンを実行するのにかかった最大時間。単位: ミリ秒。

    2142
    AveragePeakMemory

    number

    クエリ時間範囲内におけるパターンの平均ピークメモリ使用量。単位: バイト。

    234.22
    MaxPeakMemory

    integer

    クエリ時間範囲内におけるパターンの最大ピークメモリ使用量。単位: バイト。

    234149
    AverageScanSize

    number

    クエリ時間範囲内においてパターンがスキャンした平均データ量。単位: バイト。

    234149.23
    MaxScanSize

    integer

    クエリ時間範囲内においてパターンがスキャンした最大データ量。単位: バイト。

    234149
    QueryCount

    integer

    クエリ時間範囲内においてパターンを実行する回数。

    345
    FailedCount

    integer

    クエリ時間範囲内においてパターンが失敗した回数。

    234
    Blockable

    boolean

    現在の SQL パターンの実行をブロックできるかどうかを指定します。有効な値:

    • true: 実行をブロックできます。

    • false: 実行をブロックできません。

    説明

    現在、AnalyticDB for MySQL は SELECT 文と INSERT 文のブロックのみをサポートしています。

    true
    QueryTimeSum

    number

    消費された合計時間。単位: ミリ秒。

    5
    QueryTimePercentage

    number

    クエリ時間範囲内において単一パターンが消費した合計時間が、すべてのパターンが消費した合計時間に占める割合。単位: %。

    10
    PeakMemorySum

    number

    ピークメモリ使用量の合計。単位: バイト。

    5
    PeakMemoryPercentage

    number

    ピークメモリ使用量の合計が占める割合。単位: %。

    10
    ScanSizeSum

    number

    スキャンされたデータ量の合計。単位: バイト。

    5
    ScanSizePercentage

    number

    スキャンされたデータ量の合計が占める割合。単位: %。

    80
    AverageOperatorCost

    number

    平均 CPU コスト。単位: ミリ秒。

    5
    MaxOperatorCost

    number

    最大 CPU コスト。単位: ミリ秒。

    5
    OperatorCostSum

    number

    CPU コストの合計。単位: ミリ秒。

    5
    OperatorCostPercentage

    number

    CPU コストの合計が占める割合。単位: %。

    20
    AverageScanCost

    number

    テーブルスキャンの平均 CPU コスト。単位: ミリ秒。

    5
    MaxScanCost

    number

    テーブルスキャンの最大 CPU コスト。単位: ミリ秒。

    5
    ScanCostSum

    number

    データスキャンの CPU コストの合計。単位: バイト。

    5
    ScanCostPercentage

    number

    データスキャンの CPU コストの合計が占める割合。単位: %。

    5
    RequestId

    string

    リクエスト ID。

    6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "PatternDetails": [
    {
      "SQLPattern": "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
      "PatternId": "5575924945138******",
      "User": "reporter",
      "AccessIp": "192.168.xx.xx",
      "Tables": "tpch.orders",
      "PatternCreationTime": "2021-11-12 03:06:00",
      "AverageQueryTime": 4,
      "MaxQueryTime": 2341,
      "AverageExecutionTime": 234.78,
      "MaxExecutionTime": 2142,
      "AveragePeakMemory": 234.22,
      "MaxPeakMemory": 234149,
      "AverageScanSize": 234149.23,
      "MaxScanSize": 234149,
      "QueryCount": 345,
      "FailedCount": 234,
      "Blockable": true,
      "QueryTimeSum": 5,
      "QueryTimePercentage": 10,
      "PeakMemorySum": 5,
      "PeakMemoryPercentage": 10,
      "ScanSizeSum": 5,
      "ScanSizePercentage": 80,
      "AverageOperatorCost": 5,
      "MaxOperatorCost": 5,
      "OperatorCostSum": 5,
      "OperatorCostPercentage": 20,
      "AverageScanCost": 5,
      "MaxScanCost": 5,
      "ScanCostSum": 5,
      "ScanCostPercentage": 5
    }
  ],
  "RequestId": "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

    エラーコード

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

    変更履歴

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