All Products
Search
Document Center

Database Autonomy Service:DescribeTopHotKeys

Last Updated:Sep 25, 2024

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

Operation description

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 an ApsaraDB for Redis instance of one of the following versions:

    • The 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 information about how to query and update the minor version of an instance, see DescribeEngineVersion and ModifyInstanceMinorVersion .

Debugging

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
hdm:DescribeTopHotKeysget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConsoleContextstringNo

The reserved parameter.

None
InstanceIdstringYes

The ID of the ApsaraDB for Redis instance. You can call the DescribeInstances operation to query the ID.

r-bp18ff4a195d****
NodeIdstringNo

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
StartTimestringYes

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
EndTimestringYes

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

ParameterTypeDescriptionExample
object
Messagestring

The returned message.

Successful
RequestIdstring

The request ID.

B6D17591-B48B-4D31-9CD6-9B9796B2****
Dataarray<object>

The detailed information about the hot keys.

HotKeyobject
Dbinteger

The database in which the key is stored.

0
Keystring

The key.

abc:def:eng
Hotstring

The frequency at which the key is accessed, which indicates the QPS of the key.

5500~6000
KeyTypestring

The type of the key.

zset
Lfuinteger

The statistical value that is calculated based on the least frequently used (LFU) caching algorithm.

253
NodeIdstring

The ID of the data shard on the ApsaraDB for Redis instance.

r-x****-db-0
Codestring

The HTTP status code returned.

200
Successstring

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": {
    "HotKey": [
      {
        "Db": 0,
        "Key": "abc:def:eng",
        "Hot": "5500~6000",
        "KeyType": "zset",
        "Lfu": 253,
        "NodeId": "r-x****-db-0"
      }
    ]
  },
  "Code": "200",
  "Success": "true"
}

Error codes

HTTP status codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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

Change history

Change timeSummary of changesOperation
No change history