You can call this operation to query the data migration status of a specified ApsaraDB for PolarDB cluster.

The performance data is monitored every 60 seconds:

  • When the query range is greater than or equal to 30 days, the data is displayed on a one-day basis.
  • When the query range is greater than or equal to seven days and less than 30 days, the data is displayed on a one-hour basis.
  • When the query range is greater than or equal to one day and less than seven days, the data is displayed on a ten-minute basis.
  • When the query range is less than one day, the data is displayed on a one-minute basis.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
DBClusterId String Yes pc-xxxxxxxxxxxxxxxx

The ID of the ApsaraDB for PolarDB cluster.

EndTime String Yes 2012-06-08T15:00Z

The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Key String Yes PolarDBDiskUsage

The performance indicators you want to query. Multiple indicators are separated by commas (,). For more information, see Performance parameters.

StartTime String Yes 2012-06-08T01:00Z

The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

AccessKeyId String No key-test

The AccessKey ID provided to you by Alibaba Cloud.

Action String No DescribeDBClusterPerformance

The operation that you want to perform. Set the value to DescribeDBClusterPerformance.

Response parameters

Parameter Type Example Description
DBClusterId String pc-xxxxxxxxxxxxxxxx

The ID of the ApsaraDB for PolarDB cluster.

DBType String MySQL

The engine of the database.

DBVersion String 5.6

The version of the database engine.

EndTime String 2012-06-08T15:00Z

The end time of the query. The time is in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

PerformanceKeys

The list of cluster performance items.

PerformanceItem

The value of the cluster performance item.

DBNodeId String pi-xxxxxxxxxxxxxxxx

The ID of the cluster node.

Note This parameter is only valid when cluster indicators such as
PolarDBDiskUsage
are specified.
Measurement String PolarDBDiskUsage

The performance indicator.

MetricName String mean_data_size

The name of the metric.

Points

The array of performance metrics.

PerformanceItemValue

The value of the metric.

Timestamp Long 1571193960000

The timestamp of the monitoring metric. Unit: milliseconds.

Value String 14.25

The value of the metric data.

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

The ID of the request.

StartTime String 2012-06-08T01:00Z

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeDBClusterPerformance
&DBClusterId=pc-xxxxxxxxxxxxxxxx
&EndTime=2012-06-08T15:00Z
&Key=PolarDBDiskUsage
&StartTime=2012-06-08T01:00Z
&<Common request parameters>

Sample success responses

XML format

<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 format

{
	"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"
}

Error codes

For a list of error codes, visit the API Error Center.