DescribeHotKeys - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the hot keys of an ApsaraDB for Redis instance.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK, make sure that the aliyun-sdk-core version is later than V4.3.3. We recommend that you use the latest version.
The version of your Database Autonomy Service (DAS) SDK must be V1.0.2 or later.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.
This operation is applicable only to ApsaraDB for Redis instances that meet the following requirements:
- The ApsaraDB for Redis instance is a Community Edition instance that uses a major version of 4.0 or later or a performance-enhanced instance of the Enhanced Edition (Tair).
- The ApsaraDB for Redis instance is updated to the latest minor version.

Note For more information about how to query and update the minor version of an instance, see ModifyInstanceMinorVersion and DescribeEngineVersion .

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:DescribeHotKeys	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraDB for Redis instance. You can call the DescribeInstances operation to query the instance ID.	r-bp18ff4a195d****
NodeId	string	No	The ID of the data shard on the ApsaraDB for Redis instance. You can call the DescribeRoleZoneInfo operation to query the data shard ID.	r-x****-db-0

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	array<object>	The details of the hot keys.
HotKey	object
Key	string	The name of the key.	abc:def:eng
Db	integer	The database in which the key is stored.	0
Hot	string	The frequency at which the key is accessed, which indicates the queries per second (QPS) of the key.	5500~6000
KeyType	string	The type of the key.	zset
Size	long	The number of elements in the key.	2
Code	string	The HTTP status code returned.	200
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "HotKey": [
      {
        "Key": "abc:def:eng",
        "Db": 0,
        "Hot": "5500~6000",
        "KeyType": "zset",
        "Size": 2
      }
    ]
  },
  "Code": "200",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Change history

Change time	Summary of changes	Operation

No change history