tencent cloud

APIs

文档APIsMedia Processing ServiceTask Management APIsDescribeImageTaskDetail

DescribeImageTaskDetail

聚焦模式
字号
最后更新时间： 2026-05-06 17:49:18

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 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: 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

ID of the image processing task.

3. Output Parameters

Parameter Name Type Description
TaskType String

Task type. Valid value:

  • WorkflowTask: Workflow processing task.

    • Note: This field may return null, indicating that no valid values can be obtained.
    Status String

    Task status. Valid values:

  • WAITING: Waiting;
  • PROCESSING: Processing;
  • FINISH: Completed.

    • Note: This field may return null, indicating that no valid values can be obtained.
    ErrCode Integer

    Error code for task failures.
    ErrMsg String

    Error code. An empty string indicates that the task is successful, while other values indicate that the task has failed. For valid values, see the list of MPS error codes.
    Message String

    Task exception message.
    ImageProcessTaskResultSet Array of ImageProcessTaskResult

    Execution status and result of the image processing task.


    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String

    Task creation time, in ISO date and time format.


    Note: This field may return null, indicating that no valid values can be obtained.
    FinishTime String

    Task completion time, in ISO date and time format.


    Note: This field may return null, indicating that no valid values can be obtained.
    Definition Integer

    Unique template identifier.
    ImageTask ImageTaskInput

    Task initiation parameter.
    InputInfo MediaInputInfo

    Image task input information.
    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.

    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.
    上一篇: ManageTask下一篇: CreateTranscodeTemplate

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