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

查询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。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

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

limit

否

Integer

查询数据上限值。

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

keys

Array of 表5 objects

查询到的热Key列表。

count

Integer

总数。
表5 HotKeysInfoRsponseBody

参数

参数类型

描述

name

String

热Key名。

type

String

热Key类型。

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 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档