# 查询Redis实例的热key - QueryingHotKeysofaRedisInstance #### 功能介绍 支持查询Redis实例的热key。 #### 接口约束 该接口只支持GeminiDB Redis数据库实例。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=UpdateHighRiskCommands)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:getHotKeys | read | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | nosql:instance:getHotKeys | - | #### URI GET /v3/{project_id}/instances/{instance_id}/hot-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)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 索引位置偏移量，表示从指定offset条数据后查询对应的热key信息。 **约束限制：** 不涉及。 **取值范围：** \>=0。 **默认取值：** 0。 | | limit | 否 | Integer | **参数解释：** 查询数据的上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~50 **默认取值：** 50。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | keys | Array of [表5] objects | **参数解释：** 查询到的热Key列表。 | | count | Integer | **参数解释：** 总数。 **取值范围：** 不涉及。 | 表5HotKeysInfoRsponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 热Key名。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 热Key类型。 **取值范围：** - string：表示String类型。 - hash：表示Hash类型。 - list：表示List类型。 - zset：表示ZSet类型。 - set：表示Set类型。 - exhash：表示ExHash类型。 - stream：表示Stream类型。 | | command | String | **参数解释：** 热Key命令。 **取值范围：** 不涉及。 | | qps | Integer | **参数解释：** 热Key QPS。 **取值范围：** 不涉及。 | | db_id | Integer | **参数解释：** 热key所在的DB。 **取值范围：** 不涉及。 | #### 请求示例 支持查询Redis实例的热key。实例记录的前30个key会被判断为热key。 ``` GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/91b5c48e11bf4913b35814f28b8f79f2in12/hot-keys ``` #### 响应示例 **状态码： 200** Success. ``` { "keys" : [ { "name" : "address", "type" : "string", "command" : "set", "qps" : 3000, "db_id" : 0 } ], "count" : 1 } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。