Updated on 2026-09-22 GMT+08:00

Querying Big Keys of a GeminiDB Redis Instance

Function

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

Constraints

This API supports the following instance:

GeminiDB Redis

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:getBigKeys	Read	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:getBigKeys	-

URI

POST /v3/{project_id}/instances/{instance_id}/big-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 The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index position. If offset is set to N, the big key query starts from the N+1 piece of data. Constraints N/A Range ≥ 0 Default Value If this parameter is not transferred, offset is set to 0 by default, indicating that the query starts from the first big key.
limit	No	Integer	Definition Maximum records to be queried Constraints N/A Range 1–100 Default Value If this parameter is not transferred, the first 100 big keys are queried by default.
key_types	No	Array of strings	Definition Big key type, which is a string list Constraints The following types are supported: string, hash, zset, set, list, stream, and exhash.

Response Parameters

Status code: 200

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

**Table 5** BigKeysInfoResponseBody
Parameter	Type	Description
db_id	Integer	Definition Database where a big key is located Range N/A
key_type	String	Definition Big key type Range String Hash List Zset Set Exhash Stream
key_name	String	Definition Big key name Range N/A
key_size	Integer	Definition Big key length, in bytes Range N/A

Example Requests

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/91b5c48e11bf4913b35814f28b8f79f2in12/big-keys 
  
 { 
   "key_types" : [ "string", "hash", "zset", "set", "list", "stream" ] 
 }

Example Responses

Status code: 200

Success

{ 
   "keys" : [ { 
     "db_id" : 0, 
     "key_type" : "String", 
     "key_name" : "a", 
     "key_size" : 12 
   } ], 
   "count" : 1 
 }

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances