1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询项目下所有任务列表,包括虚拟任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskTemplates。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目id 示例值：1460947878944567296 |
| PageNumber | 是 | Integer | 页号 示例值：1 |
| PageSize | 是 | Integer | 分页大小 示例值：10 |
| OrderFields.N | 否 | Array of OrderField | 排序字段, 仅支持更新时间, 取值示例 - UpdateTime 示例值：[{"Name": "UpdateTime","Direction": "DESC"}] |
| Filters.N | 否 | Array of Filter | 过滤条件, 取值列表 - TemplateName 模版名称 - TaskType 支持任务类型 - InCharge 责任人 - FolderId 文件夹id - Status 提交状态 - UpdateStartTime 更新时间,时间区间查询 - UpdateEndTime 更新时间,时间区间查询 示例值：[{Name: "TemplateName", Values: ["weData"]}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | PageTaskTemplateInfo | 查询项目下所有任务信息,不包括虚拟任务和离线任务 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 分页查询模版列表
分页查询模版列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskTemplates
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"PageNumber": 1,
"PageSize": 10,
"OrderFields": [
{
"Name": "UpdateTime",
"Direction": "DESC"
}
]
}输出示例
{
"Response": {
"Data": {
"Items": [],
"PageCount": 0,
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 0
},
"RequestId": "c2b2edf2-8537-4fb8-869a-92fa10cf3bb7"
}
}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 | 操作失败。 |
