文档中心

缓存数据库 Redis 版

性能分析

DescribeBigKeys

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

请求类型

同步请求。

注意事项

仅支持查看最近 15 天内，指定 Redis 实例中内存占用量最多的前 100 个 Key 或元素数量最多的前 100 个 Key 的分布情况。更多详情，请参见大 Key 分析。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn02sg5o56sbs****	实例 ID。说明您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
PageSize	Integer	是	50	每页记录数，取值范围为 1~100 间的整数。
QueryStartTime	String	否	2023-03-27T15:30:00Z	查询开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明最多支持查看最近 15 天内的大 Key 分布情况。若该参数留空，实际查询开始时间默认为当前时间 24 小时前的时间。例如，当前时间为 2023 年 03 月 27 号 16:30:00，若 QueryStartTime 不填，那么实际查询开始时间为 2023 年 03 月 26 号 16:30:00。查询结束时间需晚于查询开始时间，时间间隔不超过 24 小时。
QueryEndTime	String	否	2023-03-27T15:31:00Z	查询结束时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若该参数留空，实际查询结束时间默认为当前时间。查询结束时间需晚于查询开始时间，时间间隔不超过 24 小时。
KeyType	String	否	list	指定用于过滤大 Key 查询结果的数据类型。支持如下数据类型： string list set zset hash 说明若该参数留空，表示不使用数据类型进行过滤。
OrderBy	String	否	ValueSize	指定查询结果的排序条件。支持如下排序条件： ValueSize（默认值）：按内存占用对大 Key 查询结果进行排序。 ValueLen：按元素数量对大 Key 查询结果进行排序。

返回参数

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

BigKeyInfo

参数	类型	示例值	描述
DBName	String	2	大 Key 所属数据库的名称。
KeyInfo	String	key:000000000015	大 Key 的名称。
KeyType	String	string	大 Key 的数据类型。
ValueLen	String	1	大 Key 中所包含的元素数量。说明 String 类型的大 Key 元素数量默认为 1。非 String 类型的大 Key 会返回具体的元素数量。
ValueSize	String	10241	大 Key 的内存占用量，单位：Byte。说明 String 类型的大 Key 会返回具体的内存占用量。非 String 类型的大 Key 内存占用量默认为空。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeBigKeys&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-20T12:37:54Z",​
    "QueryEndTime":"2023-03-20T12:38:54Z",​
    "PageSize":50​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202207262048480102250842170107xxxx",​
        "Action": "DescribeBigKeys",​
        "Version": "2020-12-07",​
        "Service": "Redis",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "BigKey": [​
            {​
                "DBName": "2",​
                "KeyInfo": "key:000000000015",​
                "KeyType": "string",​
                "ValueLen": "1",​
                "ValueSize": "10241"​
            }​
        ],​
        "InstanceId": "redis-cn02sg5o56sbs****",​
        "Total": 1​
    }​
}​

错误码

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

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

这个页面对您有帮助吗？

有用

无用