API 中心
有奖：语音产品征文挑战赛等你来> HOT
文档中心 > API 中心 > 数据库智能管家 DBbrain > 其他接口 > 查询redis大key分析任务列表

查询redis大key分析任务列表

最近更新时间：2024-05-24 01:31:24

我的收藏

1. 接口描述

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

查询redis大key分析任务列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRedisBigKeyAnalysisTasks。
Version 是 String 公共参数，本接口取值：2021-05-27。
Region 是 String 公共参数，详见产品支持的 地域列表。
Product 是 String 服务产品类型，支持值包括 "redis" - 云数据库 Redis。
示例值：redis
InstanceId 是 String 实例ID。
示例值：crs-c1nl9rpv
Limit 否 Integer 查询数目，默认为20，最大值为100。
示例值：20
Offset 否 Integer 偏移量，默认为0。
示例值：0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务总数。
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
Tasks Array of RedisBigKeyTask 任务列表。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取Redis大Key分析任务列表

获取某个Redis实例的大Key分析任务列表。

输入示例

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRedisBigKeyAnalysisTasks
<公共请求参数>

{
    "InstanceId": "crs-7i2test",
    "Product": "redis",
    "Limit": 50,
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Tasks": [
            {
                "Progress": 100,
                "AsyncRequestId": 7309733,
                "EndTime": "2024-01-12 11:41:53",
                "CreateTime": "2024-01-12 11:38:37",
                "StartTime": "2024-01-12 11:38:38",
                "TaskStatus": "finished",
                "ShardIds": [
                    "2",
                    "3"
                ]
            }
        ],
        "RequestId": "e9833850-b113-11ee-8376-93f024a9a001"
    }
}

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 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站