AnalyticDB:DescribeDBClusterPerformance - AnalyticDB for PostgreSQL

AnalyticDB for PostgreSQL インスタンスのパフォーマンスモニタリング情報を、指定した期間で表示します。

操作説明

モニタリング情報は、過去 30 日分のみ照会可能です。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:DescribeDBClusterPerformance

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID を指定します。説明すべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の詳細を照会するには、DescribeDBInstances 操作を呼び出します。	gp-bp12ga6v69h86****
Key	string	必須	照会対象のパフォーマンスメトリックを指定します。複数指定する場合は、カンマ (,) で区切ります。詳細については、「パフォーマンスパラメーター」をご参照ください。	adbpg_conn_count
StartTime	string	必須	照会期間の開始時刻を指定します。ISO 8601 標準に従い、`YYYY-MM-DDTHH:mmZ` 形式で記述します。説明モニタリング情報は、過去 30 日分のみ照会可能です。	2021-11-03T15:00Z
EndTime	string	必須	照会期間の終了時刻を指定します。ISO 8601 標準に従い、`YYYY-MM-DDTHH:mmZ` 形式で記述します。説明終了時刻は、開始時刻より後である必要があります。また、最大照会期間は 7 日間です。	2021-11-03T15:10Z
Nodes	string	任意	パフォーマンスメトリックを照会するノードを指定します。複数指定する場合は、カンマ (,) で区切ります。例： `master-10****1,master-10**2`。ノード名を照会するには、DescribeDBClusterNode 操作を呼び出します。また、メトリック値に基づいてノードをフィルター処理することもできます。有効な値は以下のとおりです。 top10：メトリック値が最も高い上位 10 個のノード top20：メトリック値が最も高い上位 20 個のノード bottom10：メトリック値が最も低い下位 10 個のノード bottom20**：メトリック値が最も低い下位 20 個のノード	top10
NodeType	string	任意	ノードタイプを指定します。有効な値は以下のとおりです。 master：コーディネーターノード segment：コンピュートノード説明このパラメーターを指定しない場合、すべてのノードのパフォーマンスメトリックが返されます。	master
ResourceGroupName	string	任意	リソースグループの名前を指定します。	testgroup

レスポンスフィールド

フィールド	型	説明	例
	object
PerformanceKeys	array<object>	パフォーマンスメトリックの名前です。詳細については、「パフォーマンスパラメーター」をご参照ください。
	array<object>	パフォーマンスメトリックの値およびその収集時刻です。
Unit	string	パフォーマンスメトリックの単位です。	%
Series	array<object>	ノードのパフォーマンスメトリックの詳細です。
	array<object>
Values	array<object>	特定の時刻におけるパフォーマンスメトリックの値です。
	object
Point	array	パフォーマンスメトリックの値およびその収集時刻です。
	string	時間とパフォーマンスパラメーター値から構成される具体的なパフォーマンスモニタリング情報です。	["2021-11-03T15:00:00+08:00","5.84"]
Role	string	ノードのロールを指定します。有効な値は以下のとおりです。 master：プライマリコーディネーターノード standby：スタンバイコーディネーターノード segment：コンピュートノード	standby
Name	string	コンピュートノードまたはコンピュートグループの名前です。	standby-********-cpu
Name	string	パフォーマンスメトリックの名前です。詳細については、「パフォーマンスパラメーター」をご参照ください。	adbpg_group_cpu_used_percent
EndTime	string	照会の終了時刻です。ISO 8601 標準に従い、`YYYY-MM-DDTHH:mmZ` 形式で表記され、UTC 表示となります。	2021-11-03T15:10Z
RequestId	string	リクエスト ID です。	8E8990F0-C81E-4C94-8F51-5F**********
StartTime	string	照会の開始時刻です。ISO 8601 標準に従い、`YYYY-MM-DDTHH:mmZ` 形式で表記され、UTC 表示となります。	2021-11-03T15:00Z
DBClusterId	string	インスタンス ID を指定します。	gp-bp12ga6v69h86****

例

成功レスポンス

JSONJSON

{
  "PerformanceKeys": [
    {
      "Unit": "%",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "[\"2021-11-03T15:00:00+08:00\",\"5.84\"]"
              ]
            }
          ],
          "Role": "standby",
          "Name": "standby-********-cpu"
        }
      ],
      "Name": "adbpg_group_cpu_used_percent"
    }
  ],
  "EndTime": "2021-11-03T15:10Z",
  "RequestId": "8E8990F0-C81E-4C94-8F51-5F**********",
  "StartTime": "2021-11-03T15:00Z",
  "DBClusterId": "gp-bp12ga6v69h86****"
}

エラーコード

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

変更履歴

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