1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
用于查询批量任务和简单任务列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| PageNumber | 否 | Integer | 页码，默认为1 示例值：1 |
| PageSize | 否 | Integer | 每页数量，默认为20 示例值：10 |
| Operation | 否 | String | 默认不根据该字段进行筛选，否则根据设备操作类型进行筛选，目前值有：BatchDeleteUserDevice，BatchDisableDevice，BatchEnableDevice， BatchUpgradeDevice， BatchResetDevice, BatchRebootDevice |
| Status | 否 | Integer | 默认不根据该字段进行筛选，否则根据任务状态进行筛选。状态码：1-未执行，2-执行中，3-完成，4-取消 示例值：2 |
| BeginTime | 否 | Integer | 开始时间 示例值：1703645732 |
| EndTime | 否 | Integer | 结束时间 示例值：1703645832 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | ListTasksData | 返回数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
无
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTasks
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 5,
"Operation": "BatchEnableDevice"
}输出示例
{
"Response": {
"Data": {
"List": [
{
"Action": "BatchEnableDevice",
"ActionZhDesc": "批量启用设备",
"CreatedAt": "2023-07-19 16:12:50",
"FailCount": 1,
"FailReason": "",
"Progress": 1,
"ResourceId": "",
"RunningCount": 0,
"Runtime": 1000,
"StartedAt": "2023-07-19 16:12:50",
"Status": 3,
"SuccessCount": 3,
"TaskId": "28bdf2f7-****-****-****-35f073f7ecf5",
"TaskType": 2,
"Total": 4,
"UpdatedAt": "2023-07-19 16:12:51"
},
{
"Action": "BatchEnableDevice",
"ActionZhDesc": "批量启用设备",
"CreatedAt": "2023-07-19 15:47:41",
"FailCount": 1,
"FailReason": "",
"Progress": 1,
"ResourceId": "",
"RunningCount": 0,
"Runtime": 1000,
"StartedAt": "2023-07-19 15:47:41",
"Status": 3,
"SuccessCount": 3,
"TaskId": "6a7c470b-****-****-****-d564918ad9d9",
"TaskType": 2,
"Total": 4,
"UpdatedAt": "2023-07-19 15:47:42"
}
],
"TotalCount": 2
},
"RequestId": "f37b7e5a-78c6-4931-81b0-095a9b318e03"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DatabaseError | 数据库错误 |
| FailedOperation.RequestTimeout | 请求超时 |
| InvalidParameter.InvalidAction | 操作类型不合法 |
| InvalidParameter.InvalidParameterFormat | 参数格式不对或缺少参数 |
| InvalidParameter.RequiredHeaderParameterEmpty | 必要请求头参数不能为空 |
| InvalidParameterValue.InvalidPageParameter | 页参数取值错误 |
| InvalidParameterValue.InvalidStatus | 状态取值错误 |
| InvalidParameterValue.TaskTypeNotSupported | 不支持任务类型 |