tencent cloud

APIs

DocumentationAPIsVideo on DemandTask Management APIsDescribeTaskDetail

DescribeTaskDetail

Download
Focus Mode
Font Size
Last updated: 2026-05-11 20:13:41

1. API Description

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

This API is used to query the details of execution status and result of a task submitted in the last 3 days by task ID.

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: DescribeTaskDetail.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
TaskId Yes String

Video processing task ID.
SubAppId No Integer

VOD application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether it is the default application or a newly created application).

3. Output Parameters

Parameter Name Type Description
TaskType String

Task type. Valid values:

  • Procedure: Video processing task;
  • EditMedia: Video editing task;
  • SplitMedia: Video splitting task;
  • ComposeMedia: Media file creation task;
  • WechatPublish: WeChat publishing task;
  • WechatMiniProgramPublish: WeChat Mini Program Video Publishing Task;
  • PullUpload: Pull and upload media files task;
  • FastClipMedia: Quick trimming task;
  • RemoveWatermarkTask: Intelligent watermark removal task;
  • DescribeFileAttributesTask: File attribute retrieval task;
  • RebuildMedia: Audio and video quality regeneration task (not recommended);
  • ReviewAudioVideo: Audio/video moderation task;
  • ExtractTraceWatermark: Source watermark extraction task;
  • ExtractCopyRightWatermark: Copyright Watermark Extraction Task;
  • QualityInspect: Audio and video quality inspection task;
  • QualityEnhance: Audio and video quality regeneration task;
  • ComplexAdaptiveDynamicStreaming: Complex adaptive bitstream task;
  • ProcessMediaByMPS: MPS video processing task;
  • AigcImageTask: AIGC image generation task;
  • SceneAigcImageTask: Scenario-based AIGC image generation task;
  • AigcVideoTask: AIGC video generation task;
  • ImportMediaKnowledge: Import media knowledge task.
  • SceneAigcVideoTask: Scenario-based AIGC video generation task;
  • ExtractBlindWatermark: Digital watermark extraction task.
  • ExtractBlindWatermark: Digital watermark extraction task.
  • CreateAigcAdvancedCustomElementTask: Create custom subject task
  • CreateAigcCustomVoiceTask: Create custom voice type task
  • CreateAigcSubjectTask: Create subject task

    		•
    Status String

    Task status. Value:

  • WAITING: Waiting;
  • PROCESSING: Processing;
  • FINISH: Completed;
  • ABORTED: Terminated.
    		•
    CreateTime String

    Task creation time in ISO date format.
    BeginProcessTime String

    Task execution start time in ISO datetime format.
    FinishTime String

    Task execution completion time in ISO datetime format.
    ProcedureTask ProcedureTask

    Video processing task information. This field has a value only when TaskType is Procedure.


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

    Video editing task information. This field has a value only when TaskType is EditMedia.


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

    WeChat publishing task information. This field has a value only when TaskType is WechatPublish.


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

    Media file production task information. This field has a value only when TaskType is ComposeMedia.


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

    Video splitting task information. This field has a value only when TaskType is SplitMedia.


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

    WeChat Mini Program publishing task information. This field has a value only when TaskType is WechatMiniProgramPublish.


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

    Pull and upload media files task information. This field has a value only when TaskType is PullUpload.


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

    Video transcoding task information. This field has a value only when TaskType is Transcode.


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

    Video splicing task information. This field has a value only when TaskType is Concat.


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

    Video editing task information. This field has a value only when TaskType is Clip.


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

    Capturing sprite image task information. This field has a value only when TaskType is ImageSprite.


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

    Video screenshot at specified time task information. This field has a value only when TaskType is SnapshotByTimeOffset.


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

    Intelligent watermark removal task information. This field has a value only when TaskType is RemoveWatermark.


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

    Audio and video quality revival task information. This field has a value only when TaskType is RebuildMedia.


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

    Information about the traceability watermark extraction task. This field has a value only when TaskType is ExtractTraceWatermark.


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

    Information about the copyright watermark extraction task. This field has a value only when TaskType is ExtractCopyRightWatermark.


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

    Audio/video moderation task info. This field has a value only when TaskType is ReviewAudioVideo.


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

    This field is invalid.


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

    File attribute acquisition task information. This field has a value only when TaskType is DescribeFileAttributes.


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

    Audio and video quality detection task information. This field has a value only when TaskType is QualityInspect.


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

    Audio and video quality revival task information. This field has a value only when TaskType is QualityEnhance.


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

    Complex adaptive bitrate task information. This field has a value only when TaskType is ComplexAdaptiveDynamicStreaming.


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

    MPS video processing task information. This field has a value only when TaskType is ProcessMediaByMPS.
    AigcImageTask AigcImageTask

    AIGC image generation task info. This field has a value only when TaskType is AigcImageTask.
    AigcVideoTask AigcVideoTask

    AIGC video task information. This field has a value only when TaskType is AigcVideoTask.
    ImportMediaKnowledge ImportMediaKnowledgeTask

    Media import knowledge base task info. This field has a value only when TaskType is ImportMediaKnowledge.
    SceneAigcImageTask SceneAigcImageTask

    Scenario-based AIGC image generation task info. This field has a value only when TaskType is SceneAigcImageTask.
    SceneAigcVideoTask SceneAigcVideoTask

    Scenario-based AIGC video task info. This field has a value only when TaskType is SceneAigcVideoTask.
    ProcessImageAsyncTask ProcessImageAsync

    Asynchronous image processing task information. This field has a value only when TaskType is ProcessImageAsync.
    ExtractBlindWatermarkTask ExtractBlindWatermarkTask

    Extract digital watermark task info. This field has a value only when TaskType is ExtractBlindWatermark.
    CreateAigcAdvancedCustomElementTask CreateAigcAdvancedCustomElementTask

    Create custom entity information. This field has a value only when TaskType is CreateAigcAdvancedCustomElement.
    CreateAigcCustomVoiceTask CreateAigcCustomVoiceTask

    Create custom tone information. This field has a value only when TaskType is CreateAigcCustomVoice.
    CreateAigcSubjectTask CreateAigcSubjectTask

    Create entity information. This field has a value only when TaskType is CreateAigcSubject.
    AigcVideoRedrawTask AigcVideoRedrawTask
    AigcAudioTask AigcAudioTask
    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 Retrieving Task Details - Edit Media

    Retrieve task details - Video editing

    Input Example

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

