DescribeTasks

Last updated: 2020-07-17 10:10:36

1. API Description

Domain name for API request: mps.tencentcloudapi.com.

  • This API is used to query the task list;
  • If there are many data entries in the list, one single call of the API may not be able to pull the entire list. The ScrollToken parameter can be used to pull the list in batches;
  • Only tasks in the last three days (72 hours) can be queried.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeTasks.
Version Yes String Common parameter. The value used for this API: 2019-06-12.
Region No String Common parameter. This parameter is not required for this API.
Status Yes String Filter: Task status. Valid values: WAITING (waiting), PROCESSING (processing), FINISH (completed).
Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
ScrollToken No String Scrolling identifier which is used for pulling in batches. If a single request cannot pull all the data entries, the API will return ScrollToken, and if the next request carries it, the next pull will start from the next entry.

3. Output Parameters

Parameter Name Type Description
TaskSet Array of TaskSimpleInfo Task overview list.
ScrollToken String Scrolling identifier. If a request does not return all the data entries, this field indicates the ID of the next entry. If this field is an empty string, there is no more data.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting task list

Input Example

https://mps.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&<common request parameters>

Output Example

{
  "Response": {
    "TaskSet": [
      {
        "TaskId": "taskId1",
        "TaskType": "WorkflowTask",
        "CreateTime": "2018-12-27T13:57:15Z",
        "BeginProcessTime": "2018-12-27T13:57:15Z",
        "FinishTime": "2018-12-27T13:57:15Z"
      },
      {
        "TaskId": "taskId2",
        "TaskType": "WorkflowTask",
        "CreateTime": "2018-12-27T13:57:15Z",
        "BeginProcessTime": "2018-12-27T13:57:15Z",
        "FinishTime": "2018-12-27T13:57:15Z"
      },
      {
        "TaskId": "taskId3",
        "TaskType": "WorkflowTask",
        "CreateTime": "2018-12-27T13:57:15Z",
        "BeginProcessTime": "2018-12-27T13:57:15Z",
        "FinishTime": "2018-12-27T13:57:15Z"
      },
      {
        "TaskId": "taskId4",
        "TaskType": "WorkflowTask",
        "CreateTime": "2018-12-27T13:57:15Z",
        "BeginProcessTime": "2018-12-27T13:57:15Z",
        "FinishTime": "2018-12-27T13:57:15Z"
      },
      {
        "TaskId": "taskId5",
        "TaskType": "WorkflowTask",
        "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"
  }
}

Example2 Getting task list - processing

Input Example

https://mps.tencentcloudapi.com/?Action=DescribeTasks
&Status=PROCESSING
&Limit=5
&<common request parameters>

Output Example

{
  "Response": {
    "TaskSet": [
      {
        "TaskId": "taskId7",
        "TaskType": "WorkflowTask",
        "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"
  }
}

Example3 Getting task list - scrolling

Input Example

https://mps.tencentcloudapi.com/?Action=DescribeTasks
&Status=FINISH
&Limit=5
&ScrollToken=taskId6
&<common request parameters>

Output Example

{
  "Response": {
    "TaskSet": [
      {
        "TaskId": "taskId6",
        "TaskType": "WorkflowTask",
        "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"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.InvalidMpsUser Operation failed: unauthorized MPS user.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help