查询任务详情

最近更新时间:2019-08-27 20:16:15

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskDetail
Version String 公共参数,本接口取值:2019-06-12
Region String 公共参数,本接口不需要传递此参数。
TaskId String 视频处理任务的任务 ID。

3. 输出参数

参数名称 类型 描述
TaskType String 任务类型,目前仅有取值 WorkflowTask。
Status String 任务状态,取值:
  • WAITING:等待中;
  • PROCESSING:处理中;
  • FINISH:已完成。
  • CreateTime String 任务的创建时间,采用 ISO 日期格式
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    WorkflowTask WorkflowTask 视频处理任务信息,仅当 TaskType 为 WorkflowTask,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    TaskNotifyConfig TaskNotifyConfig 任务的事件通知信息。
    注意:此字段可能返回 null,表示取不到有效值。
    TasksPriority Integer 任务流的优先级,取值范围为 [-10, 10]。
    SessionId String 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长50个字符,不带或者带空字符串表示不做去重。
    SessionContext String 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长1000个字符。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取任务详情

    输入示例

    https://mps.tencentcloudapi.com/?Action=DescribeTaskDetail
    &TaskId=235303****-WorkflowTask-80108cc3380155d98b2e3573a48a******
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TaskType": "WorkflowTask",
        "Status": "FINISH",
        "CreateTime": "2019-07-16T06:21:27Z",
        "BeginProcessTime": "2019-07-16T06:21:28Z",
        "FinishTime": "2019-07-16T06:21:46Z",
        "WorkflowTask": {
          "TaskId": "235303****-WorkflowTask-80108cc3380155d98b2e3573a48a******",
          "Status": "FINISH",
          "ErrCode": 0,
          "Message": "",
          "InputInfo": {
            "Type": "COS",
            "CosInputInfo": {
              "Bucket": "vodtestbj-235303****",
              "Region": "ap-beijing",
              "Object": "/input/videoplayback.mp4"
            }
          },
          "MetaData": {
            "AudioDuration": 380.9465637207031,
            "AudioStreamSet": [
              {
                "Bitrate": 95999,
                "Codec": "aac",
                "SamplingRate": 44100
              }
            ],
            "Bitrate": 409657,
            "Container": "mov,mp4,m4a,3gp,3g2,mj2",
            "Duration": 380.9465637207031,
            "Height": 360,
            "Rotate": 0,
            "Size": 19626862,
            "VideoDuration": 380.8804931640625,
            "VideoStreamSet": [
              {
                "Bitrate": 313658,
                "Codec": "h264",
                "Fps": 29,
                "Height": 360,
                "Width": 480
              }
            ],
            "Width": 480
          },
          "MediaProcessResultSet": [
            {
              "Type": "Transcode",
              "TranscodeTask": {
                "Status": "SUCCESS",
                "ErrCode": 0,
                "Message": "SUCCESS",
                "Input": {
                  "Definition": 210,
                  "WatermarkSet": [],
                  "OutputStorage": {
                    "Type": "COS",
                    "CosOutputStorage": {
                      "Bucket": "vodtestgz-235303****",
                      "Region": "ap-guangzhou"
                    }
                  },
                  "OutputObjectPath": "/hello/world/what/ever/videoplayback_transcode111_210",
                  "SegmentObjectName": "/hello/world/what/ever/no/problem/videoplayback_transcode11_210_{number}",
                  "ObjectNumberFormat": {
                    "InitialValue": 2,
                    "Increment": 3,
                    "MinLength": 1,
                    "PlaceHolder": "0"
                  }
                },
                "Output": {
                  "OutputStorage": {
                    "Type": "COS",
                    "CosOutputStorage": {
                      "Bucket": "vodtestgz-235303****",
                      "Region": "ap-guangzhou"
                    }
                  },
                  "Path": "/hello/world/what/ever/videoplayback_transcode111_210.m3u8",
                  "Definition": 210,
                  "Bitrate": 353297,
                  "Height": 240,
                  "Width": 320,
                  "Size": 5692,
                  "Duration": 380.9580078125,
                  "Container": "hls,applehttp",
                  "Md5": "ae0dfe7c7336291d6243463b7bb14fea",
                  "VideoStreamSet": [
                    {
                      "Bitrate": 302307,
                      "Codec": "h264",
                      "Fps": 24,
                      "Height": 240,
                      "Width": 320
                    }
                  ],
                  "AudioStreamSet": [
                    {
                      "Bitrate": 50990,
                      "Codec": "aac",
                      "SamplingRate": 44100
                    }
                  ]
                }
              },
              "AnimatedGraphicTask": null,
              "SnapshotByTimeOffsetTask": null,
              "SampleSnapshotTask": null,
              "ImageSpriteTask": null
            }
          ]
        },
        "TaskNotifyConfig": null,
        "TasksPriority": 0,
        "SessionId": "",
        "SessionContext": "",
        "RequestId": "requestId"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。
    ResourceNotFound 资源不存在。