Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Deleting Disabled Commands for a Redis Instance
Updated on 2025-09-04 GMT+08:00

Deleting Disabled Commands for a Redis Instance

Function

This API is used to delete disabled commands for a Redis instance.

Constraints

This API supports only GeminiDB Redis instances.

URI

DELETE https://{Endpoint}/v3/{project_id}/redis/instances/{instance_id}/disabled-commands

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

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

disabled_type

Yes

String

Explanation:

Disabled type

Constraints:

N/A

Values:

Enumerated values:

  • command
  • key

Default value:

N/A

commands

No

Array of strings

Explanation:

This parameter is transferred when disabled_type is set to command.

Constraints:

N/A

Values:

Enumerated values:

  • keys
  • hkeys
  • hvals
  • hgetall
  • smembers
  • flushdb
  • flushall

Default value:

N/A

keys

No

Array of objects in Table 4

Explanation:

This parameter is transferred when disabled_type is set to key.

Constraints:

A maximum of 20 keys are supported.

Values:

N/A

Default value:

N/A

Table 4 RedisDisabledCommandsDetail

Parameter

Mandatory

Type

Description

db_id

Yes

String

Explanation:

Database where a key is located

Constraints:

N/A

Values:

N/A

Default value:

N/A

key

Yes

String

Explanation:

Key name

Constraints:

N/A

Values:

N/A

Default value:

N/A

commands

Yes

Array of strings

Explanation:

Command list

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

  • Deleting a disabled command for a Redis instance
    DELETE https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands 
      
     { 
       "disabled_type" : "command", 
       "commands" : [ "keys", "hkeys" ] 
     }
  • Deleting disabled commands for a Redis instance
    DELETE 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 Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.