この操作を呼び出すと、指定した ApsaraDB for POLARDB クラスターのノードのパフォーマンスデータを照会できます。

パフォーマンスデータは 60 秒ごとにモニタリングされます。

  • 照会期間が 30 日以上の場合、データは 1 日単位で表示されます。
  • 照会期間が 7 日以上 30 日未満の場合、データは 1 時間単位で表示されます。
  • 照会期間が 1 日以上 7 日未満の場合、データは 10 分単位で表示されます。
  • 照会期間が 1 日未満の場合、データは 1 分単位で表示されます。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須項目 説明
DBNodeId String はい pi-xxxxxxxxxxxxxxx

クラスターノードの ID。

EndTime String はい 2012-06-08T15:00Z

照会する期間の終了日時。 日時を yyyy-MM-ddTHH:mmZ の形式で指定します。 日時は UTC である必要があります。

Key String はい PolarDBDiskUsage

照会するパフォーマンス指標。 指標が複数ある場合はコンマ (,) で区切ります。 詳細については、「パフォーマンスパラメーター」をご参照ください。

StartTime String はい 2012-06-08T01:00Z

照会する期間の開始日時。 日時を yyyy-MM-ddTHH:mmZ の形式で指定します。 日時は UTC である必要があります。

AccessKeyId String いいえ key-test

Alibaba Cloud から提供された AccessKey ID を設定します。

Action String いいえ DescribeDBNodePerformance

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

レスポンスパラメーター

パラメーター データ型 説明
DBNodeId String pi-xxxxxxxxxxxxxxx

クラスターノードの ID。

DBType String MySQL

データベースのエンジン。

DBVersion String 5.6

データベースエンジンのバージョン。

EndTime String 2012-06-08T15:00Z

照会の終了日時。 日時は yyyy-MM-ddTHH:mmZ 形式です。 日時は UTC で表示されます。

PerformanceKeys

クラスターパフォーマンスデータのリスト。

PerformanceItem

クラスターのパフォーマンス項目の値。

Measurement String PolarDBDiskUsage

パフォーマンス指標。

MetricName String mean_data_size

メトリックの名前。

Points

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

PerformanceItemValue

メトリックの値。

Timestamp Long 1571193960000

モニタリングメトリックのタイムスタンプ。 単位: ミリ秒。

Value String 14.25

メトリックデータの値。

RequestId String A0ADCEAF-3277-48DE-B66D-4B67B120916C

リクエストの ID。

StartTime String 2012-06-08T01:00Z

照会の開始日時。 日時は yyyy-MM-ddTHH:mmZ の形式です。 日時は UTC で表示されます。

リクエストの例


http(s)://[Endpoint]/? Action=DescribeDBNodePerformance
&DBNodeId=pi-xxxxxxxxxxxxxxx
&EndTime=2012-06-08T15:00Z
&Key=PolarDBDiskUsage
&StartTime=2012-06-08T01:00Z
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式

<code>200</code>
<data>
    <PerformanceKeys>
        <PerformanceItem>
            <Measurement>PolarDBDiskUsage</Measurement>
            <MetricName>mean_data_size</MetricName>
            <Points>
                <PerformanceItemValue>
                    <Timestamp>1571193960000</Timestamp>
                    <Value>14.25</Value>
                </PerformanceItemValue>
            </Points>
        </PerformanceItem>
    </PerformanceKeys>
    <DBVersion>5.6</DBVersion>
    <RequestId>A0ADCEAF-3277-48DE-B66D-4B67B120916C</RequestId>
    <EndTime>2012-06-08T15:00Z</EndTime>
    <StartTime>2012-06-08T01:00Z</StartTime>
    <DBNodeId>pi-xxxxxxxxxxxxxxxx</DBNodeId>
    <DBType>MySQL</DBType>
</data>
<requestId>A0ADCEAF-3277-48DE-B66D-4B67B120916C</requestId>
<successResponse>true</successResponse>

JSON 形式

{
	"successResponse":true,
	"requestId":"A0ADCEAF-3277-48DE-B66D-4B67B120916C",
	"data":{
		"DBVersion":"5.6",
		"RequestId":"A0ADCEAF-3277-48DE-B66D-4B67B120916C",
		"DBType":"MySQL",
		"PerformanceKeys":{
			"PerformanceItem":[
				{
					"Measurement":"PolarDBDiskUsage",
					"MetricName":"mean_data_size",
					"Points":{
						"PerformanceItemValue":[
							{
								"Value":"14.25",
								"Timestamp":1571193960000
							}
						]
					}
				}
			]
		},
		"EndTime":"2012-06-08T15:00Z",
		"StartTime":"2012-06-08T01:00Z",
		"DBNodeId":"pi-xxxxxxxxxxxxxxxx"
	},
	"code":"200"
}

エラーコード

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