Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying Disabled Commands for a Redis Instance

Updated on 2025-12-04 GMT+08:00

View PDF

Querying Disabled Commands for a Redis Instance

Function

This API is used to query disabled commands for a 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: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 N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Disabled type 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 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	String	Definition Total number Range N/A
disabled_type	String	Definition Command type Range Enumerated values: command key
commands	Array of strings	Definition This parameter is displayed when disabled_type is set to command. Range Enumerated values: 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. Range N/A

**Table 5** RedisDisabledCommandsDetail
Parameter	Type	Description
db_id	String	Definition Database where a key is located Range N/A
key	String	Definition Key name Range N/A
commands	Array of strings	Definition Command list Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

Querying disabled commands for a redis instance. By default, the first 50 instances are queried.

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

Querying disabled commands for a Redis instance

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

Example Responses

Status code: 200

Successful response

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