文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 查询GeminiDB Redis实例的大key
更新时间：2024-05-24 GMT+08:00
查看PDF
分享

查询GeminiDB Redis实例的大key

功能介绍

支持查询Redis实例的Key。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Redis

调试

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

URI

POST /v3/{project_id}/instances/{instance_id}/big-keys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置偏移量，表示从查询到的大Key列表偏移offset条数据后查询对应的大Key信息。

取值大于或等于0。不传该参数时，查询偏移量默认为0，表示从第一条大Key开始查询。

limit

否

Integer

查询个数上限值。取值范围：1~100。不传该参数时，默认查询前100条大Key。

key_types

否

Array of strings

大大Key的类型,一个字符串列表,支持"string"、"hash"、"zset"、"set"、"list"、"stream"六种类型。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

keys

Array of 表5 objects

查询到的大Key列表。

count

Integer

大Key的总数。
表5 BigKeysInfoResponseBody

参数

参数类型

描述

db_id

Integer

大Key所在的DB。

key_type

String

大Key类型。

key_name

String

大Key名。

key_size

Integer

大Key的长度。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

POST https://{endpoint}/v3/instances/91b5c48e11bf4913b35814f28b8f79f2in12/big-keys 
  
 { 
   "key_types" : [ "string", "hash", "zset", "set", "list", "stream" ] 
 }

响应示例

状态码： 200

Success.

{ 
   "keys" : [ { 
     "db_id" : 0, 
     "key_type" : "String", 
     "key_name" : "a", 
     "key_size" : 12 
   } ], 
   "count" : 1 
 }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档