DescribeTasks

Last updated: 2025-11-13 12:01:12Download PDF

1. API Description

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

This API is used to query tasks.
If the data is large, one API call may not be able to obtain all the tasks in the query. You can use the ScrollToken parameter to query tasks with multiple calls.
Only tasks in the last seven days (168 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 Params. The value used for this API: DescribeTasks.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Status	Yes	String	Filters task status. available values:. -WAITING. -PROCESSING (processing). -FINISH (completed).
SubTaskHasFailed	No	Boolean	Whether there is a failed subtask when the task ends. If this parameter is left unspecified, ignore it. false: filter the main tasks to identify those that have no failed subtasks. true: filter the main tasks to identify those that have failed subtasks.
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.
StartTime	No	String	Query task start time.
EndTime	No	String	Query task end time.

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.
TotalCount	Integer	The total number of records that meet the conditions.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining a Task List

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<Common request parameters>



{
    "Status": "FINISH",
    "Limit": "5"
}

Output Example

{
    "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"
    }
}

Example2 Obtaining a Task List and Paginating Results

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<Common request parameters>



{
    "Status": "FINISH",
    "ScrollToken": "taskId6",
    "Limit": "5"
}

Output Example

{
    "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"
    }
}

Example3 Obtaining a List of Tasks Being Processed

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<Common request parameters>



{
    "Status": "PROCESSING",
    "Limit": "5"
}

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.
InvalidParameterValue.Limit	Parameter error: Limit.