DescribePatternPerformance を使用した SQL パターン性能メトリクスのクエリ - AnalyticDB - Alibaba Cloud - AnalyticDB

指定された期間内の 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

get

DBCluster。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。説明 DescribeDBClusters 操作を呼び出して、指定されたリージョン内のすべての AnalyticDB for MySQL クラスターの詳細 (クラスター ID を含む) を照会できます。	am-****************
StartTime	string	必須	クエリの開始時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。説明過去 14 日間のデータのクエリのみが可能です。たとえば、現在の日付が UTC+8 の 11 月 22 日である場合、クエリできる最も古いデータは UTC+8 の 11 月 9 日 (協定世界時 (UTC): 2021-11-08T16:00:00Z) のものです。クエリ時間が 11 月 9 日 (協定世界時 (UTC): 2021-11-08T16:00:00Z) より前の場合、空の結果が返されます。クエリの開始時刻と終了時刻の間隔は 24 時間を超えることはできません。	2021-11-18T00:00:00Z
EndTime	string	必須	クエリの終了時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。説明クエリの終了時刻は開始時刻より後である必要があります。	2021-11-18T18:05:00Z
RegionId	string	必須	リージョン ID。説明 DescribeRegions 操作を呼び出して、AnalyticDB for MySQL でサポートされているリージョンとゾーン (リージョン ID を含む) を照会できます。	cn-hangzhou
PatternId	string	必須	SQL パターンの ID。説明 DescribeSQLPatterns 操作を呼び出して、指定された期間内の指定された AnalyticDB for MySQL クラスター内のすべての SQL パターンのリスト (SQL パターン ID を含む) を照会できます。	3847585356974******

レスポンスフィールド

フィールド	型	説明	例
	object	リスト。
EndTime	string	クエリの終了時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。	2021-11-18T18:05Z
RequestId	string	リクエスト ID。	210f47011634026610213529******
StartTime	string	クエリの開始時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。	2021-11-18T00:00Z
Performances	array<object>	パフォーマンスメトリクスのリスト。
	array<object>	リスト。
Key	string	クエリのパフォーマンスメトリクス。有効な値: AnalyticDB_PatternQueryCount: パターンに関連するクエリの総数。 AnalyticDB_PatternQueryTime: パターンに関連するクエリによって消費された合計時間。 AnalyticDB_PatternExecutionTime: パターンに関連するクエリを実行するのにかかった時間。 AnalyticDB_PatternPeakMemory: パターンに関連するクエリによって使用されたピークメモリ。 AnalyticDB_PatternScanSize: パターンに関連するクエリによって読み取りされたデータ量。	AnalyticDB_PatternQueryCount
Unit	string	パフォーマンスメトリクスに対応する単位。有効な値: パフォーマンスメトリクスがクエリ時間に関連している場合 (つまり、`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` の場合、このパラメーターは `pattern_query_count` を返します。これは、現在のパターンに関連付けられた SQL ステートメントの実行回数を示します。 `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
AccessIp	string	パターンに関連する SQL ステートメントを送信するクライアントの IP アドレス。	172.16.14.*
FailedCount	integer	クエリの時間範囲内におけるパターンの失敗回数。	0
QueryCount	integer	指定された時間範囲内におけるパターンの実行回数。	35018
SQLPattern	string	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
User	string	SQL ステートメントを実行するユーザーのユーザー名。	test

例

成功レスポンス

JSONJSON

{
  "EndTime": "2021-11-18T18:05Z",
  "RequestId": "210f47011634026610213529******",
  "StartTime": "2021-11-18T00:00Z",
  "Performances": [
    {
      "Key": "AnalyticDB_PatternQueryCount",
      "Unit": "ms",
      "Series": [
        {
          "Values": [
            "[               \"2021-11-18 13:38:00\",               \"224\"             ]"
          ],
          "Name": "max_query_time"
        }
      ]
    }
  ],
  "AccessIp": "172.16.14.*",
  "FailedCount": 0,
  "QueryCount": 35018,
  "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",
  "User": "test"
}

エラーコード

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

変更履歴

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