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

Disabling Commands for a GeminiDB Redis Instance

Function

This API is used to disable commands for a GeminiDB 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:setRedisDisabledCommands	write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:setRedisDisabledCommands	-

URI

POST /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

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
disabled_type	Yes	String	Definition Disabled type Constraints N/A Range command key Default Value N/A
commands	No	Array of strings	Definition This parameter is transferred when disabled_type is set to command. List of disabled commands. Each element is a Redis command name. keys: disables the search for keys in fuzzy mode. hkeys: disables the display of the list of hash field names. hvals: disables the display of the list of hash values. hgetall: disables the reading of all hash fields and values at a time. smembers: disables the display of all members in a set. flushdb: disables the clearing of data in the current database. flushall: disables the clearing of data in all databases. Constraints N/A
keys	No	Array of objects in Table 4	Definition This parameter is transferred when disabled_type is set to key. Constraints A maximum of 20 keys are supported.

**Table 4** RedisDisabledCommandsDetail
Parameter	Mandatory	Type	Description
db_id	Yes	String	Definition Database where a key is located Constraints N/A Range N/A Default Value N/A
key	Yes	String	Definition Key name in Redis, which is used to specify the key for which commands are to be disabled. Constraints N/A Range N/A Default Value N/A
commands	Yes	Array of strings	Definition List of commands disabled for the key. Each element is a Redis command name. Constraints N/A

Response Parameters

Status code: 200

No response parameters

Example Requests

Disabling commands for a GeminiDB Redis instance

POST https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands 
 
{ 
  "disabled_type" : "key", 
  "keys" : [ { 
    "db_id" : "0", 
    "key" : "name", 
    "commands" : [ "get" ] 
  }, { 
    "db_id" : "0", 
    "key" : "address", 
    "commands" : [ "get", "set" ] 
  } ] 
}

Example Responses

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances