You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

DescribeBigKeys

最近更新时间：2023.12.07 21:15:16

首次发布时间：2023.04.14 10:23:13

我的收藏

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

请求类型

同步请求。

注意事项

仅支持查看最近 15 天内，指定 Redis 实例中内存占用量最多的前 100 个 Key 或元素数量最多的前 100 个 Key 的详情。

请求参数

名称类型是否必选示例值描述

InstanceId

String

是

redis-cn02sg5o56sbs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

PageSizeInteger是50每页记录数，取值范围为 1~50 间的整数。

QueryStartTime

String

否

2023-03-27T15:30:00Z

查询开始时间，格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。

说明

  • 若该参数留空，实际查询开始时间默认为当前时间 1 小时前的时间。
    例如，当前时间为 2023 年 03 月 27 号 16:30:00，若 QueryStartTime 不填，那么实际查询开始时间为 2023 年 03 月 27 号 15:30:00。
  • 查询结束时间需晚于查询开始时间，时间间隔不超过 1 小时。

QueryEndTime

String

否

2023-03-27T15:31:00Z

查询结束时间，格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。

说明

  • 若该参数留空，实际查询结束时间默认为当前时间。
  • 查询结束时间需晚于查询开始时间，时间间隔不超过 1 小时。

KeyType

String

否

list

指定数据类型来过滤大 Key 查询结果。支持的数据类型为 string、list、set、zset 和 hash。

说明

若该参数留空，默认查询目标实例中所有数据类型的大 Key 详情。

OrderBy

String

否

ValueSize

指定查询结果的排序条件。支持的排序条件如下：

  • ValueSize（默认值）：按内存占用对大 Key 查询结果进行排序。
  • ValueLen：按元素数量对大 Key 查询结果进行排序。

返回数据

名称类型示例值描述
TotalInteger1查询结果总条目数。
InstanceIdStringredis-cn02sg5o56sbs****实例 ID。
BigKeyArray of BigKeyInfo请参见返回示例。大 Key 详情。关于 BigKeyInfo 的更多信息，请参见数据结构。

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeBigKeys&Version=2020-12-07 HTTP/1.1
Host: redis.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": "202207262048480102250842170107****",
        "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
    }
}

错误码

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