Queries the details about the performance data of storage-layer ApsaraDB RDS for MySQL.

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
Action String Yes DescribeRDSPerformance

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

DrdsInstanceId String Yes drds*********

The ID of the Distributed Relational Database Service (DRDS) instance.
Keys String Yes MySQL_MemCpuUsage

The performance monitoring metrics. You can specify one or more metrics for a query at a time. Separate multiple metric parameters with commas (,).

Note For more information about the details of performance monitoring metrics, see Storage monitoring.
RdsInstanceId String Yes rm-************

The ID of the storage-layer ApsaraDB RDS for MySQL instance.
StartTime Long No 1603123290000

The start time of the query. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.

EndTime Long No 1603209690000

The end time of the query. Specify the time in the UNIX timestamp format. The time must be in UTC. Unit: ms.

DbInstType String No mysql

The type of the database engine.

Response parameters

Parameter Type Example Description
Data Array of PartialPerformanceData

The result set of the query.
Key String cpuusage

The name of the monitoring metric.
NodeName String pi-*************

The name of the node.

Note This parameter is returned only when the storage type of the database is PolarDB for MySQL. If the storage type of the database is ApsaraDB RDS for MySQL, this parameter is not returned.
NodeNum Integer 1

The number of nodes.
Unit String %

The unit of the monitoring metric.
Values Array of PerformanceValue

The details of the monitoring metric data.
Date Long 1603209660000

The time point when the value of the monitoring metric was obtained. The value is in the UNIX timestamp format. The time is displayed in UTC. Unit: ms.

Value String 0.58

The value of the monitoring metric.
RequestId String DB53EC68-463C-4187-8D2B-C2AD8C******

The ID of the request.
Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://drds.cn-hangzhou.aliyuncs.com/? Action=DescribeRDSPerformance
&DrdsInstanceId=drds*********
&Keys=MySQL_MemCpuUsage
&RdsInstanceId=rm-************
&<Common request parameters>

Sample success responses

XML format 

<DescribeRDSPerformanceResponse>
  <RequestId>DB53EC68-463C-4187-8D2B-C2AD8C******</RequestId>
  <Data>
        <NodeNum>1</NodeNum>
        <Values>
              <Value>0.58</Value>
              <Date>1603209660000</Date>
        </Values>
        <Unit>%</Unit>
        <Key>cpuusage</Key>
  </Data>
  <Data>
        <NodeNum>1</NodeNum>
        <Values>
              <Value>9.75</Value>
              <Date>1603209660000</Date>
        </Values>
        <Unit>%</Unit>
        <Key>memusage</Key>
  </Data>
  <Success>true</Success>
</DescribeRDSPerformanceResponse>

JSON format 

{
	"RequestId": "DB53EC68-463C-4187-8D2B-C2AD8C******",
	"Data": [
		{
			"NodeNum": 1,
			"Values": [
				{
					"Value": "0.58",
					"Date": 1603209660000
				}
			],
			"Unit": "%",
			"Key": "cpuusage"
		},
		{
			"NodeNum": 1,
			"Values": [
				{
					"Value": "9.75",
					"Date": 1603209660000
				}
			],
			"Unit": "%",
			"Key": "memusage"
		}
	],
	"Success": true
}

Error codes

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