文档中心

缓存数据库 Redis 版

性能分析

DescribeHotKeys

调用 DescribeHotKeys 接口查询目标 Redis 实例在指定时间段内的热 Key 详情。

请求类型

同步请求。

注意事项

仅支持查看最近 15 天内，指定 Redis 实例中前 1000 个热 Key 的分布情况。更多详情，请参见热 Key 分析。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn02sg5o56sbs****	实例 ID。说明您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
PageSize	Integer	是	50	每页记录数，取值范围为 1~1000 间的整数。
QueryStartTime	String	否	2023-03-27T15:30:00Z	查询开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明最多支持查看最近 15 天内的热 Key 分布情况。若该参数留空，实际查询开始时间默认为当前时间 1 小时前的时间。例如，当前时间为 2023 年 03 月 27 号 16:30:00，若 QueryStartTime 不填，那么实际查询开始时间为 2023 年 03 月 27 号 15:30:00。查询结束时间需晚于查询开始时间，时间间隔不超过 15 天。
QueryEndTime	String	否	2023-03-27T15:31:00Z	查询结束时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若该参数留空，实际查询结束时间默认为当前时间。查询结束时间需晚于查询开始时间，时间间隔不超过 15 天。
KeyType	String	否	list	指定用于过滤热 Key 查询结果的数据类型。支持如下数据类型： string list set zset hash 说明若该参数留空，表示不使用数据类型进行过滤。
ShardIds	Array of String	否	["server-redis-cn02sg5o56sbs****-0"]	指定用于过滤热 Key 查询结果的分片 ID 列表。说明每次最多支持同时传入 40 个分片 ID，以数组形式传入多个分片 ID。若该参数留空，表示不使用分片 ID 进行过滤。您可以调用 DescribeDBInstanceShards 接口查询目标 Redis 实例下各 Shard 分片的详情，包括分片 ID（即返回结果中的 ShardId字段。

返回参数

参数	类型	示例值	描述
Total	Integer	1	查询结果总条目数。
InstanceId	String	redis-cn02sg5o56sbs****	实例 ID。
HotKey	Array of HotKeyInfo	请参见返回示例。	热 Key 详情列表。

HotKeyInfo

参数	类型	示例值	描述
ActionType	String	Read	触发 hotKey 检测的请求类型。取值： Read：读请求。 Write：写请求。
CreateTime	String	2023-03-27T15:30:35Z	热 Key 的采集时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
DBName	String	0	热 Key 所属数据库的名称。
NodeId	String	server-redis-cn02sg5o56sbs****-0-0	热 Key 所属的节点 ID。
KeyInfo	String	key:000000000015	热 Key 的名称。
KeyType	String	string	热 Key 的数据类型。
QueryCount	String	15000	热 Key 的访问次数。
ShardId	String	server-redis-cn02sg5o56sbs****-0	热 Key 所属的分片 ID。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeHotKeys&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
    "InstanceId": "redis-cn02sg5o56sbs****",​
    "QueryStartTime": "2023-03-27T15:30:00Z",​
    "QueryEndTime": "2023-03-27T15:31:00Z",​
    "PageSize": 50,​
    "ShardIds": [​
        "server-redis-cn02sg5o56sbs****-0"​
    ]​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "DescribeHotKeys",​
        "Version": "2020-12-07",​
        "Service": "Redis",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Total": 1,​
        "InstanceId": "redis-cn02sg5o56sbs****",​
        "HotKey": [​
            {​
                "ActionType": "Read",​
                "DBName": "0",​
                "NodeId": "server-redis-cn02sg5o56sbs****-0-0",​
                "KeyInfo": "key:000000000015",​
                "KeyType": "string",​
                "ShardId": "server-redis-cn02sg5o56sbs****-0",​
                "CreateTime": "2023-03-27T15:30:35Z",​
                "QueryCount": "15000"​
            }​
        ]​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.09.21 14:23:32

这个页面对您有帮助吗？

有用

无用