DescribePatternPerformance - AnalyticDB - Alibaba Cloud ドキュメントセンター

指定された期間における 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。説明すべての AnalyticDB for MySQL クラスター（リージョン内）の情報を照会するには、DescribeDBClusters 操作を呼び出します。この操作では、クラスター ID を含む情報が返されます。	am-****************
StartTime	string	必須	照会対象期間の開始時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は UTC で指定する必要があります。説明過去 14 日以内のデータのみ照会可能です。たとえば、現在時刻が UTC+8 で 11 月 22 日の場合、開始時刻として 2021-11-08T16:00:00Z を指定すると、11 月 9 日のデータを照会できます。これより前の時刻（例：2021-11-08T15:59:59Z）を指定した場合、Performances パラメーターの値は空になります。指定可能な最大期間は 24 時間です。	2021-11-18T00:00:00Z
EndTime	string	必須	照会対象期間の終了時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は UTC で指定する必要があります。説明終了時刻は開始時刻より後である必要があります。	2021-11-18T18:05:00Z
RegionId	string	必須	クラスターのリージョン ID。説明最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出します。	cn-hangzhou
PatternId	string	必須	SQL パターン ID。説明指定された期間における AnalyticDB for MySQL クラスター内のすべての SQL パターンに関する情報を照会するには、DescribeSQLPatterns 操作を呼び出します。この操作では、SQL パターン ID を含む情報が返されます。	3847585356974******

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
EndTime	string	照会の終了時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時刻は UTC で表示されます。	2021-11-18T18:05Z
RequestId	string	リクエスト ID。	210f47011634026610213529******
StartTime	string	照会の開始時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時刻は UTC で表示されます。	2021-11-18T00:00Z
Performances	array<object>	照会されたパフォーマンスメトリック。
	array<object>	照会されたパフォーマンスメトリック。
Key	string	照会対象のパフォーマンスメトリック。有効な値は以下のとおりです。 AnalyticDB_PatternQueryCount：SQL パターンに関連付けられたクエリの実行回数の合計。 AnalyticDB_PatternQueryTime：SQL パターンに関連付けられたクエリの実行に要した合計時間。 AnalyticDB_PatternExecutionTime：SQL パターンに関連付けられたクエリの実行に要した合計実行時間。 AnalyticDB_PatternPeakMemory：SQL パターンに関連付けられたクエリのピークメモリ使用量。 AnalyticDB_PatternScanSize：SQL パターンに関連付けられたクエリでスキャンされたデータ量。	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` パラメーターの値が `AnalyticDB_PatternQueryCount` の場合、`pattern_query_count` が返されます。これは、SQL パターンに関連付けられた SQL 文の実行回数を示します。 `Key` パラメーターの値が `AnalyticDB_PatternQueryTime` の場合、以下の値が返されます。 `average_query_time`：SQL パターンに関連付けられた SQL 文の実行に要した平均合計時間。 `max_query_time`：SQL パターンに関連付けられた SQL 文の実行に要した最大合計時間。 `Key` パラメーターの値が `AnalyticDB_PatternExecutionTime` の場合、以下の値が返されます。 `average_execution_time`：SQL パターンに関連付けられた SQL 文の平均実行時間。 `max_execution_time`：SQL パターンに関連付けられた SQL 文の最大実行時間。 `Key` パラメーターの値が `AnalyticDB_PatternPeakMemory` の場合、以下の値が返されます。 `average_peak_memory`：SQL パターンに関連付けられた SQL 文の平均ピークメモリ使用量。 `max_peak_memory`：SQL パターンに関連付けられた SQL 文の最大ピークメモリ使用量。 `Key` パラメーターの値が `AnalyticDB_PatternScanSize` の場合、以下の値が返されます。 `average_scan_size`：SQL パターンに関連付けられた SQL 文でスキャンされたデータの平均量。 `max_scan_size`：SQL パターンに関連付けられた SQL 文でスキャンされたデータの最大量。	max_query_time
AccessIp	string	SQL パターンを送信した SQL クライアントの IP アドレス。	172.16.14.*
FailedCount	integer	指定された期間内で失敗した SQL パターンの数。	0
QueryCount	integer	指定された期間内で SQL パターンに関連付けられたクエリの実行回数。	35018
SQLPattern	string	SQL パターンを表す 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"
}

エラーコード

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

変更履歴

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