文档首页/云数据库 GeminiDB/API参考/API v3（推荐）/实例管理/设置Redis禁用命令 - DisablingCommandsforaRedisInstance
更新时间：2026-03-24 GMT+08:00
查看PDF
分享

设置Redis禁用命令 - DisablingCommandsforaRedisInstance

功能介绍

设置Redis禁用命令。

接口约束

该接口只支持GeminiDB Redis数据库实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可以调用查询实例列表和详情 - QueryingInstancesandDetails接口获取。如果未申请实例，可以调用创建实例 - CreatinganInstance接口创建。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

disabled_type

是

String

参数解释：

禁用类型。

约束限制：

不涉及。

取值范围：

  • command：表示禁用的类型是命令。
  • key：表示禁用的类型是key。

默认取值：

不涉及。

commands

否

Array of strings

参数解释：

disabled_type为command时传入该参数。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

keys

否

Array of 表4 objects

参数解释：

disabled_type为key时传入该参数。

约束限制：

最多20个key。

取值范围：

不涉及。

默认取值：

不涉及。

表4 RedisDisabledCommandsDetail

参数

是否必选

参数类型

描述

db_id

是

String

参数解释：

key所在的DB。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

key

是

String

参数解释：

key名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

commands

是

Array of strings

参数解释：

命令列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置Redis禁用命令。

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" ] 
  } ] 
}

响应示例

无。

状态码

请参见状态码。

错误码

请参见错误码。

父主题：实例管理

相关文档