DescribeDBNodePerformance - PolarDB - Alibaba Cloud ドキュメントセンター

インスタンスのパフォーマンスデータを照会します。

操作説明

注意:

エンドポイントは他の API オペレーションと異なります。中国本土のリージョンおよびシンガポールの場合は、polardbx.aliyuncs.com を使用してください。その他のリージョンの場合は、polardbx.{region id}.aliyunc.com を使用してください。
この API オペレーションのデバッグ時にサービス利用不可エラーが発生した場合は、エンドポイントが正しいことを確認してください。サービスアドレスを Dubai または India に切り替え、エンドポイントを polardbx.aliyuncs.com に変更できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardbx:DescribeDBNodePerformance

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Key	string	必須	メトリック名。複数の名前を指定する場合はカンマ (,) で区切ります。最大 6 つのメトリックを指定できます。詳細については、「パフォーマンスメトリクス」を参照してください。	Cpu_Usage,Mem_Usage
StartTime	string	必須	クエリの開始時刻。フォーマット: YYYY-MM-ddTHH:mmZ (協定世界時 (UTC))。	2012-06-08T15:00Z
DBInstanceName	string	必須	PolarDB-X インスタンスの名前。	pxc-*******
DBNodeIds	string	必須	ノード名。複数の名前を指定する場合はカンマ (,) で区切ります。一度に最大 10 個の CDC ノードまたは計算ノード、および最大 1 個のデータノードを指定できます。	pxc-i-****,pxc-i-*****
CharacterType	string	必須	ノードタイプ。有効な値: polarx_cn、polarx_dn、polarx_cdc、polarx_gms、polarx_columnar。	polarx_cn
DBNodeRole	string	任意	ノードのロール。有効な値: master: プライマリノード。 slave: セカンダリノード。DN ノードおよび GMS ノードに適用されます。 standby: セカンダリノード。CN ノードに適用されます。	master
RegionId	string	必須	リージョン ID。	cn-hangzhou
EndTime	string	必須	クエリの終了時間。フォーマット: YYYY-MM-ddTHH:mmZ (協定世界時 (UTC))。	2012-06-18T15:00Z

レスポンスフィールド

フィールド	型	説明	例
	object
EndTime	string	クエリの終了時間。フォーマット: YYYY-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。	2021-10-20T02:00Z
StartTime	string	クエリの開始時刻。フォーマット: YYYY-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。	2021-10-20T00:00Z
DBInstanceName	string	インスタンス名。	pxc-********
RequestId	string	リクエスト ID。	EFB5E10B-5268-170F-A378-9AF86CCEACC8
PerformanceKeys	object
PerformanceItem	array<object>	パフォーマンスデータのリスト。
	array<object>
MetricName	string	特定のパフォーマンスメトリクス測定の名前。	logic_tps
DBNodeId	string	ノード名。	pxc-i-********
Measurement	string	パフォーマンスメトリクス。	Logic_TPS
Points	object
PerformanceItemValue	array<object>	パフォーマンスデータの配列。
	object
Value	string	監視メトリクスの値。	42.38
Timestamp	integer	監視メトリクスの時間ポイント。値は UNIX タイムスタンプのフォーマットです。単位: ミリ秒。	1600822800000

例

成功レスポンス

JSONJSON

{
  "EndTime": "2021-10-20T02:00Z",
  "StartTime": "2021-10-20T00:00Z",
  "DBInstanceName": "pxc-********",
  "RequestId": "EFB5E10B-5268-170F-A378-9AF86CCEACC8",
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "logic_tps",
        "DBNodeId": "pxc-i-********",
        "Measurement": "Logic_TPS",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "42.38",
              "Timestamp": 1600822800000
            }
          ]
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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