更新时间:2024-12-02 GMT+08:00
分享

查询Redis禁用命令

功能介绍

查询Redis禁用命令。

接口约束

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

type

String

禁用类型。

枚举值:

  • command
  • key

offset

Integer

索引位置偏移量,表示从指定offset条数据后查询对应的实例信息。取值大于或等于0。不传该参数时,查询偏移量默认为0。

limit

Integer

查询专属资源个数上限值。

  • 取值范围:1~50。不传该参数时,默认查询前50条实例信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_count

String

总数。

disabled_type

String

命令类型。

枚举值:

  • command
  • key

commands

Array of strings

disabled_type为command时展示该参数。

枚举值:

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

keys

Array of 表5 objects

disabled_type为key时展示该参数,最多20个。

表5 RedisDisabledCommandsDetail

参数

参数类型

描述

db_id

String

key所在的DB。

key

String

key名。

commands

Array of strings

命令列表。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 查询Redis禁用命令,默认查询前50个实例。
    GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands?type=command
  • 查询Redis禁用命令。
    GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands?type=key&offset=0&limit=10

响应示例

状态码: 200

Success.

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

状态码

请参见状态码

错误码

请参见错误码

相关文档