tencent cloud

APIs

DokumentasiAPIsMedia Processing ServiceTask management APIsDescribeImageTasks

DescribeImageTasks

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-08-05 17:08:20

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

Task status filter condition.
Limit No Integer

Number of returned records.
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

Task start time.

Parameter format: YYYY-MM-DDThh:mm:ssZ
EndTime No String

Task end time.

Parameter format: YYYY-MM-DDThh:mm:ssZ
SubTaskHasFailed No Boolean

Filter subtask status.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total number of records that meet filter conditions.

Unit: entries
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.
TaskSet Array of ImageTaskInfo

Image task summary list.
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

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.
Topik sebelumnya: DescribeImageTaskDetailTopik selanjutnya: CreateTranscodeTemplate

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan