查询实例当前的热Key的API接口_数据库自治服务(DAS)-阿里云帮助中心

调用DescribeHotKeys接口，查询Redis实例的热Key。

接口说明

使用该接口需满足以下前提条件：

在使用阿里云 SDK 时，需要保证 aliyun-sdk-core 的版本大于 4.3.3，建议使用最新版本。
使用 DAS 的 SDK 的版本为 1.0.2 或以上。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
本接口只适用于如下 Redis 实例：
- 实例为社区版（4.0 及以上版本）或企业版（性能增强型）。
- 实例的小版本为最新。

说明关于如何查询小版本、升级小版本，详情请参见 ModifyInstanceMinorVersion 、 DescribeEngineVersion 。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	Redis 实例 ID，您可以调用 DescribeInstances 接口获取。	r-bp18ff4a195d****
NodeId	string	否	Redis 实例的数据分片 ID，您可以调用 DescribeRoleZoneInfo 接口获取。	r-x****-db-0

返回参数

名称	类型	描述	示例值
	object
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	array<object>	详细信息列表。
HotKey	object
Key	string	具体的 Key。	abc:def:eng
Db	integer	Key 所在的 DB。	0
Hot	string	Key 的访问频次，即 Key 的每秒访问数。	5500~6000
KeyType	string	Key 的类型。	zset
Size	long	元素的个数。	2
Code	string	返回的状态码。	200
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "HotKey": [
      {
        "Key": "abc:def:eng",
        "Db": 0,
        "Hot": "5500~6000",
        "KeyType": "zset",
        "Size": 2
      }
    ]
  },
  "Code": "200",
  "Success": "true"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史