DescribeImageTaskDetail
Last updated: 2025-06-12 19:43:13Download PDF
1. API Description
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to query the details of the task execution status and results by task ID (tasks submitted within the last 7 days can be queried).
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: DescribeImageTaskDetail. |
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. |
TaskId | Yes | String | Image processing task ID. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
TaskType | String | Task type. Currently, the valid values include: Note: This field may return null, indicating that no valid value can be obtained. |
Status | String | Task status. Valid values: Note: This field may return null, indicating that no valid value can be obtained. |
ImageProcessTaskResultSet | Array of ImageProcessTaskResult | Execution status and results of the image processing task. Note: This field may return null, indicating that no valid value can be obtained. |
CreateTime | String | Task creation time in ISO datetime format. Note: This field may return null, indicating that no valid value can be obtained. |
FinishTime | String | Task execution completion time in ISO datetime format. Note: This field may return null, indicating that no valid value can be obtained. |
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 Task Details
This example shows you how to querying task results.
Input Example
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageTaskDetail
<Common request parameters>
{
"TaskId": "24000089-WorkflowTask-0723542d0c164c958ba116874fa9b0c4"
}
Output Example
{
"Response": {
"CreateTime": "2025-05-16T07:44:26Z",
"FinishTime": "2025-05-16T07:44:30Z",
"RequestId": "147e6b46-efeb-48cf-9186-b195b2bf4f9d",
"Status": "FINISH",
"TaskType": "WorkflowTask"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
ResourceNotFound | The resource does not exist. |
UnauthorizedOperation | Unauthorized operation. |