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

:DescribeSQLPatterns

最終更新日:Jan 14, 2026

DescribeSQLPatterns 操作を呼び出して、指定した日付の 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:時間範囲内での SQL パターンの最も早い送信時刻。

    • AverageQueryTime:時間範囲内での SQL パターンの平均合計時間。

    • MaxQueryTime:時間範囲内での SQL パターンの最大合計時間。

    • AverageExecutionTime:時間範囲内での SQL パターンの平均実行時間。

    • MaxExecutionTime:時間範囲内での SQL パターンの最大実行時間。

    • AveragePeakMemory:時間範囲内での SQL パターンの平均ピークメモリ使用量。

    • MaxPeakMemory:時間範囲内での SQL パターンの最大ピークメモリ使用量。

    • AverageScanSize:時間範囲内での SQL パターンによって読み取られたデータの平均量。

    • MaxScanSize:時間範囲内での SQL パターンによって読み取られたデータの最大量。

    • QueryCount:時間範囲内での SQL パターンの実行回数。

    • FailedCount:時間範囲内での SQL パターンの失敗した実行回数。

  • Type はソートメソッドを指定します。値は大文字と小文字を区別しません。有効な値:

    • Asc:昇順。

    • Desc:降順。

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

PageNumber

integer

任意

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

説明

デフォルト値は 1 です。

1

PageSize

integer

任意

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

  • 30

  • 50

  • 100

説明

デフォルト値は 30 です。

30

Lang

string

任意

ダウンロードされたファイルのファイルタイトルと一部のエラーメッセージの言語。有効な値:

  • zh:簡体字中国語。これはデフォルト値です。

  • en:英語。

  • ja:日本語。

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

zh

UserName

string

任意

ユーザー名。

test_user

レスポンスフィールド

フィールド

説明

object

情報のリスト。

PageNumber

integer

ページ番号。

1

PageSize

integer

現在のページのエンティティ数。

30

TotalCount

integer

エントリの総数。

1

PatternDetails

array<object>

SQL パターンの詳細。

object

SQL パターンのリスト。

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

時間範囲内での SQL パターンの最も早い送信時刻。単位:ミリ秒。

2021-11-12 03:06:00

AverageQueryTime

number

時間範囲内での SQL パターンの平均合計時間。単位:ミリ秒。

4

MaxQueryTime

integer

時間範囲内での SQL パターンの最大合計時間。単位:ミリ秒。

2341

AverageExecutionTime

number

時間範囲内での SQL パターンの平均実行時間。単位:ミリ秒。

234.78

MaxExecutionTime

integer

時間範囲内での SQL パターンの最大実行時間。単位:ミリ秒。

2142

AveragePeakMemory

number

時間範囲内での SQL パターンの平均ピークメモリ使用量。単位:バイト。

234.22

MaxPeakMemory

integer

時間範囲内での SQL パターンの最大ピークメモリ使用量。単位:バイト。

234149

AverageScanSize

number

時間範囲内での SQL パターンによってスキャンされたデータの平均量。単位:バイト。

234149.23

MaxScanSize

integer

時間範囲内での SQL パターンによってスキャンされたデータの最大量。単位:バイト。

234149

QueryCount

integer

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

345

FailedCount

integer

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

234

Blockable

boolean

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

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

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

説明

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

true

QueryTimeSum

number

合計時間。単位:ミリ秒。

5

QueryTimePercentage

number

時間範囲内のすべての SQL パターンの合計時間に対する単一の SQL パターンの合計時間の割合。単位:%。

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

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

5

ScanCostPercentage

number

データスキャンの合計コストの割合。単位:%。

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******"
}

エラーコード

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

変更履歴

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