この API を呼び出して、指定した ApsaraDB for POLARDB クラスターのデータ移行ステータスを照会できます。

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

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

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須/任意 説明
DBClusterId String 必須 pc-xxxxxxxxxxxxxxxx

ApsaraDB for POLARDB クラスターの 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 任意 DescribeDBClusterPerformance

実行する API ( DescribeDBClusterPerformance) を設定します。

レスポンスパラメーター

パラメーター データ型 説明
DBClusterId String pc-xxxxxxxxxxxxxxxx

ApsaraDB for POLARDB クラスターの ID を示します。

DBType String MySQL

データベースのエンジンを示します。

DBVersion String 5.6

データベースエンジンのバージョンを示します。

EndTime String 2012-06-08T15:00Z

クエリの終了時刻を示します。 時刻は yyyy-MM-ddTHH:mmZ の形式です。 時刻は UTC で表示されます。

PerformanceKeys

クラスターのパフォーマンス項目のリストを示します。

PerformanceItem

クラスターのパフォーマンス項目の値を示します。

DBNodeId String pi-xxxxxxxxxxxxxxxx

クラスターノードの ID を示します。

このパラメーターは、
PolarDBDiskUsage
のようなクラスター指標が指定されている場合にのみ有効です。
Measurement String PolarDBDiskUsage

パフォーマンス指標を示します。

MetricName String mean_data_size

メトリックの名前を示します。

Points

パフォーマンスメトリックの配列を示します。

PerformanceItemValue

メトリックの値を示します。

Timestamp Long 1571193960000

モニタリングメトリックのタイムスタンプを示します。 単位はミリ秒です。

Value String 14.25

メトリックデータの値を示します。

RequestId String A5409D02-D661-4BF3-8F3D-0A814D0574E7

リクエストの ID を示します。

StartTime String 2012-06-08T01:00Z

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

コーディング例

リクエストの例


http(s)://[Endpoint]/? Action=DescribeDBClusterPerformance
&DBClusterId=pc-xxxxxxxxxxxxxxxx
&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>
    <DBClusterId>pc-xxxxxxxxxxxxxxxx</DBClusterId>
    <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",
		"DBClusterId":"pc-xxxxxxxxxxxxxxxx"
	},
	"code":"200"
}

エラーコード

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