DescribeDBInstancePerformance

You can view the performance data of an instance over a specified period of time based on the performance parameters. Based on different editions, monitoring frequencies (ModifyDBInstanceMonitor), and query time ranges, three output formats are provided as follows:

• For editions excluding MySQL 5.7 High-availability Edition (with SSDs) and MariaDB editions
  • The monitoring frequency is 5 seconds:
    • When the query time range is greater than 7 days, the performance data is collected at 1-day intervals.
    • When the query time range is greater than 1 day but less than or equal to 7 days, the performance data is collected at 1-hour intervals.
    • When the query time range is greater than 1 hour but less than or equal to 1 day, the performance data is collected at 1-minute intervals.
    • When the query time range is less than or equal to 1 hour, the performance data is collected at 5-minute intervals.
  • The monitoring frequency is 60 seconds:
    • When the query time range is greater than 30 days, the performance data is collected at 1-day intervals.
    • When the query time range is greater than 7 days but less than or equal to 30 days, the performance data is collected at 1-hour intervals.
    • When the query time range is less than or equal to 7 days, the performance data is collected at 1-minute intervals.
  • The monitoring frequency is 300 seconds.
    • When the query time range is greater than 30 days, the performance data is collected at 1-day intervals.
    • When the query time range is greater than 7 days but less than or equal to 30 days, the performance data is collected at 1-hour intervals.
    • When the query time range is less than or equal to 7 days, the performance data is collected at 5-minute intervals.
• For MySQL 5.7 High-availability Edition (with SSDs) and MariaDB editions
  • When the query time range is greater than 30 days, the performance data is collected at 1-day intervals.
  • When the query time range is greater than 7 days but less than or equal to 30 days, the performance data is collected at 1-hour intervals.
  • When the query time range is less than or equal to 7 days, the performance data is collected at 1-minute intervals.

Debugging

You can use OpenAPI Explorer to perform debugging. OpenAPI Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Response parameters

Examples

Sample requests

http(s)://rds.aliyuncs.com/? Action=DescribeDBInstancePerformance
&DBInstanceId= rm-uf6wjk5xxxxxxx 
&Key=MySQL_Sessions
&StartTime=2012-06-08T15:00Z 
&EndTime=2012-06-18T15:00Z 
&<Common request parameters>

Successful response examples

XML format

<DescribeDBInstancePerformanceResponse>
	  <RequestId>A5409D02-D661-4BF3-8F3D-0A814D0574E7</RequestId>
	  <DBInstanceID> rm-uf6wjk5xxxxxxx</DBInstanceID>
	  <StartTime>2012-06-11T15:00Z</StartTime>
	  <EndTime>2013-10-17T15:00Z</EndTime>
	  <Engine>MySQL</Engine>
	  <PerformanceKeys>
		    <PerformanceKey>
			      <Key>MySQL_NetworkTraffic</Key>
			      <Unit>KB</Unit>
			      <ValueFormat>recv_k&amp;sent_k</ValueFormat>
			      <Values></Values>
		    </PerformanceKey>
	  </PerformanceKeys></DescribeDBInstancePerformanceResponse>

JSON format

{
	"DBInstanceID":" rm-uf6wjk5xxxxxxx",
	"RequestId":"A5409D02-D661-4BF3-8F3D-0A814D0574E7",
	"PerformanceKeys":{
		"PerformanceKey":[
			{
				"Values":{
					"PerformanceValue":[]
				},
				"Key":"MySQL_NetworkTraffic",
				"Unit":"KB",
				"ValueFormat":"recv_k&sent_k"
			}
		]
	},
	"EndTime":"2013-10-17T15:00Z",
	"StartTime":"2012-06-11T15:00Z",
	"Engine":"MySQL"
}

Error codes

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