云点播

文档中心云点播服务端 API 文档任务管理相关接口查询任务详情

查询任务详情

最近更新时间：2024-04-03 11:31:58

我的收藏

本页目录：

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

通过任务 ID 查询任务的执行状态和结果的详细信息（最多可以查询3天之内提交的任务）。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTaskDetail。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
TaskId	是	String	视频处理任务的任务 ID。示例值：1490012345-procedurev2-abc123
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：1490012345

3. 输出参数

参数名称	类型	描述
TaskType	String	任务类型，取值： Procedure：视频处理任务； EditMedia：视频编辑任务； SplitMedia：视频拆条任务； ComposeMedia：制作媒体文件任务； WechatPublish：微信发布任务； WechatMiniProgramPublish：微信小程序视频发布任务； PullUpload：拉取上传媒体文件任务； FastClipMedia：快速剪辑任务； RemoveWatermarkTask：智能去除水印任务； DescribeFileAttributesTask：获取文件属性任务； RebuildMedia：音画质重生任务（不推荐使用）； ReviewAudioVideo：音视频审核任务； ExtractTraceWatermark：提取溯源水印任务； ExtractCopyRightWatermark：提取版权水印任务； QualityInspect：音画质检测任务； QualityEnhance：音画质重生任务。示例值：Procedure
Status	String	任务状态，取值： WAITING：等待中； PROCESSING：处理中； FINISH：已完成。示例值：FINISH
CreateTime	String	任务的创建时间，采用 ISO 日期格式。示例值：2019-02-21T08:27:42Z
BeginProcessTime	String	任务开始执行的时间，采用 ISO 日期格式。示例值：2019-02-21T08:27:43Z
FinishTime	String	任务执行完毕的时间，采用 ISO 日期格式。示例值：2019-02-21T08:27:44Z
ProcedureTask	ProcedureTask	视频处理任务信息，仅当 TaskType 为 Procedure，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
EditMediaTask	EditMediaTask	视频编辑任务信息，仅当 TaskType 为 EditMedia，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
WechatPublishTask	WechatPublishTask	微信发布任务信息，仅当 TaskType 为 WechatPublish，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
ComposeMediaTask	ComposeMediaTask	制作媒体文件任务信息，仅当 TaskType 为 ComposeMedia，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
SplitMediaTask	SplitMediaTask	视频拆条任务信息，仅当 TaskType 为 SplitMedia，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
WechatMiniProgramPublishTask	WechatMiniProgramPublishTask	微信小程序发布任务信息，仅当 TaskType 为 WechatMiniProgramPublish，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
PullUploadTask	PullUploadTask	拉取上传媒体文件任务信息，仅当 TaskType 为 PullUpload，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
TranscodeTask	TranscodeTask2017	视频转码任务信息，仅当 TaskType 为 Transcode，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
ConcatTask	ConcatTask2017	视频拼接任务信息，仅当 TaskType 为 Concat，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
ClipTask	ClipTask2017	视频剪辑任务信息，仅当 TaskType 为 Clip，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
CreateImageSpriteTask	CreateImageSpriteTask2017	截取雪碧图任务信息，仅当 TaskType 为 ImageSprite，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
SnapshotByTimeOffsetTask	SnapshotByTimeOffsetTask2017	视频指定时间点截图任务信息，仅当 TaskType 为 SnapshotByTimeOffset，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
RemoveWatermarkTask	RemoveWatermarkTask	智能去除水印任务信息，仅当 TaskType 为 RemoveWatermark，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
RebuildMediaTask	RebuildMediaTask	音画质重生任务信息，仅当 TaskType 为 RebuildMedia，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
ExtractTraceWatermarkTask	ExtractTraceWatermarkTask	提取溯源水印任务信息，仅当 TaskType 为 ExtractTraceWatermark，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
ExtractCopyRightWatermarkTask	ExtractCopyRightWatermarkTask	提取版权水印任务信息，仅当 TaskType 为 ExtractCopyRightWatermark，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
ReviewAudioVideoTask	ReviewAudioVideoTask	音视频审核任务信息，仅当 TaskType 为 ReviewAudioVideo，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
ReduceMediaBitrateTask	ReduceMediaBitrateTask	该字段已无效。注意：此字段可能返回 null，表示取不到有效值。
DescribeFileAttributesTask	DescribeFileAttributesTask	获取文件属性任务信息，仅当 TaskType 为 DescribeFileAttributes，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
QualityInspectTask	QualityInspectTask	音画质检测任务信息，仅当 TaskType 为 QualityInspect 时该字段有值。注意：此字段可能返回 null，表示取不到有效值。
QualityEnhanceTask	QualityEnhanceTask	音画质重生任务信息，仅当 TaskType 为 QualityEnhance，该字段有值。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取任务详情-EditMedia

获取任务详情-编辑视频

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>

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

输出示例

{
    "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://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,
        "ExtractCopyRightWatermarkTask": null,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "QualityInspectTask": null,
        "QualityEnhanceTask": null,
        "RequestId": "sdfadf"
    }
}

示例2 获取任务详情-Procedure

获取任务详情-任务流

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>

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

输出示例

{
    "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": 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,
        "RequestId": "sdfadf"
    }
}

示例3 获取任务详情-Transcode

获取任务详情-转码

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>

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

输出示例

{
    "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,
        "ExtractCopyRightWatermarkTask": null,
        "DescribeFileAttributesTask": null,
        "RebuildMediaTask": null,
        "QualityInspectTask": null,
        "QualityEnhanceTask": null,
        "RequestId": "62597d15-3fad-4234-af1a-ed33602a6118"
    }
}

示例4 获取任务详情-WechatMiniProgramPublish

获取任务详情-微信小程序发布

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>

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

输出示例

{
    "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,
        "RequestId": "04db7d25-f590-414a-a341-8f1584f15f84"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.InvalidVodUser	没有开通点播业务。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.SubAppId	参数值错误：子应用 ID。
InvalidParameterValue.TaskId	任务 ID 不存在。
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。