All Products
Search

This Product

    ApsaraDB RDS:DescribeDBInstancePerformance

    Document Center

    ApsaraDB RDS:DescribeDBInstancePerformance

    Last Updated:May 29, 2023

    You can call the DescribeDBInstancePerformance operation to query the performance metrics of an instance.

    Operation Description

    You can query 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 do not run MySQL on RDS High-availability Edition with standard SSDs or enhanced SSDs (ESSDs) and those that do not run MariaDB:

      • 5-second monitoring frequency

        • If the query time range is greater than seven days, performance metrics are collected at 1-day intervals.
        • If the query time range is greater than one day but less than or equal to seven days, performance metrics are collected at 1-hour intervals.
        • If the query time range is greater than or equal to an hour but less than or equal to one day, performance metrics are collected at 1-minute intervals.
        • If the query time range is less than an 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 seven 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 seven 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 seven 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 seven days, performance metrics are collected at 5-minute intervals.

    • For instances that are running MySQL on RDS High-availability Edition with standard SSDs or ESSDs 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 seven 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 seven days, performance metrics are collected at 1-minute intervals.

    • For instances that run PostgreSQL with local SSDs, standard SSDs, or ESSDs:

      • If the query time range is less than or equal to an hour, performance metrics are collected at 5-second intervals.
      • If the query time range is less than or equal to 2 hours, performance metrics are collected at 10-second intervals.
      • If the query time range is less than or equal to 6 hours, performance metrics are collected at 30-second intervals.
      • If the query time range is less than or equal to 12 hours, performance metrics are collected at 1-minute intervals.
      • If the query time range is less than or equal to one day, performance metrics are collected at 2-minute intervals.
      • If the query time range is less than or equal to five days, performance metrics are collected at 10-minute intervals.
      • If the query time range is less than or equal to 15 days, performance metrics are collected at 30-minute intervals.
      • If the query time range is less than or equal to 30 days, performance metrics are collected at 1-hour intervals.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:DescribeDBInstancePerformanceREAD
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

    		 rm-uf6wjk5xxxxxxx
    KeystringYes

    The performance metric that you want to query. If you enter more than one performance metric, separate them with commas (,). You can enter up to 30 performance metrics. For more information, see Performance parameters.

    NoteIf you set the Key parameter to MySQL_SpaceUsage or SQLServer_SpaceUsage, you can query the performance metric only over one day.
    		MySQL_Sessions
    StartTimestringYes

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

    NoteThe time span between the beginning time and the end time must be longer than the monitoring frequency. Otherwise, this operation may return an empty array.
    		2012-06-08T15:00Z
    EndTimestringYes

    The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

    NoteThe time span between the beginning time and the end time must be longer than the monitoring frequency. Otherwise, this operation may return an empty array.
    		2012-06-18T15:00Z
    NodeIdstringNo

    The unique ID of the instance.

    		339****

    Response parameters

    ParameterTypeDescriptionExample
    object
    EndTimestring

    The end of the time range that is queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

    		2012-06-19T15:00Z
    StartTimestring

    The beginning of the time range that is queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

    		2012-06-10T15:00Z
    DBInstanceIdstring

    The ID of the instance.

    		rm-uf6wjk5xxxxxxxxxx
    Enginestring

    The database engine of the instance.

    		MySQL
    RequestIdstring

    The ID of the request.

    		A5409D02-D661-4BF3-8F3D-0A814D0574E7
    PerformanceKeysobject []

    An array that consists of performance metrics.

    Keystring

    The name of the performance metric.

    		MySQL_Sessions
    ValueFormatstring

    The format in which the value of the performance metric is returned. Multiple values of the performance metric are separated by the & string. Example: com_delete&com_insert&com_insert_select&com_replace.

    		recv_k&sent_k
    Unitstring

    The unit of the performance metric.

    		KB
    Valuesobject []

    An array that consists of the values of the performance metric in the following format: {value1, value2, ...}.

    Datestring

    The date and time when the value of the performance metric was recorded. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2011-05-30T03:29:00Z
    Valuestring

    The value of the performance metric.

    		0.0&13.6

    Examples

    Sample success responses

    JSONformat

    {
  "EndTime": "2012-06-19T15:00Z",
  "StartTime": "2012-06-10T15:00Z",
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
  "Engine": "MySQL",
  "RequestId": "A5409D02-D661-4BF3-8F3D-0A814D0574E7",
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "Key": "MySQL_Sessions",
        "ValueFormat": "recv_k&sent_k",
        "Unit": "KB",
        "Values": {
          "PerformanceValue": [
            {
              "Date": "2011-05-30T03:29:00Z",
              "Value": "0.0&13.6"
            }
          ]
        }
      }
    ]
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.