Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying Hot Keys of a Redis Instance

Updated on 2025-12-04 GMT+08:00

View PDF

Querying Hot Keys of a Redis Instance

Function

This API is used to query hot keys of a Redis instance.

Constraints

This API supports only GeminiDB Redis instances.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:getHotKeys	read	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:getHotKeys	-

URI

GET /v3/{project_id}/instances/{instance_id}/hot-keys

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID, which can be obtained by following Querying Instances and Details. If you do not have an instance, you can call the API by following Creating an Instance. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index position. If offset is set to N, the hot key information is queried from the N+1 piece of data. Constraints N/A Range ≥ 0 Default Value 0
limit	No	Integer	Definition Maximum records to be queried Constraints N/A Range 1~50 Default Value 50

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
keys	Array of objects in Table 5	Definition Queried hot keys. Range N/A
count	Integer	Definition Total number Range N/A

**Table 5** HotKeysInfoRsponseBody
Parameter	Type	Description
name	String	Definition Hot key name Range N/A
type	String	Definition Hot key type Range string hash list zset set exhash stream
command	String	Definition Hot key command Range N/A
qps	Integer	Definition Hot key QPS Range N/A
db_id	Integer	Definition Database where a hot key is located Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

Querying the first 30 keys (hot keys) in a Redis instance

GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/91b5c48e11bf4913b35814f28b8f79f2in12/hot-keys

Example Responses

Status code: 200

Successful response

{ 
  "keys" : [ { 
    "name" : "address", 
    "type" : "String", 
    "command" : "set", 
    "qps" : 3000, 
    "db_id" : 0 
  } ], 
  "count" : 1 
}