DescribeDBInstancePerformance

You can determine the performance of an instance over a specific time range based on its performance metrics. Performance metrics are generated by using one of the following methods based on the database engine and version, RDS edition, monitoring frequency (ModifyDBInstanceMonitor) and query time range:

• For instances that are not running MySQL 5.7 in the High-availability Edition based on standard or enhanced SSDs and those that are not running MariaDB:
  • 5-second monitoring frequency
    • If the query time range is greater than 7 days, performance metrics are collected at 1-day intervals.
    • If the query time range is greater than 1 day but less than or equal to 7 days, performance metrics are collected at 1-hour intervals.
    • If the query time range is greater than 1 hour but less than or equal to 1 day, performance metrics are collected at 1-minute intervals.
    • If the query time range is less than or equal to 1 hour, performance metrics are collected at 5-second intervals.
  • 60-second monitoring frequency
    • If the query time range is greater than 30 days, performance metrics are collected at 1-day intervals.
    • If the query time range is greater than 7 days but less than or equal to 30 days, performance metrics are collected at 1-hour intervals.
    • If the query time range is less than or equal to 7 days, performance metrics are collected at 1-minute intervals.
  • 300-second monitoring frequency
    • If the query time range is greater than 30 days, performance metrics are collected at 1-day intervals.
    • If the query time range is greater than 7 days but less than or equal to 30 days, performance metrics are collected at 1-hour intervals.
    • If the query time range is less than or equal to 7 days, performance metrics are collected at 5-minute intervals.
• For instances that are running MySQL 5.7 in the High-availability Edition based on standard or enhanced SSDs and those that are running MariaDB:
  • If the query time range is greater than 30 days, performance metrics are collected at 1-day intervals.
  • If the query time range is greater than 7 days but less than or equal to 30 days, performance metrics are collected at 1-hour intervals.
  • If the query time range is less than or equal to 7 days, performance metrics are collected at 1-minute intervals.

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>

Sample success responses

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

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

Error codes

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