PolarProxy パフォーマンスメトリクスのクエリ - PolarDB - Alibaba Cloud - PolarDB

PolarProxy のパフォーマンスデータをクエリします。

操作説明

説明

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeDBProxyPerformance

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID です。	pc-****************
DBEndpointId	string	任意	エンドポイントの ID です。	pe-****************
Interval	string	任意	パフォーマンスデータを収集するインターバルです。有効な値は 5、30、60、600、1800、3600、86400 で、単位は秒です。	60
Type	string	任意	特殊なメトリック。値を tair に設定します。これは PolarTair アーキテクチャを示します。	tair
Key	string	必須	クエリするパフォーマンスメトリクスです。複数のメトリックはカンマ (,) で区切ります。詳細については、「パフォーマンスパラメーター」をご参照ください。	PolarProxy_CpuUsage
StartTime	string	必須	クエリする時間範囲の開始時刻です。時間は `yyyy-MM-ddTHH:mmZ` フォーマットで、UTC で指定します。	2020-09-23T01:01Z
EndTime	string	必須	クエリする時間範囲の終了時刻です。時間は `yyyy-MM-ddTHH:mmZ` フォーマットで、UTC で指定します。	2020-09-24T02:08Z
DBNodeId	string	任意	クラスター内のノードの ID です。このパラメーターを使用すると、異なるノード上の PolarProxy のパフォーマンスメトリクスをクエリできます。サポートされているメトリクスは、PolarProxy_DBConns, PolarProxy_DBQps, PolarProxy_DBActionOps です。	pi-****************

レスポンスフィールド

フィールド	型	説明	例
	object
PerformanceKeys	object
PerformanceItem	array<object>	パフォーマンスメトリクスの詳細です。
	array<object>
MetricName	string	パフォーマンスメトリックの名前です。	service_connections_ps
Measurement	string	パフォーマンスメトリックです。	PolarProxy_CpuUsage
Points	object
PerformanceItemValue	array<object>	パフォーマンスメトリクスのリストです。
	object
Value	string	メトリックの値です。	10
Timestamp	integer	メトリック値が収集された時刻です。この値はミリ秒単位のタイムスタンプです。	1600822800000
DBNodeId	string	ノードの ID です。	pi-*************
DBVersion	string	データベースエンジンのバージョンです。	8.0
EndTime	string	クエリの終了時刻です。時刻は `yyyy-MM-ddTHH:mm:ssZ` フォーマットで、UTC で表示されます。	2020-09-23T01:01:00Z
RequestId	string	リクエストの ID です。	35D3E3DA-4650-407A-BFF5-59BFF1******
StartTime	string	クエリの開始時刻です。時刻は `yyyy-MM-ddTHH:mm:ssZ` フォーマットで、UTC で表示されます。	2020-09-23T01:00:00Z
DBClusterId	string	クラスターの ID です。	pc-*****************
DBType	string	データベースエンジンのタイプです。	MySQL

例

成功レスポンス

JSONJSON

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "service_connections_ps",
        "Measurement": "PolarProxy_CpuUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "10",
              "Timestamp": 1600822800000
            }
          ]
        },
        "DBNodeId": "pi-*************"
      }
    ]
  },
  "DBVersion": "8.0",
  "EndTime": "2020-09-23T01:01:00Z",
  "RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
  "StartTime": "2020-09-23T01:00:00Z",
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL"
}

エラーコード

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

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

変更履歴

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