DescribeSQLPatterns を使用して診断用の SQL パターンをクエリする - AnalyticDB - Alibaba Cloud - AnalyticDB

DescribeSQLPatterns API を呼び出して、指定した日時の範囲内で 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 です。説明特定のリージョン内のすべての AnalyticDB for MySQL クラスターの詳細（クラスター ID を含む）を照会するには、DescribeDBClusters 操作を呼び出してください。	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 です。説明 AnalyticDB for MySQL で利用可能なリージョンおよびゾーン（リージョン ID を含む）を照会するには、DescribeRegions 操作を呼び出してください。	cn-hangzhou
Keyword	string	任意	SQL パターンをフィルターするためのキーワードです。	SELECT
Order	string	必須	クエリ結果のソート方法を指定します。このパラメーターには JSON 文字列を設定します。例：`[{"Field":"AverageQueryTime","Type":"Asc"}]`。JSON 文字列には以下のフィールドが含まれます。 `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	任意	SQL パターンをフィルターするユーザー名です。このパラメーターを指定すると、指定されたユーザーの SQL パターンのみが返されます。	test_user

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストに対して返されるデータです。
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりに返されるエントリ数です。	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	このパターンのクエリによってスキャンされたデータベーステーブルです。	tpch.orders
PatternCreationTime	string	指定された時間範囲内で、このパターンに一致するクエリが最初に送信された時刻です。形式は `YYYY-MM-DD HH:MM:SS` です。	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	指定された時間範囲内で、このパターンに一致するステートメントの実行回数です。	345
FailedCount	integer	指定された時間範囲内で、このパターンに一致するステートメントの失敗した実行回数です。	234
Blockable	boolean	このパターンに一致するクエリをブロックできるかどうかを示します。有効値： true：SQL パターンをブロックできます。 false：SQL パターンをブロックできません。説明 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******"
}

エラーコード

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

変更履歴

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