查询redis实例大key列表

最近更新时间:2024-03-12 01:24:37

我的收藏

1. 接口描述

接口请求域名: dbbrain.tencentcloudapi.com 。

查询redis实例大key列表。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRedisTopBigKeys。
Version String 公共参数,本接口取值:2021-05-27。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID。
示例值:cdb-c1nl9rpv
Date Date 查询日期,如2021-05-27,最早可为前30天的日期。
示例值:2022-04-12
Product String 服务产品类型,支持值包括 "redis" - 云数据库 Redis。
示例值:redis
SortBy String 排序字段,取值包括Capacity - 内存,ItemCount - 元素数量,默认为Capacity。
示例值:Capacity
KeyType String key类型筛选条件,默认为不进行筛选,取值包括string, list, set, hash, sortedset, stream。
示例值:string
Limit Integer 查询数目,默认为20,最大值为100。
示例值:20
AsyncRequestId Integer 异步任务ID。当为空时,选择最近任务的ID。
示例值:7308832
ShardIds.N Array of Integer 分片节点序号列表。当列表为空时,选择所有分片节点。
示例值:[1,2]

3. 输出参数

参数名称 类型 描述
TopKeys Array of RedisKeySpaceData top key列表。
Timestamp Integer 采集时间戳(秒)。
示例值:1618890295
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询redis实例大key列表

输入示例

https://dbbrain.tencentcloudapi.com/?Action=DescribeRedisTopBigKeys
&InstanceId=cdb-test
&Date=2022-04-12
&Product=redis
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "8108c1c0-bbcc-11ec-adb9-eb9c1358e03a",
        "TopKeys": [
            {
                "ShardId": "1",
                "Type": "set",
                "AveElementSize": 15894,
                "Length": 93542932,
                "ItemCount": 4999,
                "Encoding": "skiplist",
                "ExpireTime": 0,
                "MaxElementSize": 34431,
                "Key": "test-key"
            }
        ],
        "Timestamp": 162072183
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。