DescribeSqlPattern を使用した SQL パターンのクエリ - AnalyticDB

指定された時間範囲内に AnalyticDB for MySQL クラスターの 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:DescribeSqlPattern

get

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	string	必須	クエリの開始日。時間は yyyy-MM-dd 形式で指定します。時間は UTC である必要があります。説明過去 30 日以内のデータのみクエリできます。	2021-08-30
Order	string	任意	クエリ結果のソート順。パラメーター値は JSON 文字列形式で指定します。例：`[{"Field":"Pattern","Type":"Asc"}]`。パラメーター： `Field`：クエリ結果のソートに使用するフィールドを指定します。有効な値： `Pattern`：SQL パターン。 `AccessIP`：クライアントの IP アドレス。 `User`：ユーザー名。 `QueryCount`：クエリ対象の時間範囲内における、SQL パターンに関連付けられたクエリの数。 `AvgPeakMemory`：クエリ対象の時間範囲内における、SQL パターンの平均ピークメモリ使用量。単位：KB。 `MaxPeakMemory`：クエリ対象の時間範囲内における、SQL パターンの最大ピークメモリ使用量。単位：KB。 `AvgCpuTime`：クエリ対象の時間範囲内における、SQL パターンの平均実行時間。単位：ミリ秒。 `MaxCpuTime`：クエリ対象の時間範囲内における、SQL パターンの最大実行時間。単位：ミリ秒。 `AvgStageCount`：ステージの平均数。 `MaxStageCount`：ステージの最大数。 `AvgTaskCount`：タスクの平均数。 `MaxTaskCount`：タスクの最大数。 `AvgScanSize`：クエリ対象の時間範囲内における、SQL パターンに基づいてスキャンされた平均データ量。単位：KB。 `MaxScanSize`：クエリ対象の時間範囲内における、SQL パターンに基づいてスキャンされた最大データ量。単位：KB。 `Type`：ソート順を指定します。有効な値： `Asc`：昇順。 `Desc`：降順。説明このパラメーターを指定しない場合、クエリ結果は `Pattern` の昇順でソートされます。クエリ結果を `AccessIP` でソートする場合は、`Type` パラメーターを `accessip` に設定する必要があります。クエリ結果を `User` でソートする場合は、`Type` パラメーターを空にするか、`user` に設定する必要があります。	[{"Field":"Pattern","Type":"Asc"}]
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
SqlPattern	string	任意	クエリに使用されるキーワード。説明このパラメーターを指定しない場合、`StartTime` で指定された期間内の AnalyticDB for MySQL クラスターのすべての SQL パターンが返されます。	SELECT
Type	string	任意	SQL パターンを集計するディメンション。有効な値： `user`：ユーザー別に SQL パターンを集計します。 `accessip`：クライアント IP アドレス別に SQL パターンを集計します。説明このパラメーターを指定しない場合、SQL パターンは `user` で集計されます。	user
DBClusterId	string	必須	クラスター ID。説明 DescribeDBClusters 操作を呼び出して、クラスター ID を含む、リージョン内のすべての AnalyticDB for MySQL クラスターに関する情報をクエリできます。	am-bp1r053byu48p****
PageSize	integer	任意	1 ページあたりのエントリ数。値は正の整数である必要があります。デフォルト値：30。	30
RegionId	string	必須	クラスターのリージョン ID。説明 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
PageSize	integer	1 ページあたりのエントリ数。	30
PageNumber	integer	ページ番号。	1
TotalCount	integer	返されたエントリの総数。	1
Items	array<object>	クエリされた SQL パターン。
	object
AvgStageCount	string	ステージの平均数。	2
MaxCpuTime	string	クエリ対象の時間範囲内における、SQL パターンの最大実行時間。単位：ミリ秒。	17
AccessIP	string	クライアントの IP アドレス。説明このパラメーターは、`Type` が `accessip` に設定されている場合にのみ返されます。	100.104.*.*
AvgScanSize	string	クエリ対象の時間範囲内における、SQL パターンに基づいてスキャンされた平均データ量。単位：KB。	0
MaxScanSize	string	クエリ対象の時間範囲内における、SQL パターンに基づいてスキャンされた最大データ量。単位：KB。	0
MaxPeakMemory	string	クエリ対象の時間範囲内における、SQL パターンの最大ピークメモリ使用量。単位：KB。	480096
AvgCpuTime	string	クエリ対象の時間範囲内における、SQL パターンの平均実行時間。単位：ミリ秒。	1.0625
User	string	ユーザー名。説明このパラメーターは、`Type` が空または `user` に設定されている場合にのみ返されます。	test_acc
AvgPeakMemory	string	クエリ対象の時間範囲内における、SQL パターンの平均ピークメモリ使用量。単位：KB。	240048
MaxStageCount	string	ステージの最大数。	2
MaxTaskCount	string	タスクの最大数。	2
InstanceName	string	クラスター ID。	am-bp1r053byu48p****
QueryCount	string	クエリ対象の時間範囲内における、SQL パターンに関連付けられたクエリの数。	16
ReportDate	string	クエリの開始日。	2021-08-30
Pattern	string	SQL パターン。	SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1
AvgTaskCount	string	タスクの平均数。	2
RequestId	string	リクエスト ID。	B6F2D1B4-2C9F-5622-B424-5E7965******

例

成功レスポンス

JSONJSON

{
  "PageSize": 30,
  "PageNumber": 1,
  "TotalCount": 1,
  "Items": [
    {
      "AvgStageCount": "2",
      "MaxCpuTime": "17",
      "AccessIP": "100.104.***.***",
      "AvgScanSize": "0",
      "MaxScanSize": "0",
      "MaxPeakMemory": "480096",
      "AvgCpuTime": "1.0625",
      "User": "test_acc",
      "AvgPeakMemory": "240048",
      "MaxStageCount": "2",
      "MaxTaskCount": "2",
      "InstanceName": "am-bp1r053byu48p****",
      "QueryCount": "16",
      "ReportDate": "2021-08-30",
      "Pattern": "SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1",
      "AvgTaskCount": "2"
    }
  ],
  "RequestId": "B6F2D1B4-2C9F-5622-B424-5E7965******"
}

エラーコード

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

変更履歴

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