# 查询GeminiDB Redis实例的大key - QueryingBigKeysofaGeminiDBRedisInstance #### 功能介绍 支持查询Redis实例的Key。 #### 接口约束 该接口支持如下数据库实例： - GeminiDB Redis #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ShowRedisBigKeys)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:getBigKeys | Read | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | nosql:instance:getBigKeys | - | #### URI POST /v3/{project_id}/instances/{instance_id}/big-keys 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表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"、"exhash"类型。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | keys | Array of [表5] objects | **参数解释：** 查询到的大Key列表。 | | count | Integer | **参数解释：** 大Key的总数。 **取值范围：** 不涉及。 | 表5BigKeysInfoResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | db_id | Integer | **参数解释：** 大Key所在的DB。 **取值范围：** 不涉及。 | | key_type | String | **参数解释：** 大Key类型。 **取值范围：** - String：表示String类型。 - Hash：表示Hash类型。 - List：表示List类型。 - Zset：表示ZSet类型。 - Set：表示Set类型。 - Exhash：表示ExHash类型。 - Stream：表示Stream类型。 | | key_name | String | **参数解释：** 大Key名。 **取值范围：** 不涉及。 | | key_size | Integer | **参数解释：** 大Key的长度，单位：字节。 **取值范围：** 不涉及。 | #### 请求示例 ``` POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/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 } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。