All Products
Document Center


Last Updated:Feb 20, 2024

Queries the metrics of an ApsaraDB for Redis instance.

Operation description

Note ApsaraDB for Redis has upgraded the monitoring metrics. The DescribeMonitorItems operation is phased out. For more information, see The DescribeMonitorItems operation supported by ApsaraDB for Redis is phased out.

After you call this operation to retrieve a list of metrics for a specified ApsaraDB for Redis instance, you can call the DescribeHistoryMonitorValues operation to query monitoring history of the instance.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
  • All Resources

Request parameters

The current API does not require request parameters

Response parameters


The ID of the request.

MonitorItemsobject []

The returned metrics.

  • memoryUsage, GetQps, and PutQps are supported only by ApsaraDB for Redis instances that use Redis 4.0 or later. GetQps and PutQps require the latest minor version. You can upgrade the major version or minor version of the instance as needed. For more information, see Upgrade the major version and Upgrade the minor version.
  • When you use instances of Redis 2.8, if the hit_rate metric is not displayed, you must upgrade the minor version of the instance. For more information, see Upgrade the minor version.
  • Unitstring

    The unit of the metric.


    The metric.



    Sample success responses


      "RequestId": "8BEB2618-9517-43F3-A233-E0B34512****",
      "MonitorItems": {
        "KVStoreMonitorItem": [
            "Unit": "Counts/s",
            "MonitorKey": "select"

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history