1. 接口描述
接口请求域名： mps.tencentcloudapi.com 。
- 该接口用于查询任务列表；
- 当列表数据比较多时，单次接口调用无法拉取整个列表，可通过 ScrollToken 参数，分批拉取；
- 只能查询到最近七天（168小时）内的任务。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2019-06-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Status | 是 | String | 过滤条件：任务状态，可选值：WAITING（等待中）、PROCESSING（处理中）、FINISH（已完成）。 示例值：FINISH |
| Limit | 否 | Integer | 返回记录条数，默认值：10，最大值：100。 示例值：5 |
| ScrollToken | 否 | String | 翻页标识，分批拉取时使用：当单次请求无法拉取所有数据，接口将会返回 ScrollToken，下一次请求携带该 Token，将会从下一条记录开始获取。 示例值："" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskSet | Array of TaskSimpleInfo | 任务概要列表。 |
| ScrollToken | String | 翻页标识，当请求未返回所有数据，该字段表示下一条记录的 ID。当该字段为空字符串，说明已无更多数据。 示例值：taskId6 |
| TotalCount | Integer | 符合过滤条件的记录总数。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取任务列表
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<公共请求参数>
{
"Status": "FINISH",
"Limit": "5"
}输出示例
{
"Response": {
"TotalCount": 12,
"TaskSet": [
{
"TaskId": "taskId1",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId2",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId3",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId4",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId5",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
}
],
"ScrollToken": "taskId6",
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}示例2 获取任务列表-翻页
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<公共请求参数>
{
"Status": "FINISH",
"ScrollToken": "taskId6",
"Limit": "5"
}输出示例
{
"Response": {
"TotalCount": 1,
"TaskSet": [
{
"TaskId": "taskId6",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
}
],
"ScrollToken": "",
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}示例3 获取任务列表-处理中
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<公共请求参数>
{
"Status": "PROCESSING",
"Limit": "5"
}输出示例
{
"Response": {
"TotalCount": 1,
"TaskSet": [
{
"TaskId": "taskId7",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "0000-00-00T00:00:00Z"
}
],
"ScrollToken": "",
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}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.InvalidMpsUser | 操作失败：非法 mps 用户。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Limit | 参数错误：Limit。 |
