接口请求域名： cfg.intl.tencentcloudapi.com 。
查询任务列表
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Limit | 是 | Integer | 分页Limit |
| Offset | 是 | Integer | 分页Offset |
| TaskTitle | 否 | String | 演练名称 |
| TaskTag.N | 否 | Array of String | 标签键 |
| TaskStatus | 否 | Integer | 任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束) |
| TaskStartTime | 否 | String | 开始时间，固定格式%Y-%m-%d %H:%M:%S |
| TaskEndTime | 否 | String | 结束时间，固定格式%Y-%m-%d %H:%M:%S |
| TaskUpdateTime | 否 | String | 更新时间，固定格式%Y-%m-%d %H:%M:%S |
| Tags.N | 否 | Array of TagWithDescribe | 标签对 |
| Filters.N | 否 | Array of ActionFilter | 筛选条件 |
| TaskId.N | 否 | Array of Integer | 演练ID |
| ApplicationId.N | 否 | Array of String | 关联应用ID筛选 |
| ApplicationName.N | 否 | Array of String | 关联应用筛选 |
| TaskStatusList.N | 否 | Array of Integer | 任务状态筛选--支持多选 任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束) |
| ArchId | 否 | String | 架构ID |
| ArchName | 否 | String | 架构名称 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskList | Array of TaskListItem | 无 |
| Total | Integer | 列表数量 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
查询演练列表
POST / HTTP/1.1
Host: cfg.intl.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
}
}
查询演练列表(含预检状态信息)
POST / HTTP/1.1
Host: cfg.intl.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
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
文档反馈