使用DescribeHotBigKeys实时获取热Key和大Key-数据库自治服务-阿里云-数据库自治服务(DAS)-阿里云帮助中心

调用DescribeHotBigKeys接口，实时获取当前内存中的热Key和大Key。

接口说明

对数据结构为 List、Hash、Set、Zset 的 Key，按照 Key 中元素的数量排序并展示排名前 3 的 Key，记录为大 Key；当某个 Key 的 QPS 大于 3,000 时会被记录为热点 Key。

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:DescribeHotBigKeys

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ConsoleContext	string	否	备用参数。	None
InstanceId	string	是	Redis 实例 ID。	r-bp18ff4a195d****
NodeId	string	否	Redis 实例的数据分片 ID。	r-****-db-0

返回参数

名称	类型	描述	示例值
	object
Message	string	请求返回消息。	Successful
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	详情信息列表。
HotKeys	object
HotKey	array<object>	按 QPS 统计的热 Key 列表。
	object	按 QPS 统计的热 Key 列表。
Key	string	具体的 Key。	abc:def:eng
Db	integer	Key 所在的 DB。	0
Hot	string	Key 的访问频次，即 Key 的每秒访问数。	5500~6000
KeyType	string	Key 的类型。	zset
Lfu	integer	LFU 算法的统计值。	253
NodeId	string	Redis 实例的数据分片 ID。	r-x****-db-0
Size	integer
BigKeys	object
BigKey	array<object>	按子元素数量统计的大 Key 列表。
	object	按子元素数量统计的大 Key 列表。
Db	integer	Key 所在的 DB。	0
Key	string	具体的 Key。	abc:def:eng
KeyType	string	Key 类型。	zset
Size	integer	元素的个数。	2
NodeId	string	Redis 实例的数据分片 ID。	r-x****-db-0
HotKeyMsg	string	获取按 QPS 统计的热 Key 失败的原因。	current version doesn't support
BigKeyMsg	string	获取按子元素数量统计的大 Key 失败的原因。	current version doesn't support
HighTrafficKeyMsg	string	获取按流量统计的热 Key 失败的原因。	current version doesn't support
HighTrafficKeys	object
HighTrafficKey	array<object>	按流量统计的热 Key 列表。
	object	按流量统计的热 Key 列表。
Key	string	具体的 Key。	abc:def:eng
Db	integer	Key 所在的 DB。	0
Hot	string	Key 的访问频次，即 Key 的每秒访问数。	1988
KeyType	string	Key 的类型。	string
NodeId	string	节点 ID。	r-x****-db-0
inBytes	integer	入流量，单位：Byte。	85767
outBytes	integer	出流量，单位：Byte。	1054684
Size	integer
LargeKeys	object
LargeKey	array<object>	按内存占用统计的大 Key 列表。
	object	按内存占用统计的大 Key 列表。
Db	string	Key 所在的 DB。	0
Key	string	具体的 Key。	abc:def:eng
KeyType	string	Key 的类型。	string
DataSize	string	Key 的内存占用，单位：Byte。	33554439
NodeId	string	节点 ID。	r-x****-db-0
LargeKeyMsg	string	获取按内存占用统计的大 Key 失败的原因。	current version doesn't support
Code	string	返回的状态码。	200
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "HotKeys": {
      "HotKey": [
        {
          "Key": "abc:def:eng",
          "Db": 0,
          "Hot": "5500~6000",
          "KeyType": "zset",
          "Lfu": 253,
          "NodeId": "r-x****-db-0",
          "Size": 0
        }
      ]
    },
    "BigKeys": {
      "BigKey": [
        {
          "Db": 0,
          "Key": "abc:def:eng",
          "KeyType": "zset",
          "Size": 2,
          "NodeId": "r-x****-db-0"
        }
      ]
    },
    "HotKeyMsg": "current version doesn't support",
    "BigKeyMsg": "current version doesn't support",
    "HighTrafficKeyMsg": "current version doesn't support",
    "HighTrafficKeys": {
      "HighTrafficKey": [
        {
          "Key": "abc:def:eng",
          "Db": 0,
          "Hot": "1988",
          "KeyType": "string",
          "NodeId": "r-x****-db-0\n",
          "inBytes": 85767,
          "outBytes": 1054684,
          "Size": 0
        }
      ]
    },
    "LargeKeys": {
      "LargeKey": [
        {
          "Db": "0",
          "Key": "abc:def:eng",
          "KeyType": "string",
          "DataSize": "33554439",
          "NodeId": "r-x****-db-0"
        }
      ]
    },
    "LargeKeyMsg": "current version doesn't support"
  },
  "Code": "200",
  "Success": "true"
}

错误码

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

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

变更历史

更多信息，参考变更详情。