{
    "TaskId": "12530394xx-EditMedia-61c975da05662fd9d3bf9d89a63361c0t0"
}

    Output Example

    {
    "Response": {
        "TaskType": "EditMedia",
        "Status": "FINISH",
        "CreateTime": "2019-02-25T10:56:02Z",
        "BeginProcessTime": "2019-02-25T10:56:02Z",
        "FinishTime": "2019-02-25T10:56:13Z",
        "ProcedureTask": null,
        "EditMediaTask": {
            "TaskId": "12530394xx-procedurev2-61c975da05662fd9d3bf9d89a63361c0t0",
            "Status": "FINISH",
            "ErrCode": 0,
            "ErrCodeExt": "",
            "Message": "",
            "Progress": 100,
            "ReviewAudioVideoTaskId": "",
            "SessionContext": "",
            "SessionId": "",
            "MetaData": {
                "AudioDuration": 3601,
                "VideoDuration": 3601,
                "Md5": "",
                "Size": 10556,
                "Container": "m4a",
                "Duration": 3601,
                "Bitrate": 246035,
                "Height": 480,
                "Width": 640,
                "Rotate": 0,
                "VideoStreamSet": [
                    {
                        "Bitrate": 246000,
                        "Height": 480,
                        "Width": 640,
                        "Codec": "h264",
                        "Fps": 222,
                        "CodecTag": "",
                        "DynamicRangeInfo": {
                            "Type": "SDR",
                            "HDRType": ""
                        }
                    }
                ],
                "AudioStreamSet": [
                    {
                        "Codec": "aac",
                        "SamplingRate": 44100,
                        "Bitrate": 35
                    }
                ]
            },
            "Input": {
                "InputType": "Stream",
                "FileInfoSet": [
                    {
                        "FileId": "4565514956192708397",
                        "StartTimeOffset": 0,
                        "EndTimeOffset": 30
                    },
                    {
                        "FileId": "4565514956192708396",
                        "StartTimeOffset": 0,
                        "EndTimeOffset": 30
                    }
                ],
                "StreamInfoSet": [
                    {
                        "StreamId": "29920_stream",
                        "StartTime": "2019-02-20T06:21:00Z",
                        "EndTime": "2019-02-20T06:21:30Z"
                    }
                ]
            },
            "Output": {
                "FileType": "mp4",
                "FileId": "4565514956222184986",
                "FileUrl": "http://example.com/9395476dvodcq1253039488/f0e1f8314565514956222184986/playlist.f9.mp4",
                "ExpireTime": "9999-12-31T23:59:59Z",
                "ClassId": 0,
                "MediaName": "editMediaGenfile"
            },
            "ProcedureTaskId": ""
        },
        "ComposeMediaTask": null,
        "SplitMediaTask": null,
        "WechatMiniProgramPublishTask": null,
        "WechatPublishTask": null,
        "TranscodeTask": null,
        "SnapshotByTimeOffsetTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "PullUploadTask": null,
        "RemoveWatermarkTask": null,
        "ReviewAudioVideoTask": null,
        "ReduceMediaBitrateTask": null,
        "ExtractTraceWatermarkTask": null,
        "ExtractCopyRightWatermarkTask": null,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "QualityInspectTask": null,
        "QualityEnhanceTask": null,
        "ComplexAdaptiveDynamicStreamingTask": null,
        "RequestId": "sdfadf"
    }
}

    Example2 Retrieving Task Details - Procedure

    Retrieve task details - Task flow

    Input Example

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

