云数据库 KeeWiDB
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 KeeWiDB > API 文档 > 实例相关接口 > 查询任务列表信息

查询任务列表信息

最近更新时间：2024-03-12 01:36:55

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeTaskList）用于查询任务列表信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTaskList。
Version 是 String 公共参数，本接口取值：2022-03-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 否 String 实例 ID，如：kee-6ubh****。
示例值：kee-6ubhgouj
InstanceName 否 String 实例名称。
示例值：实例1
Limit 否 Integer 每页输出的任务列表大小。默认为 20，最多输出100条。
示例值：100
Offset 否 Integer Offset：分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。
示例值：0
ProjectIds.N 否 Array of Integer 项目ID。
TaskTypes.N 否 Array of String 任务类型。可设置为：FLOW_CREATE、FLOW_SETPWD、FLOW_CLOSE等。
BeginTime 否 String 起始时间。
示例值：2021-12-30 00:00:00
EndTime 否 String 终止时间。
示例值：2021-12-30 00:00:00
TaskStatus.N 否 Array of Integer 任务状态。
示例值：[0.1.2]

3. 输出参数

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

4. 示例

示例1 示例1

输入示例

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

{
    "InstanceId": "kee-4nmv****",
    "Limit": "2",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "3e6445f9-95d6-48b0-825f-2764d228ada3",
        "Tasks": [
            {
                "EndTime": "2022-03-10 11:44:17",
                "InstanceId": "kee-4nmv****",
                "InstanceName": "多az测试",
                "Progress": 1,
                "ProjectId": 0,
                "Result": 2,
                "StartTime": "2022-03-10 11:44:15",
                "TaskId": 1634784472,
                "TaskType": "007"
            },
            {
                "EndTime": "2022-03-03 15:47:34",
                "InstanceId": "kee-4nmv****",
                "InstanceName": "多az测试",
                "Progress": 1,
                "ProjectId": 0,
                "Result": 2,
                "StartTime": "2022-03-03 15:46:58",
                "TaskId": 1634784470,
                "TaskType": "049"
            }
        ],
        "TotalCount": 9
    }
}

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 内部系统错误，和业务无关。
FailedOperation.Unknown 未知类型操作错误。
InternalError.DbOperationFailed 统一的 DB 操作错误，可以是 update insert select..。
InternalError.InternalError 内部错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
中国站