DescribeTopBigKeys - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the top 100 large keys over a period of time.

Operation description

The list, hash, set, and zset keys are sorted based on the number of elements in these keys. The top three keys that have the most elements are considered large keys.

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 an ApsaraDB for Redis instance of one of the following versions:
- The instance is ApsaraDB for Redis Community Edition instances that use a major version of 5.0 or later or a performance-enhanced instance of the ApsaraDB for Redis 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

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:DescribeTopBigKeys	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-x****-db-0
StartTime	string	Yes	The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1596177993000
EndTime	string	Yes	The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note The end time must be later than the start time. Only data within the last four days can be queried. The maximum interval between the start time and the end time is 3 hours.	1596177993001

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned message.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	array<object>	The detailed information about the large keys. Note This parameter is left empty If no large keys exist within the specified time range.
BigKey	object
Key	string	The key.	abc:def:eng
Db	integer	The database in which the key is stored.	0
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
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": {
    "BigKey": [
      {
        "Key": "abc:def:eng",
        "Db": 0,
        "KeyType": "zset",
        "Size": 2,
        "NodeId": "r-x****-db-0"
      }
    ]
  },
  "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