DescribeHotKeys - 查询实例当前的热Key

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

接口说明

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

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

调试

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

调试

授权信息

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

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

请求参数

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

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

r-bp18ff4a195d****
NodeIdstring

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

r-x****-db-0

返回参数

名称类型描述示例值
object
Messagestring

请求返回消息。

说明请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求ID。

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

详细信息列表。

object
Keystring

具体的Key。

abc:def:eng
Dbinteger

Key所在的DB。

0
Hotstring

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

5500~6000
KeyTypestring

Key的类型。

zset
SizeLong

元素的个数。

2
Codestring

返回的状态码。

200
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeHotKeys
&InstanceId=r-bp18ff4a195d****
&NodeId=r-x****-db-0
&公共请求参数

正常返回示例

JSON格式

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

XML格式

<DescribeHotKeysResponse>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Data>
        <Key>abc:def:eng</Key>
        <Db>0</Db>
        <Hot>5500~6000</Hot>
        <KeyType>zset</KeyType>
        <Size>2</Size>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeHotKeysResponse>

错误码

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

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

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