DescribeImageTasks

Last updated: 2026-09-14 12:14:34Download PDF

1. API Description

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

Image processing task query API.

A maximum of 20 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: DescribeImageTasks.
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
Limit	No	Integer
ScrollToken	No	String
StartTime	No	String
EndTime	No	String
SubTaskHasFailed	No	Boolean

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer
ScrollToken	String
TaskSet	Array of ImageTaskInfo
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 Accesses image processing task list

Accesses image processing task list

Input Example

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

{
    "Status": "FINISH",
    "Limit": 20,
    "SubTaskHasFailed": false,
    "ScrollToken": "********-WorkflowTask-********************************tt6"
}

Output Example

{
    "Response": {
        "ScrollToken": "********-WorkflowTask-********************************tt6",
        "TaskSet": [
            {
                "BeginProcessTime": "2026-03-16T12:29:54Z",
                "CreateTime": "2026-03-16T12:29:54Z",
                "FinishTime": "2026-03-16T12:29:56Z",
                "Status": "FINISH",
                "SubTaskHasFailed": false,
                "TaskId": "********-WorkflowTask-********************************tt6"
            }
        ],
        "TotalCount": 13,
        "RequestId": "f642575f-60b2-46ef-a1c1-5401b6e9ba33"
    }
}

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: illegal mps user.
InternalError	Internal error.
InvalidParameterValue	Parameter value error.
InvalidParameterValue.Limit	Parameter error: Limit.