API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 混沌演练平台 > 任务相关接口 > 查询任务列表

查询任务列表

最近更新时间：2024-04-10 01:10:24

我的收藏

本页目录：

1. 接口描述

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

查询任务列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTaskList。
Version 是 String 公共参数，本接口取值：2021-08-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
Limit 是 Integer 分页Limit
示例值：10
Offset 是 Integer 分页Offset
示例值：0
TaskTitle 否 String 演练名称
示例值："1"
TaskTag.N 否 Array of String 标签键
示例值："1"
TaskStatus 否 Integer 任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束)
示例值：1
TaskStartTime 否 String 开始时间，固定格式%Y-%m-%d %H:%M:%S
示例值："1"
TaskEndTime 否 String 结束时间，固定格式%Y-%m-%d %H:%M:%S
示例值："1"
TaskUpdateTime 否 String 更新时间，固定格式%Y-%m-%d %H:%M:%S
示例值："2024-03-09 20:59:59"
Tags.N 否 Array of TagWithDescribe 标签对
Filters.N 否 Array of ActionFilter 筛选条件
示例值：None
TaskId.N 否 Array of Integer 演练ID
示例值：5871
ApplicationId.N 否 Array of String 关联应用ID筛选
示例值："app-faee9ba9"
ApplicationName.N 否 Array of String 关联应用筛选
示例值："yh-test001"
TaskStatusList.N 否 Array of Integer 任务状态筛选--支持多选 任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束)
示例值：[1001, 1002]

3. 输出参数

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

4. 示例

示例1 查询演练列表

查询演练列表

输入示例

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

{
    "Limit": "10",
    "TaskTag": [
        "飞扬"
    ],
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "47e12dca-fa37-49b4-86e1-d7d3d7674640",
        "TaskList": [
            {
                "TaskId": 2,
                "TaskTitle": "广州二区-关机",
                "TaskDescription": "广州一区-关机",
                "TaskTag": "飞扬",
                "TaskStatus": 1002,
                "TaskCreateTime": "2021-08-14 00:37:34",
                "TaskUpdateTime": "2021-09-18 19:18:28",
                "TaskPreCheckStatus": 0,
                "TaskPreCheckSuccess": false
            }
        ],
        "Total": 1
    }
}

示例2 查询演练列表(含预检状态信息)

查询演练列表(含预检状态信息)

输入示例

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

{
    "Limit": "2",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "597dbef8-fcf3-46c2-9561-f87694052606",
        "TaskList": [
            {
                "TaskId": 3077,
                "TaskTitle": "演练预检测试",
                "TaskDescription": "演练预检测试",
                "TaskTag": "",
                "TaskStatus": 1001,
                "TaskCreateTime": "2022-09-19 12:57:22",
                "TaskUpdateTime": "2022-09-19 12:57:22",
                "TaskPreCheckStatus": 2,
                "TaskPreCheckSuccess": false
            },
            {
                "TaskId": 3076,
                "TaskTitle": "【公有云】Mongo节点故障",
                "TaskDescription": "【公有云】Mongo节点故障",
                "TaskTag": "",
                "TaskStatus": 1003,
                "TaskCreateTime": "2022-09-19 11:09:50",
                "TaskUpdateTime": "2022-09-19 12:17:49",
                "TaskPreCheckStatus": 0,
                "TaskPreCheckSuccess": false
            }
        ],
        "Total": 2450
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站