有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeTaskList)用于查询指定实例的任务列表信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskList。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
示例值:crs-opcazbrb
InstanceName String 实例名称。
示例值:crs-rhlppeye
Limit Integer 每页输出的任务列表大小。默认为 20,最多输出100条。
示例值:100
Offset Integer 分页偏移量,取Limit整数倍。计算公式:offset=limit*(页码-1)。
示例值:0
ProjectIds.N Array of Integer 项目 ID。登录 Redis 控制台,在右上角的账号信息下拉菜单中,选择项目管理,即可获取对应的项目 ID。
示例值:11322
TaskTypes.N Array of String 任务类型。
- FLOW_CREATE:创建实例。
- FLOW_MODIFYCONNECTIONCONFIG:调整带宽连接数。
- FLOW_MODIFYINSTANCEPASSWORDFREE:免密变更流程。
- FLOW_CLEARNETWORK:VPC退还中。
- FLOW_SETPWD:设置访问密码。
- FLOW_EXPORSHR:扩缩容流程。
- FLOW_UpgradeArch:实例架构升级流程。
- FLOW_MODIFYINSTANCEPARAMS:修改实例参数。
- FLOW_MODIFYINSTACEREADONLY:只读变更流程。
- FLOW_CLOSE:关闭实例。
- FLOW_DELETE:删除实例。
- FLOW_OPEN_WAN:开启外网。
- FLOW_CLEAN:清空实例。
- FLOW_MODIFYINSTANCEACCOUNT:修改实例账号。
- FLOW_ENABLEINSTANCE_REPLICATE:开启副本只读。
- FLOW_DISABLEINSTANCE_REPLICATE: 关闭副本只读。
- FLOW_SWITCHINSTANCEVIP:交换实例 VIP。
- FLOW_CHANGE_REPLICA_TO_MSTER:副本节点升主节点。
- FLOW_BACKUPINSTANCE:备份实例。
BeginTime String 任务执行的起始时间。格式如:2021-12-30 00:00:00。
示例值:2021-12-30 00:00:00
EndTime String 任务运行的终止时间。格式如:2021-12-30 20:59:35
示例值:2021-12-30 20:59:35
TaskStatus.N Array of Integer 该参数为内部使用,请忽略。
示例值:[0.1.2]
Result.N Array of Integer 任务执行状态。
- 0:任务初始化。
- 1:执行中。
- 2:完成。
- 4:失败。
示例值:[0,1,2]
OperatorUin.N Array of Integer 该字段已废弃,使用OperateUin代替,请忽略。
示例值:[10002274123]
OperateUin.N Array of String 操作者账号 ID,UIN。
示例值:["10002274123"]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务总数。
示例值:2
Tasks Array of TaskInfoDetail 任务详细信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

查询实例的任务详情

输入示例

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

{
    "InstanceId": "crs-opcazbrb"
}

输出示例

{
    "Response": {
        "RequestId": "19a7fb07-8e21-4827-88dd-fee57f38e8cd",
        "Tasks": [
            {
                "EndTime": "2019-11-15 14:25:46",
                "InstanceId": "crs-opcazbrb",
                "InstanceName": "multidbccbugfix11153",
                "Progress": 1,
                "ProjectId": 0,
                "Result": 2,
                "StartTime": "2019-11-15 14:25:37",
                "TaskId": 42372,
                "TaskType": "037"
            },
            {
                "EndTime": "2019-11-15 14:25:25",
                "InstanceId": "crs-opcazbrb",
                "InstanceName": "multidbccbugfix11153",
                "Progress": 1,
                "ProjectId": 0,
                "Result": 2,
                "StartTime": "2019-11-15 14:25:16",
                "TaskId": 42371,
                "TaskType": "037"
            }
        ],
        "TotalCount": 2
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InternalError.InternalError 内部错误。
InvalidParameter.PermissionDenied 接口没有cam权限。