DescribeHotBigKeys - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the hot keys and the large keys in the memory in real time.

Operation description

This operation sorts list, hash, set, and zset keys based on the number of elements contained in these keys. The top three keys that contain the most elements are considered large keys. If the number of queries per second (QPS) of a key is greater than 3,000, the key is considered a hot key.

If you use an Alibaba Cloud SDK, make sure that the aliyun-sdk-core version is later than 4.3.3. We recommend that you use the latest version.
The version of Database Autonomy Service (DAS) SDK must be 1.0.2 or later.
If you use an SDK to call API operations of DAS, you must set the region ID to cn-shanghai.
This operation is available only for ApsaraDB for Redis instances that meet the following requirements:
- The instance is a Community Edition instance that uses a major version of 5.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 information about how to query and update the minor version of an instance, see ModifyInstanceMinorVersion and DescribeEngineVersion .

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeHotBigKeys	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ConsoleContext	string	No	The reserved parameter.	None
InstanceId	string	Yes	The ID of the ApsaraDB for Redis instance. You can call the DescribeInstances operation to query the 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 ID.	r-****-db-0

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned message.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	The list of hot keys and large keys.
HotKeys	array<object>	The list of hot keys.
HotKey	object
Key	string	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
Lfu	integer	The statistical value that is calculated based on the least frequently used (LFU) caching algorithm.	253
NodeId	string	The ID of the data shard on the ApsaraDB for Redis instance.	r-x****-db-0
BigKeys	array<object>	The list of large keys.
BigKey	object
Db	integer	The database in which the key is stored.	0
Key	string	The key.	abc:def:eng
KeyType	string	The type of the key.	zset
Size	long	The number of elements in the key.	2
NodeId	string	The ID of the data shard on the ApsaraDB for Redis instance.	r-x****-db-0
HotKeyMsg	string	The reason why the hot key failed to be queried.	current version doesn't support
BigKeyMsg	string	The reason why the large key failed to be queried.	current version doesn't support
Code	string	The HTTP status code returned.	200
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "HotKeys": {
      "HotKey": [
        {
          "Key": "abc:def:eng",
          "Db": 0,
          "Hot": "5500~6000",
          "KeyType": "zset",
          "Lfu": 253,
          "NodeId": "r-x****-db-0"
        }
      ]
    },
    "BigKeys": {
      "BigKey": [
        {
          "Db": 0,
          "Key": "abc:def:eng",
          "KeyType": "zset",
          "Size": 2,
          "NodeId": "r-x****-db-0"
        }
      ]
    },
    "HotKeyMsg": "current version doesn't support",
    "BigKeyMsg": "current version doesn't support"
  },
  "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