DescribeHotBigKeys - 实时获取当前热Key和大Key

调用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 实例:
    • 实例为社区版(5.0 及以上版本)或企业版(性能增强型)。
    • 实例的小版本为最新。
说明 关于如何查询小版本、升级小版本,详情请参见 ModifyInstanceMinorVersionDescribeEngineVersion

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:DescribeHotBigKeysget
*全部资源
*

请求参数

名称类型必填描述示例值
ConsoleContextstring

备用参数。

None
InstanceIdstring

Redis 实例 ID,您可以调用 DescribeInstances 接口获取。

r-bp18ff4a195d****
NodeIdstring

Redis 实例的数据分片 ID,您可以调用 DescribeRoleZoneInfo 接口获取。

r-****-db-0

返回参数

名称类型描述示例值
object
Messagestring

请求返回消息。

Successful
RequestIdstring

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Dataobject

详情信息列表。

HotKeysarray<object>

热键详细列表。

HotKeyobject
Keystring

具体的 Key。

abc:def:eng
Dbinteger

Key 所在的 DB。

0
Hotstring

Key 的访问频次,即 Key 的每秒访问数。

5500~6000
KeyTypestring

Key 的类型。

zset
Lfuinteger

LFU 算法的统计值。

253
NodeIdstring

Redis 实例的数据分片 ID。

r-x****-db-0
BigKeysarray<object>

大 Key 的详细列表。

BigKeyobject
Dbinteger

Key 所在的 DB。

0
Keystring

具体的 Key。

abc:def:eng
KeyTypestring

Key 类型。

zset
Sizelong

元素的个数。

2
NodeIdstring

Redis 实例的数据分片 ID。

r-x****-db-0
HotKeyMsgstring

获取热 Key 失败的原因。

current version doesn't support
BigKeyMsgstring

获取大 Key 失败的原因。

current version doesn't support
Codestring

返回的状态码。

200
Successstring

请求是否执行成功:

  • 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"
        }
      ]
    },
    "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"
  },
  "Code": "200",
  "Success": "true"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史