API による PolarDB コンピュートノードパフォーマンスの監視 - PolarDB - Alibaba Cloud - PolarDB

コンピューティングノードのパフォーマンスモニタリングデータを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeDBInstancePerformance

get

*DBCluster

acs:polardb:*:{#accountId}:{#resource-type}/{#resource-id}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	ノード ID。	pi-*************
Key	string	任意	パフォーマンスメトリクス。複数のメトリクスはコンマ (,) で区切ります。詳細については、パフォーマンスパラメーターをご参照ください。	PolarDBCPUForPCU,PolarDBPCU,PolarDBMemoryForPCU,PolarDBQPSTPS,PolarDBConnections
StartTime	string	必須	クエリの開始時刻。時刻は `yyyy-MM-ddTHH:mmZ` フォーマットの UTC です。	2022-11-15T16:00Z
EndTime	string	必須	クエリの終了時刻。時刻は `yyyy-MM-ddTHH:mmZ` フォーマットの UTC です。	2020-01-15T17:00Z

レスポンスフィールド

フィールド	型	説明	例
	object	コンピューティングノードのモニタリングデータのリストです。
PerformanceKeys	object
PerformanceItem	array<object>	コンピューティングノードのモニタリングデータのリストです。
	array<object>	コンピューティングノードのモニタリングデータです。
MetricName	string	パフォーマンスメトリックの名前です。	mean_data_size
Measurement	string	パフォーマンスメトリックです。	PolarDBDiskUsage
Points	object
PerformanceItemValue	array<object>	コンピューティングノードのパフォーマンスパラメーターのリストです。
	object
Value	string	コンピューティングノードのパフォーマンスパラメーターの値です。	12.33
Timestamp	integer	モニタリングメトリックが収集された時点の UNIX タイムスタンプです。単位は秒です。	1737424822
DBVersion	string	MySQL のバージョン番号です。有効値： 5.6 5.7 8.0	5.6
EndTime	string	クエリの終了時刻。`yyyy-MM-ddTHH:mmZ` フォーマットの UTC 時刻です。	2020-09-23T01:01Z
RequestId	string	リクエスト ID です。	F2A9EFA7-915F-4572-8299-85A307******
DBInstanceId	string	ノード ID です。	pi-*************
StartTime	string	クエリの開始時刻。`yyyy-MM-ddTHH:mmZ` フォーマットの UTC 時刻です。	2020-09-23T01:01Z
DBType	string	データベースエンジンの互換タイプです。有効値： MySQL PostgreSQL Oracle	MySQL
Engine	string	データベース製品のエンジン名です。	POLARDB

例

成功レスポンス

JSONJSON

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "mean_data_size",
        "Measurement": "PolarDBDiskUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "12.33",
              "Timestamp": 1737424822
            }
          ]
        }
      }
    ]
  },
  "DBVersion": "5.6",
  "EndTime": "2020-09-23T01:01Z",
  "RequestId": "F2A9EFA7-915F-4572-8299-85A307******",
  "DBInstanceId": "pi-*************",
  "StartTime": "2020-09-23T01:01Z",
  "DBType": "MySQL",
  "Engine": "POLARDB"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidKey.Malformed	The specified parameter Key is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidParameterCombination	The end time must be greater than the start time.
404	InvalidDBNodeId.NotFound	The DBNodeId provided does not exist in our records.

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

変更履歴

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