DescribeDBClusterResourcePoolPerformance を使用してリソースグループパフォーマンスをクエリする - AnalyticDB

AnalyticDB for MySQL クラスター内のリソースグループのモニタリング情報を照会します。

操作説明

説明

また、クラスター版の Elastic モードで実行される AnalyticDB for MySQL クラスター内のリソースグループのモニタリング情報は、コンソール上でグラフ形式で確認できます。詳細については、「モニタリング情報の表示」をご参照ください。

今すぐお試しください

この 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:DescribeDBClusterResourcePoolPerformance

get

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID です。説明すべての AnalyticDB for MySQL クラスター（クラスター ID を含む）に関する情報を照会するには、DescribeDBClusters 操作を呼び出します。	am-****************
Key	string	任意	リソースグループのメトリックです。複数のメトリックを同時に指定してモニタリング情報を照会できます。複数のメトリックはカンマ (,) で区切ります。有効な値は以下のとおりです。 AnalyticDB_RP_CPU：平均 CPU 使用率。単位：％。 AnalyticDB_RP_RT：クエリ応答時間 (RT)。単位：ミリ秒。 AnalyticDB_RP_QPS：クエリ/秒 (QPS)。このパラメーターの値は数値である必要があります。 AnalyticDB_RP_WaitTime：クエリ待機時間。単位：ミリ秒。 AnalyticDB_RP_OriginalNode：リソースグループ内の基本ノード数。 AnalyticDB_RP_ActualNode：リソースグループ内でスケールアウトされたスケジュール済みノード数。 AnalyticDB_RP_PlanNode：リソースグループ内でスケールアウト予定のスケジュール済みノード数。 AnalyticDB_RP_TotalNode：リソースグループ内のノード総数。ノード総数 = 基本ノード数 + スケールアウトされたスケジュール済みノード数。説明このパラメーターを空欄のままにした場合、すべてのメトリックに関するモニタリング情報が返されます。スケーリングプランの詳細については、「リソーススケーリングプランの作成」をご参照ください。	AnalyticDB_RP_CPU
ResourcePools	string	任意	照会対象のリソースグループの名前です。複数のリソースグループ名を指定できます。複数の名前はカンマ (,) で区切ります。説明このパラメーターの値は大文字小文字を区別しません。たとえば、`USER_DEFAULT` と `user_default` は同一のリソースグループを指定します。このパラメーターを空欄のままにした場合、`USER_DEFAULT` リソースグループに関するモニタリング情報が返されます。	TEST_POOL
StartTime	string	必須	リソースグループのモニタリング期間の開始時刻です。ISO 8601 標準に従い、yyyy-MM-ddTHH:mmZ 形式で指定します。時刻は UTC で指定する必要があります。説明直近 2 日間のリソースグループに関するモニタリング情報のみを表示できます。	2021-06-10T07:00Z
EndTime	string	必須	リソースグループのモニタリング期間の終了時刻です。終了時刻は開始時刻より後である必要があります。ISO 8601 標準に従い、yyyy-MM-ddTHH:mmZ 形式で指定します。時刻は UTC で指定する必要があります。	2021-06-10T07:01Z

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
EndTime	string	リソースグループのモニタリング期間の終了時刻です。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時刻は UTC で表示されます。	2021-06-10T07:01:00Z
RequestId	string	リクエスト ID です。	C7EDB8E4-9769-4233-88C7-DCA4C9******
StartTime	string	リソースグループのモニタリング期間の開始時刻です。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時刻は UTC で表示されます。	2021-06-10T07:00:00
DBClusterId	string	クラスター ID です。	am-****************
Performances	array<object>	照会されたメトリックのモニタリング情報です。
	array<object>	照会されたメトリックのモニタリング情報です。
Key	string	リソースグループのメトリックです。	AnalyticDB_RP_CPU
Unit	string	メトリック値の単位です。	%
ResourcePoolPerformances	array<object>	照会されたリソースグループのモニタリング情報です。
	array<object>	照会されたリソースグループのモニタリング情報です。
ResourcePoolName	string	リソースグループの名前です。	test_pool
ResourcePoolSeries	array<object>	リソースグループの時系列モニタリング情報です。
	object	リソースグループの時系列モニタリング情報です。
Values	array	メトリックの値です。
	string	異なる時点におけるメトリックの値です。	["2021-06-10T07:00:22.601Z","0.0000"],["2021-06-10T07:00:52.62Z","0.0312"]
Name	string	メトリックの名前です。	cpu

例

成功レスポンス

JSONJSON

{
  "EndTime": "2021-06-10T07:01:00Z",
  "RequestId": "C7EDB8E4-9769-4233-88C7-DCA4C9******",
  "StartTime": "2021-06-10T07:00:00",
  "DBClusterId": "am-****************",
  "Performances": [
    {
      "Key": "AnalyticDB_RP_CPU",
      "Unit": "%",
      "ResourcePoolPerformances": [
        {
          "ResourcePoolName": "test_pool",
          "ResourcePoolSeries": [
            {
              "Values": [
                "[\"2021-06-10T07:00:22.601Z\",\"0.0000\"],[\"2021-06-10T07:00:52.62Z\",\"0.0312\"]"
              ],
              "Name": "cpu"
            }
          ]
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

変更履歴

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