{
    "TaskId": "12567683xx-Procedure-633031cd8293ef29d39251ea751b69f2t0"
}

    Output Example

    {
    "Response": {
        "TaskType": "Procedure",
        "Status": "FINISH",
        "CreateTime": "2019-02-21T08:27:42Z",
        "BeginProcessTime": "2019-02-21T08:27:43Z",
        "FinishTime": "2019-02-21T08:27:44Z",
        "ProcedureTask": {
            "TaskId": "12567683xx-Procedure-2e1af2456351812be963e309cc133403t0",
            "Status": "FINISH",
            "SessionContext": "",
            "SessionId": "",
            "Operator": "",
            "OperationType": "",
            "FileId": "5285890784246869930",
            "FileName": "small",
            "FileUrl": "http://example.com/1c1ae5d2vodgzp12567683xx/c643347c5285890784246869930/AtUCmy6gmIYA.mp4",
            "MetaData": {
                "AudioDuration": 3601,
                "VideoDuration": 3601,
                "Md5": "",
                "Size": 10556,
                "Container": "m4a",
                "Duration": 3601,
                "Bitrate": 246035,
                "Height": 480,
                "Width": 640,
                "Rotate": 0,
                "VideoStreamSet": [
                    {
                        "Bitrate": 246000,
                        "Height": 480,
                        "Width": 640,
                        "Codec": "h264",
                        "Fps": 222,
                        "CodecTag": "",
                        "DynamicRangeInfo": {
                            "Type": "SDR",
                            "HDRType": ""
                        }
                    }
                ],
                "AudioStreamSet": [
                    {
                        "Codec": "aac",
                        "SamplingRate": 44100,
                        "Bitrate": 35
                    }
                ]
            },
            "MediaProcessResultSet": [],
            "AiContentReviewResultSet": [],
            "AiRecognitionResultSet": [],
            "AiAnalysisResultSet": [],
            "TasksPriority": 0,
            "TasksNotifyMode": ""
        },
        "ComposeMediaTask": null,
        "SplitMediaTask": null,
        "WechatMiniProgramPublishTask": null,
        "EditMediaTask": null,
        "WechatPublishTask": null,
        "TranscodeTask": null,
        "SnapshotByTimeOffsetTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "PullUploadTask": null,
        "RemoveWatermarkTask": null,
        "ReviewAudioVideoTask": null,
        "ReduceMediaBitrateTask": null,
        "ExtractTraceWatermarkTask": null,
        "ExtractCopyRightWatermarkTask": null,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "QualityInspectTask": null,
        "QualityEnhanceTask": null,
        "ComplexAdaptiveDynamicStreamingTask": null,
        "RequestId": "sdfadf"
    }
}

    Example3 Retrieving Task Details - Transcode

    Retrieve task details - Transcode

    Input Example

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

