文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>游戏数据库 TcaplusDB>API 文档>其他接口>查询任务列表

查询任务列表

最近更新时间：2025-09-12 03:32:23

我的收藏

本页目录：

1. 接口描述

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

查询任务列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTasks。
Version 是 String 公共参数，本接口取值：2019-08-23。
Region 是 String 公共参数，详见产品支持的 地域列表。
ClusterIds.N 否 Array of String 需要查询任务所属的集群ID列表
示例值：176784
TaskIds.N 否 Array of String 需要查询的任务ID列表
示例值：1345345
Filters.N 否 Array of Filter 过滤条件，本接口支持：Content，TaskType, Operator, Time
示例值：{}
Offset 否 Integer 查询列表偏移量
示例值：0
Limit 否 Integer 查询列表返回记录数
示例值：10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务数量
示例值：10
TaskInfos Array of TaskInfoNew 查询到的任务详情列表
示例值：{}
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务列表

指定任务ID，查询任务详情

输入示例

https://tcaplusdb.tencentcloudapi.com/?Action=DescribeTasks
&ClusterIds.0=5674209986
&Offset=3
&Limit=3
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "72fc70ce-2396-4b8e-ac54-9bce72058da1",
        "TaskInfos": [
            {
                "ClusterName": "gz测试PROTO",
                "ClusterId": "5674209986",
                "Content": "20548499 modify quotas table(tb_example) of Cluster(5674209986) TableGroup(101), InstanceId tcaplus-1f224454, Storage Layer Expand: volume[1 -> 2], owner 20548499",
                "Operator": "20548499",
                "Progress": 0,
                "StartTime": "2019-08-30 18:16:50",
                "TaskId": "5674209986-1202",
                "TaskType": "ModifyTableQuotas",
                "TransId": "0",
                "UpdateTime": "2019-08-30 18:16:50"
            },
            {
                "ClusterName": "gz测试PROTO",
                "ClusterId": "5674209986",
                "Content": "20548499 modify table(tb_example)'s structure of Cluster(5674209986) TableGroup(101), InstanceId tcaplus-1f224454, owner 20548499",
                "Operator": "20548499",
                "Progress": 100,
                "StartTime": "2019-08-30 18:02:50",
                "TaskId": "5674209986-1200",
                "TaskType": "ModifyTables",
                "TransId": "558",
                "UpdateTime": "2019-08-30 18:02:51"
            },
            {
                "ClusterName": "gz测试PROTO",
                "ClusterId": "5674209986",
                "Content": "20548499 clear table(tb_example) of Cluster(5674209986) TableGroup(101), InstanceId tcaplus-1f224454, owner 20548499",
                "Operator": "20548499",
                "Progress": 0,
                "StartTime": "2019-08-30 17:34:07",
                "TaskId": "5674209986-1199",
                "TaskType": "ClearTables",
                "TransId": "557",
                "UpdateTime": "2019-08-30 17:34:07"
            }
        ],
        "TotalCount": 19
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
中国站
目录