更新时间:2025-09-09 GMT+08:00
分享

查询Redis实例的热key

功能介绍

支持查询Redis实例的热key。

接口约束

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

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/hot-keys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

String

参数解释:

实例ID,可以调用7.3.3 查询实例列表和详情接口获取。如果未申请实例,可以调用7.3.1 创建实例接口创建。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

索引位置偏移量,表示从指定offset条数据后查询对应的热key信息。

约束限制:

不涉及。

取值范围:

>=0。

默认取值:

0。

limit

Integer

参数解释:

查询数据的上限值。

约束限制:

不涉及。

取值范围:

1~50

默认取值:

50。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

keys

Array of 表5 objects

参数解释:

查询到的热Key列表。

取值范围:

不涉及。

count

Integer

参数解释:

总数。

取值范围:

不涉及。

表5 HotKeysInfoRsponseBody

参数

参数类型

描述

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。

取值范围:

不涉及。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

支持查询Redis实例的热key。实例记录的前30个key会被判断为热key。
GET https://{endpoint}/v30549b4a43100d4f32f51c01c2fe4acdb/instances/91b5c48e11bf4913b35814f28b8f79f2in12/hot-keys

响应示例

状态码: 200

Success.

{ 
  "keys" : [ { 
    "name" : "address", 
    "type" : "String", 
    "command" : "set", 
    "qps" : 3000, 
    "db_id" : 0 
  } ], 
  "count" : 1 
}

状态码

请参见状态码

错误码

请参见错误码

相关文档