{
    "TaskId": "12567683xx-transcode-58a1bc57b1c23ed1079597ec17a47666t0"
}

    Output Example

    {
    "Response": {
        "TaskType": "Transcode",
        "Status": "FINISH",
        "CreateTime": "2019-01-22T06:50:31Z",
        "BeginProcessTime": "2019-01-22T06:50:32Z",
        "FinishTime": "2019-01-22T06:50:45Z",
        "ProcedureTask": null,
        "EditMediaTask": null,
        "TranscodeTask": {
            "TaskId": "12567683xx-transcode-58a1bc57b1c23ed1079597ec17a47666t0",
            "ErrCode": 0,
            "Message": "",
            "FileId": "5285890784246869930",
            "FileName": "small",
            "Duration": 60,
            "CoverUrl": "http://example.com/d042887avodtransgzp12567683xx/c643347c5285890784246869930/1546950643_4191274987.100_0.jpg",
            "PlayInfoSet": [
                {
                    "Url": "http://example.com/1c1ae5d2vodgzp12567683xx/c643347c5285890784246869930/AtUCmy6gmIYA.mp4",
                    "Definition": 0,
                    "Bitrate": 1021028,
                    "Height": 480,
                    "Width": 640
                },
                {
                    "Url": "http://example.com/d042887avodtransgzp12567683xx/c643347c5285890784246869930/v.f10.mp4",
                    "Definition": 10,
                    "Bitrate": 304695,
                    "Height": 240,
                    "Width": 320
                }
            ]
        },
        "ComposeMediaTask": null,
        "WechatMiniProgramPublishTask": null,
        "SplitMediaTask": null,
        "SnapshotByTimeOffsetTask": null,
        "WechatPublishTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "PullUploadTask": null,
        "RemoveWatermarkTask": null,
        "ReviewAudioVideoTask": null,
        "ReduceMediaBitrateTask": null,
        "ExtractTraceWatermarkTask": null,
        "ExtractCopyRightWatermarkTask": null,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "QualityInspectTask": null,
        "QualityEnhanceTask": null,
        "ComplexAdaptiveDynamicStreamingTask": null,
        "RequestId": "62597d15-3fad-4234-af1a-ed33602a6118"
    }
}

    Example4 Retrieving Task Details - WeChat Mini Program Publish

    retrieve task details - WeChat Mini Program Publishing

    Input Example

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

{
    "TaskId": "1253339xxx-wechat-mini-program-publish-e576984516ec3b3c8e49753adf6b0688t0"
}

    Output Example

    {
    "Response": {
        "TaskType": "WechatMiniProgramPublish",
        "Status": "FINISH",
        "CreateTime": "2019-06-23T13:04:42Z",
        "BeginProcessTime": "2019-06-23T13:04:42Z",
        "FinishTime": "2019-06-23T13:04:53Z",
        "ProcedureTask": null,
        "EditMediaTask": null,
        "ComposeMediaTask": null,
        "WechatPublishTask": null,
        "PullUploadTask": null,
        "WechatMiniProgramPublishTask": {
            "TaskId": "1253339xxx-wechat-mini-program-publish-e576984516ec3b3c8e49753adf6b0688t0",
            "Status": "FINISH",
            "ErrCode": 0,
            "Message": "",
            "FileId": "5285890789444337543",
            "SourceDefinition": 0,
            "PublishResult": "Pass"
        },
        "SplitMediaTask": null,
        "TranscodeTask": null,
        "SnapshotByTimeOffsetTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "RemoveWatermarkTask": null,
        "ReviewAudioVideoTask": null,
        "ReduceMediaBitrateTask": null,
        "ExtractTraceWatermarkTask": null,
        "ExtractCopyRightWatermarkTask": null,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "QualityInspectTask": null,
        "QualityEnhanceTask": null,
        "ComplexAdaptiveDynamicStreamingTask": null,
        "RequestId": "04db7d25-f590-414a-a341-8f1584f15f84"
    }
}

    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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.SubAppId Incorrect parameter value: application id.
    InvalidParameterValue.TaskId The task ID does not exist.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.
    Previous Topic: ManageTaskNext Topic: DescribeTasks

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback