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

Updated on 2025-10-17 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.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A
instance_id	Yes	String	Explanation: 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 Values: N/A Default value: N/A

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

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints: N/A Values: 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	Explanation: Queried hot keys. Values: N/A
count	Integer	Explanation: Total number Values: N/A

**Table 5** HotKeysInfoRsponseBody
Parameter	Type	Description
name	String	Explanation: Hot key name Values: N/A
type	String	Explanation: Hot key type Values: string hash list zset set exhash stream
command	String	Explanation: Hot key command Values: N/A
qps	Integer	Explanation: Hot key QPS Values: N/A
db_id	Integer	Explanation: Database where a hot key is located Values: 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 Request

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

GET https://{endpoint}/v30549b4a43100d4f32f51c01c2fe4acdb/instances/91b5c48e11bf4913b35814f28b8f79f2in12/hot-keys

Example Response

Status code: 200

Successful request

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