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

Querying Disabled Commands for GeminiDB Redis Instances

Function

This API is used to query disabled commands for GeminiDB Redis instances.

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:listRedisDisabledCommands	read	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:queryRedisDisabledCommands	-

URI

GET /v3/{project_id}/redis/instances/{instance_id}/disabled-commands

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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Disabled type, which is used to specify whether to query disabled commands or keys. Constraints N/A Range command key Default Value N/A
offset	No	Integer	Definition Index position. If offset is set to N, the command 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
total_count	Integer	Definition Total number of disabled commands or keys. Range N/A
disabled_type	String	Definition Disabled type. Range command key
commands	Array of strings	Definition List of disabled commands. This parameter is displayed when disabled_type is set to command. keys hkeys hvals hgetall smembers flushdb flushall
keys	Array of objects in Table 5	Definition This parameter is displayed when disabled_type is set to key. A maximum of 20 keys are supported.

**Table 5** RedisDisabledCommandsDetail
Parameter	Type	Description
db_id	String	Definition ID of the Redis database containing the key. Range N/A
key	String	Definition Key name in Redis. Range N/A
commands	Array of strings	Definition Command list.

Example Requests

Querying disabled commands for GeminiDB Redis instances (default: the first 50 instances)

GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands?type=command

Querying disabled commands for GeminiDB Redis instances

GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands?type=key&offset=0&limit=10

Example Responses

Status code: 200

Success

{ 
  "total_count" : 2, 
  "disabled_type" : "key", 
  "keys" : [ { 
    "db_id" : "0", 
    "key" : "name", 
    "commands" : [ "get" ] 
  }, { 
    "db_id" : "0", 
    "key" : "address", 
    "commands" : [ "get", "set" ] 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances