查询任务详情

最近更新时间:2019-08-01 19:09:36

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskDetail
Version String 公共参数,本接口取值:2018-07-17
Region String 公共参数,本接口不需要传递此参数。
TaskId String 视频处理任务的任务 ID。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

3. 输出参数

参数名称 类型 描述
TaskType String 任务类型,取值:
  • Procedure:视频处理任务;
  • EditMedia:视频编辑任务;
  • WechatPublish:微信发布任务;
  • WechatMiniProgramPublish:微信小程序视频发布任务;
  • ComposeMedia:制作媒体文件任务;
  • PullUpload:拉取上传媒体文件任务。


  • 兼容 2017 版的任务类型:
  • Transcode:视频转码任务;
  • SnapshotByTimeOffset:视频截图任务;
  • Concat:视频拼接任务;
  • Clip:视频剪辑任务;
  • ImageSprites:截取雪碧图任务。
  • Status String 任务状态,取值:
  • WAITING:等待中;
  • PROCESSING:处理中;
  • FINISH:已完成。
  • CreateTime String 任务的创建时间,采用 ISO 日期格式
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    ProcedureTask ProcedureTask 视频处理任务信息,仅当 TaskType 为 Procedure,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    EditMediaTask EditMediaTask 视频编辑任务信息,仅当 TaskType 为 EditMedia,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    WechatPublishTask WechatPublishTask 微信发布任务信息,仅当 TaskType 为 WechatPublish,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    ComposeMediaTask ComposeMediaTask 制作媒体文件任务信息,仅当 TaskType 为 ComposeMedia,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    PullUploadTask PullUploadTask 拉取上传媒体文件任务信息,仅当 TaskType 为 PullUpload,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    TranscodeTask TranscodeTask2017 视频转码任务信息,仅当 TaskType 为 Transcode,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotByTimeOffsetTask SnapshotByTimeOffsetTask2017 视频指定时间点截图任务信息,仅当 TaskType 为 SnapshotByTimeOffset,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    ConcatTask ConcatTask2017 视频拼接任务信息,仅当 TaskType 为 Concat,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    ClipTask ClipTask2017 视频剪辑任务信息,仅当 TaskType 为 Clip,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateImageSpriteTask CreateImageSpriteTask2017 截取雪碧图任务信息,仅当 TaskType 为 ImageSprite,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    WechatMiniProgramPublishTask WechatMiniProgramPublishTask 微信小程序发布任务信息,仅当 TaskType 为 WechatMiniProgramPublish,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取任务详情-Procedure

    输入示例

    https://vod.tencentcloudapi.com/?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": "",
          "FileId": "5285890784246869930",
          "FileName": "small",
          "FileUrl": "http://12567683xx.vod2.myqcloud.com/1c1ae5d2vodgzp12567683xx/c643347c5285890784246869930/AtUCmy6gmIYA.mp4",
          "MetaData": {
            "AudioDuration": 59.9900016784668,
            "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
              }
            ],
            "Width": 640
          },
          "MediaProcessResultSet": null,
          "AiContentReviewResultSet": null,
          "AiAnalysisResultSet": null,
          "TasksPriority": 0,
          "TasksNotifyMode": ""
        },
        "EditMediaTask": null,
        "WechatPublishTask": null,
        "TranscodeTask": null,
        "SnapshotByTimeOffsetTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "PullUploadTask": null,
        "RequestId": "sdfadf"
      }
    }

    示例2 获取任务详情-Transcode

    输入示例

    https://vod.tencentcloudapi.com/?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
            }
          ]
        },
        "SnapshotByTimeOffsetTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "PullUploadTask": null,
        "RequestId": "62597d15-3fad-4234-af1a-ed33602a6118"
      }
    }

    示例3 获取任务详情-EditMedia

    输入示例

    https://vod.tencentcloudapi.com/?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,
          "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": "",
            "FileId": "4565514956222184986",
            "FileUrl": "http://12530394xx.vod2.myqcloud.com/9395476dvodcq1253039488/f0e1f8314565514956222184986/playlist.f9.mp4"
          },
          "ProcedureTaskId": ""
        },
        "WechatPublishTask": null,
        "TranscodeTask": null,
        "SnapshotByTimeOffsetTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "PullUploadTask": null,
        "RequestId": "sdfadf"
      }
    }

    示例4 获取任务详情-WechatMiniProgramPublish

    输入示例

    https://vod.tencentcloudapi.com/?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"
        },
        "TranscodeTask": null,
        "SnapshotByTimeOffsetTask": null,
        "ConcatTask": null,
        "ClipTask": null,
        "CreateImageSpriteTask": null,
        "RequestId": "04db7d25-f590-414a-a341-8f1584f15f84"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.SubAppId 参数值错误:子应用 ID。
    InvalidParameterValue.TaskId 任务 ID 不存在。
    ResourceNotFound 资源不存在。
    UnauthorizedOperation 未授权操作。