Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying Big Keys of a GeminiDB Redis Instance
Updated on 2025-09-16 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 type:

  • GeminiDB Redis

URI

POST /v3/{project_id}/instances/{instance_id}/big-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

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Explanation:

Index position. If offset is set to N, the big key query starts from the N+1 piece of data.

Constraints:

N/A

Values:

≥ 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

Explanation:

Maximum records to be queried

Constraints:

N/A

Values:

1100

Default value:

If this parameter is not transferred, the first 100 big keys are queried by default.

key_types

No

Array of strings

Explanation:

Big key type, which is a string list

Constraints:

N/A

Values:

string, hash, zset, set, list, and stream

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

keys

Array of Table 5 objects

Explanation:

Queried big keys

Values:

N/A

count

Integer

Explanation:

Total number of big keys

Values:

N/A

Table 5 BigKeysInfoResponseBody

Parameter

Type

Description

db_id

Integer

Explanation:

Database where a big key is located

Values:

N/A

key_type

String

Explanation:

Big key type

Values:

  • exhash is also added to the value range of key_types.
  • string
  • hash
  • list
  • zset
  • set
  • exhash
  • stream

key_name

String

Explanation:

Big key name

Values:

N/A

key_size

Integer

Explanation:

Big key length

Values:

N/A

Example Request

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

Example Response

Status code: 200

Successful request

{ 
   "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.