Query instance metrics with DescribeMonitorItems - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Note

To improve user experience, Tair has upgraded the monitoring metrics. The DescribeMonitorItems operation is phased out. For more information, see The DescribeMonitorItems operation of Tair (Redis OSS-compatible) is phased out.

After you retrieve the metrics list, call the DescribeHistoryMonitorValues operation to query the monitoring history of the instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeMonitorItems

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8BEB2618-9517-43F3-A233-E0B34512****
MonitorItems	object
KVStoreMonitorItem	array<object>	The returned metrics. Note memoryUsage, GetQps, and PutQps are supported only by Tair 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.
	object
Unit	string	The unit of the metric.	Counts/s
MonitorKey	string	The metric.	select

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.