1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
用于查询任务的子任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListSubTasks。 |
Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
TaskId | 是 | String | 复杂任务ID 示例值:4d3535ba-3d81-4154-85ac-**** |
PageNumber | 否 | Integer | 页码,默认为1 示例值:1 |
PageSize | 否 | Integer | 每页数量,默认为10 示例值:10 |
Status | 否 | Integer | 默认不对该字段进行筛选,否则根据任务状态进行筛选。状态码:1-NEW,2-RUNNING,3-COMPLETED,4-FAILED 示例值:2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | ListSubTasksData | 返回数据 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
无
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListSubTasks
<公共请求参数>
{
"TaskId": "6d915841-****-****-****-5b278a217051",
"PageNumber": 1,
"PageSize": 2,
"Status": 4
}
输出示例
{
"Response": {
"Data": {
"List": [
{
"Action": "EnableDevice",
"ActionZhDesc": "启用设备",
"CreatedAt": "2023-07-19 16:12:50",
"FailReason": "资源不可达,该资源不属于该地域",
"Progress": 1,
"ResourceId": "e9b0b611-****-****-****-b307e04b1c25",
"Runtime": 0,
"StartedAt": "2023-07-19 16:12:51",
"Status": 4,
"SubTaskId": "beb4f9c9-****-****-****-e7ce5d61b574",
"UpdatedAt": "2023-07-19 16:12:51"
}
],
"TotalCount": 1
},
"RequestId": "03d99ae5-6126-447d-91de-d94aefcc7a0f"
}
}
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.InvalidParameterFormat | 参数格式不对或缺少参数 |
InvalidParameter.RequiredHeaderParameterEmpty | 必要请求头参数不能为空 |
InvalidParameter.TaskIdNotExist | TaskId不存在 |
InvalidParameterValue.InvalidPageParameter | 页参数取值错误 |
InvalidParameterValue.InvalidStatus | 状态取值错误 |
InvalidParameterValue.TaskTypeNotSupported | 不支持任务类型 |