DescribeDBProxyPerformance操作を呼び出して、ApsaraDB RDSインスタンスのデータベースプロキシのパフォーマンスメトリックを照会できます。

DescribeDBProxyPerformance操作を呼び出す前に、インスタンスのデータベースプロキシ機能を有効にするためにModifyDBProxy操作が呼び出されていることを確認してください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 DescribeDBProxyPerformance

実行する操作です。 値をDescribeDBProxyPerformanceに設定します。

DBInstanceId String 必須 rm-t4n3axxxxx

インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

DBProxyInstanceType String 任意 DedicatedProxy

インスタンスで有効になっているプロキシのタイプ。 値をDedicatedProxyに設定します。

StartTime String 必須 2019-09-19T01:00:00Z

クエリする期間の開始時刻です。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

EndTime String 必須 2019-09-21T18:00:00Z

クエリする期間の終了時刻を設定します。 終了時刻は開始時刻よりも後の時刻にする必要があります。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

RegionId String 必須 cn-hangzhou

インスタンスが設置されているリージョンの ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

MetricsName String 必須 Maxscale_CpuUsage

クエリするパフォーマンス指標。

インスタンスがMySQLを実行する場合、インスタンスのCPU使用率を示すMaxscale_CpuUsageパフォーマンスメトリックのみを照会できます。

インスタンスがPostgreSQLを実行している場合、次のパフォーマンスメトリックを照会できます。

  • Maxscale_TotalConns: 1秒あたりの接続数
  • Maxscale_CurrentConns: 確立されている接続の数
  • Maxscale_DownFlows: アウトバウンドトラフィック
  • Maxscale_UpFlows: インバウンドトラフィック
  • Maxscale_QPS: QPS
  • Maxscale_MemUsage: メモリ使用量
  • Maxscale_CpuUsage: CPU使用率

複数のパフォーマンスメトリックをクエリする場合は、パフォーマンスメトリックをコンマ (,) で区切ります。 1つのリクエストで最大6つのパフォーマンスメトリックを指定できます。

DBProxyEngineType String 任意 normal

内部パラメーター。 指定する必要はありません。

レスポンスパラメーター

項目 データ型 例: 説明　
EndTime String 2019-09-21T18:00:00Z

照会される時間範囲の終わり。

StartTime String 2019-09-19T01:00:00Z

照会される時間範囲の始まり。

DBInstanceId String lsmexxxxxxx

インスタンスの ID です。

RequestId String DD31056F-A0CE-41D7-AD39-689B6ABAE982

リクエストの ID です。

DBProxyEngineType String normal

内部パラメーター。 指定する必要はありません。

PerformanceKeys PerformanceKeyの配列

返されるパフォーマンスメトリックで構成される配列。

PerformanceKey
ValueFormat String docker_container_cpu

パフォーマンスメトリックの値が返される形式。

Key String cpu_ratio

パフォーマンスメトリックの名前。

値 PerformanceValueの配列

次の形式のパフォーマンスメトリックの値で構成される配列: {value1, value2, ...} 。

パフォーマンス値
日付 String 2019-10-10T09:00:00Z

パフォーマンスメトリックの値が記録された時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

値 String 2.83

パフォーマンスメトリックの値。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeDBProxyPerformance
&RegionId=cn-hangzhou
&DBInstanceId=rm-t4n3axxxxx
&MetricsName=Maxscale_CpuUsage
&StartTime=2019-09-19T01:00:00Z
&EndTime=2019-09-21T18:00:00Z
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBProxyPerformanceResponse>
<DBInstanceId>lsmexxxxxxx</DBInstanceId>
<RequestId>DD31056F-A0CE-41D7-AD39-689B6ABAE982</RequestId>
<PerformanceKeys>
    <PerformanceKey>
        <値>
            <PerformanceValue>
                <Value>2.83</Value>
                <Date>2019-10-10T09:00:00Z</Date>
            </PerformanceValue>
        </値>
        <キー> cpu_ratio</キー>
        <ValueFormat>docker_container_cpu</ValueFormat>
    </PerformanceKey>
</PerformanceKeys>
<EndTime>2019-10-10T09:39:28Z</EndTime>
<StartTime>2019-10-01T09:39:28Z</StartTime>
</DescribeDBProxyPerformanceResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DBInstanceId" : "lsmexxxxxxx" 、
  "RequestId" : "DD31056F-A0CE-41D7-AD39-689B6ABAE982" 、
  "PerformanceKeys" : {
    "PerformanceKey" : [ {
      "Values" : {
        "PerformanceValue" : [ {
          "値" : "2.83" 、
          "Date" : "2019-10-10T09:00:00Z"
        } ]
      },
      "キー" : "cpu_ratio" 、
      "ValueFormat" : "docker_container_cpu"
    } ]
  },
  "EndTime" : "2019-10-10T09:39:28Z" 、
  "StartTime" : "2019-10-01T09:39:28Z"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidDBInstanceName.NotFound 指定された DB インスタンス名は存在しません。 インスタンスの名前が見つからない場合に返されるエラーメッセージ。
400 InvalidDBInstanceName 指定されたパラメーターDBInstanceNameは無効です。 DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。 値がnullまたは空の文字列であるかどうかを確認します。
404 Endpoint.NotFound 指定されたエンドポイントが見つかりません。 指定したポート番号が見つからない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。