tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeTaskDetail

最后更新时间：2024-03-27 16:08:06

    1. API Description

    Domain name for API request: vod.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 The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.

    3. Output Parameters

    Parameter Name Type Description
    TaskType String The task type. Valid values:
  • Procedure: Video processing
  • EditMedia: Video editing
  • SplitMedia: Video splitting
  • ComposeMedia: Media file production
  • WechatPublish: Weixin publishing
  • WechatMiniProgramPublish: Publishing videos on Weixin Mini Program
  • PullUpload: Pulling media files for upload
  • FastClipMedia: Quick clipping
  • RemoveWatermarkTask: Watermark removal
  • DescribeFileAttributesTask: Getting file attributes
  • ReviewAudioVideo: Moderation
  • ExtractTraceWatermark: Digital watermark extraction
  • QualityEnhance: Enhance audio/video
    		•
    Status String Task status. Valid values:
  • WAITING: waiting;
  • PROCESSING: processing;
  • FINISH: completed.
    		•
    CreateTime String Creation time of task in ISO date format.
    BeginProcessTime String Start time of task execution in ISO date format.
    FinishTime String End time of task execution in ISO date format.
    ProcedureTask ProcedureTask
    Note: This field may return null, indicating that no valid value can be obtained.
    EditMediaTask EditMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    WechatPublishTask WechatPublishTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ComposeMediaTask ComposeMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    SplitMediaTask SplitMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    WechatMiniProgramPublishTask WechatMiniProgramPublishTask
    Note: This field may return null, indicating that no valid value can be obtained.
    PullUploadTask PullUploadTask
    Note: This field may return null, indicating that no valid value can be obtained.
    TranscodeTask TranscodeTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    ConcatTask ConcatTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    ClipTask ClipTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    CreateImageSpriteTask CreateImageSpriteTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    SnapshotByTimeOffsetTask SnapshotByTimeOffsetTask2017
    Note: This field may return null, indicating that no valid value can be obtained.
    RemoveWatermarkTask RemoveWatermarkTask
    Note: This field may return null, indicating that no valid value can be obtained.
    RebuildMediaTask RebuildMediaTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ExtractTraceWatermarkTask ExtractTraceWatermarkTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ExtractCopyRightWatermarkTask ExtractCopyRightWatermarkTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ReviewAudioVideoTask ReviewAudioVideoTask
    Note: This field may return null, indicating that no valid value can be obtained.
    ReduceMediaBitrateTask ReduceMediaBitrateTask
    Note: This field may return null, indicating that no valid value can be obtained.
    DescribeFileAttributesTask DescribeFileAttributesTask
    Note: This field may return null, indicating that no valid value can be obtained.
    QualityInspectTask QualityInspectTask
    Note: This field may return null, indicating that no valid value can be obtained.
    QualityEnhanceTask QualityEnhanceTask Media Quality Enhance task information. This field has a value only when TaskType is QualityEnhance.
    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 Getting the details of a task flow

    This example shows you how to get the details of a task flow.

    Input Example

    POST / HTTP/1.1
Host: vod.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",
            "ErrCode": 0,
            "Message": "",
            "SessionContext": "",
            "SessionId": "",
            "Operator": "",
            "OperationType": "",
            "FileId": "5285890784246869930",
            "FileName": "small",
            "FileUrl": "http://12567683xx.vod2.myqcloud.com/1c1ae5d2vodgzp12567683xx/c643347c5285890784246869930/AtUCmy6gmIYA.mp4",
            "MetaData": {
                "AudioDuration": 59.9900016784668,
                "Md5": "",
                "AudioStreamSet": [
                    {
                        "Bitrate": 383854,
                        "Codec": "aac",
                        "SamplingRate": 48000
                    }
                ],
                "Bitrate": 1021028,
                "Container": "mov,mp4,m4a,3gp,3g2,mj2",
                "Duration": 60,
                "Height": 480,
                "Rotate": 0,
                "Size": 7700180,
                "VideoDuration": 60,
                "VideoStreamSet": [
                    {
                        "Bitrate": 637174,
                        "Codec": "h264",
                        "Fps": 23,
                        "Height": 480,
                        "Width": 640,
                        "DynamicRangeInfo": {}
                    }
                ],
                "Width": 640
            },
            "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,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "RequestId": "sdfadf"
    }
}

    Example2 Querying the details of a transcoding task

    This example shows you how to get the details of a transcoding task.

    Input Example

    POST / HTTP/1.1
Host: vod.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://12567683xx.vod2.myqcloud.com/d042887avodtransgzp12567683xx/c643347c5285890784246869930/1546950643_4191274987.100_0.jpg",
            "PlayInfoSet": [
                {
                    "Url": "http://12567683xx.vod2.myqcloud.com/1c1ae5d2vodgzp12567683xx/c643347c5285890784246869930/AtUCmy6gmIYA.mp4",
                    "Definition": 0,
                    "Bitrate": 1021028,
                    "Height": 480,
                    "Width": 640
                },
                {
                    "Url": "http://12567683xx.vod2.myqcloud.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,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "RequestId": "62597d15-3fad-4234-af1a-ed33602a6118"
    }
}

    Example3 Querying the details of a video editing task

    This example shows you how to get the details of a video editing task.

    Input Example

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

{
    "TaskId": "12530394xx-procedurev2-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,
            "Message": "",
            "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://12530394xx.vod2.myqcloud.com/9395476dvodcq1253039488/f0e1f8314565514956222184986/playlist.f9.mp4"
            },
            "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,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "RequestId": "sdfadf"
    }
}

    Example4 Querying the details of a Weixin Mini Program publishing task

    This example shows you how to get the details of a Weixin Mini Program publishing task.

    Input Example

    POST / HTTP/1.1
Host: vod.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,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": 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: subapplication ID
    InvalidParameterValue.TaskId The task ID does not exist.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款