DescribeHotBigKeys - 实时获取热Key和大Key

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

接口说明

当Key的Size个数排名前3的会被记录为大Key;当某个Key的QPS大于3,000时会被记录为热点Key。

  • 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。
  • 使用DAS的SDK的版本为1.0.2或以上。
  • 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。
  • 本接口只适用于如下Redis实例:
    • 社区版4.0或5.0(0.4.0及以上)
    • 企业版5.0(1.5.1及以上)
说明关于如何查询小版本、升级小版本,详情请参见ModifyInstanceMinorVersionDescribeEngineVersion

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
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
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

大Key的详细列表。

object
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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeHotBigKeys
&ConsoleContext=6c2e064b-a45f-4bd0-8a80-*********
&InstanceId=r-bp18ff4a195d****
&NodeId=r-****-db-0
&公共请求参数

正常返回示例

JSON格式

{
    "Message": "Successful",
    "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
    "Data": {
        "HotKeys": [
            {
                "Key": "abc:def:eng",
                "Db": 0,
                "Hot": "5500~6000",
                "KeyType": "zset",
                "Lfu": 253,
                "NodeId": "r-x****-db-0"
            }
        ],
        "BigKeys": [
            {
                "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"
}

XML格式

<DescribeHotBigKeysResponse>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Data>
        <HotKeys>
            <Key>abc:def:eng</Key>
            <Db>0</Db>
            <Hot>5500~6000</Hot>
            <KeyType>zset</KeyType>
            <Lfu>253</Lfu>
            <NodeId>r-x****-db-0</NodeId>
        </HotKeys>
        <BigKeys>
            <Db>0</Db>
            <Key>abc:def:eng</Key>
            <KeyType>zset</KeyType>
            <Size>2</Size>
            <NodeId>r-x****-db-0</NodeId>
        </BigKeys>
        <HotKeyMsg>current version doesn't support</HotKeyMsg>
        <BigKeyMsg>current version doesn't support</BigKeyMsg>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeHotBigKeysResponse>

错误码

Http code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误

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

阿里云首页 数据库自治服务 DAS 相关技术圈