文档

GetTranscodeTask - 查询转码任务详情

调用GetTranscodeTask根据转码任务ID查询转码作业详细信息。

接口说明

使用说明

本接口仅支持查询一年内的转码任务数据。

QPS 限制

本接口的单用户 QPS 限制为 15 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:GetTranscodeTaskRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TranscodeTaskIdstring

转码任务 ID,可通过以下方式获取:

  • 通过 SubmitTranscodeJobs 接口发起转码任务时,为返回参数 TranscodeTaskId 的值。
  • 通过 ListTranscodeTask 接口查询,为请求后返回参数 TranscodeTaskId 的值。
b1b65ab107e14*****3dbb900f6c1fe0

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F4C6D5BE-BF13-45*****6C-516EA8906DCD
TranscodeTaskobject

转码任务信息。

CreationTimestring

转码任务创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-01-23T12:35:12Z
Triggerstring

触发类型。取值:

  • Auto:上传视频,自动触发。
  • Manual :SubmitTranscodeJobs 接口触发。
Auto
TaskStatusstring

转码任务状态。取值:

  • Processing:处理中。
  • Partial:部分转码完成。
  • CompleteAllSucc:全部处理完成,且全部转码成功。
  • CompleteAllFail:全部处理完成,且全部转码失败,如果源片有问题,则不会发起任何转码作业,整个转码任务失败。
  • CompletePartialSucc:全部转码完成,但仅部分转码成功。
Processing
VideoIdstring

音/视频 ID。

883f5d98107*****b7f20aaa352f
CompleteTimestring

转码任务完成时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-01-23T12:40:12Z
TranscodeTemplateGroupIdstring

转码使用的模板组 ID。

b500c7094bd241*****3e9900752d7c3
TranscodeTaskIdstring

转码任务 ID。

b1b65ab107e14*****3dbb900f6c1fe0
TranscodeJobInfoListobject []

转码作业信息。

Definitionstring

视频清晰度。取值:

  • LD:流畅。
  • SD:标清。
  • HD:高清。
  • FHD:超清。
  • OD:原画。
  • 2K:2K。
  • 4K:4K。
  • SQ:普通音质。
  • HQ:高音质
  • AUTO:自适应码率。仅当转码模板中配置了打包时才会有该清晰度输出,请参见转码模板配置-PackageSetting
说明 该值为转码模板配置的清晰度标记,不表示转码输出文件实际的分辨率范围。
LD
CreationTimestring

转码作业创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-02-26T08:27:16Z
InputFileUrlstring

转码源文件的 OSS 地址。

http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv
ErrorMessagestring

转码失败错误信息。

ErrorMessage
ErrorCodestring

转码失败错误码。

200
CompleteTimestring

转码作业完成时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-02-26T08:30:16Z
TranscodeProgresslong

转码作业处理进度。取值范围:[0,100]

100
Prioritystring

转码任务优先级。

6
TranscodeJobStatusstring

转码作业状态。

  • Transcoding:转码中。
  • TranscodeSuccess:转码成功。
  • TranscodeFail:转码失败。
Transcoding
TranscodeTemplateIdstring

转码使用的转码模板 ID。

174b0534fea3*****b51c8f0ad1374
TranscodeJobIdstring

转码作业 ID。

38f0e513c88*****85515f9d50be188
OutputFileobject

转码输出文件的信息。

VideoStreamListstring

视频流列表。

[{\"AvgFPS\":\"30.0\",\"Bitrate\":\"933.814\",\"CodecLongName\":\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\",\"CodecName\":\"h264\",\"CodecTag\":\"0x31637661\",\"CodecTagString\":\"avc1\",\"CodecTimeBase\":\"1/60\",\"Dar\":\"9:16\",\"Duration\":\"12.033333\",\"Fps\":\"30.0\",\"HasBFrames\":\"2\",\"Height\":\"360\",\"Index\":\"0\",\"Lang\":\"und\",\"Level\":\"30\",\"PixFmt\":\"yuv420p\",\"Profile\":\"High\",\"Sar\":\"81:256\",\"StartTime\":\"0.000000\",\"Timebase\":\"1/15360\",\"Width\":\"640\"}]
OutputFileUrlstring

转码输出文件的 OSS 地址。

http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4
Encryptionstring

转码输出文件使用的加密配置。取值:

  • AliyunVoDEncryption:阿里云视频加密(私有加密)。
  • HLSEncryption:HLS 标准加密。
{\"EncryptType\":\"AliyunVoDEncryption\"}
Heightstring

转码输出文件视频画面高。单位:px。

360
SubtitleStreamListstring

字幕流列表。

[]
Bitratestring

转码输出文件平均码率。单位:Kbps。

964
AudioStreamListstring

音频流列表。

"AudioStreamList": "[{\"Bitrate\":\"64.533\",\"ChannelLayout\":\"stereo\",\"Channels\":\"2\",\"CodecLongName\":\"AAC (Advanced Audio Coding)\",\"CodecName\":\"aac\",\"CodecTag\":\"0x6134706d\",\"CodecTagString\":\"mp4a\",\"CodecTimeBase\":\"1/44100\",\"Duration\":\"12.615533\",\"Index\":\"1\",\"Lang\":\"und\",\"SampleFmt\":\"fltp\",\"Samplerate\":\"44100\",\"StartTime\":\"-0.046440\",\"Timebase\":\"1/44100\"}]
Widthstring

转码输出文件视频画面宽。单位:px。

640
Fpsstring

转码输出文件的帧率。单位:帧/秒。

25
Durationstring

转码输出文件时长。单位:秒。

12
Formatstring

转码输出文件的封装格式。

m3u8
Filesizelong

转码输出文件大小。单位:Byte。

851076
WatermarkIdListarray

转码输出文件使用的水印 ID 列表。

string

转码输出文件使用的水印 ID 列表。

["64079a0e3e286*****b48a8c9413"]

示例

正常返回示例

JSON格式

{
  "RequestId": "F4C6D5BE-BF13-45*****6C-516EA8906DCD",
  "TranscodeTask": {
    "CreationTime": "2019-01-23T12:35:12Z",
    "Trigger": "Auto ",
    "TaskStatus": "Processing",
    "VideoId": "883f5d98107*****b7f20aaa352f",
    "CompleteTime": "2019-01-23T12:40:12Z",
    "TranscodeTemplateGroupId": "b500c7094bd241*****3e9900752d7c3",
    "TranscodeTaskId": "b1b65ab107e14*****3dbb900f6c1fe0",
    "TranscodeJobInfoList": [
      {
        "Definition": "LD",
        "CreationTime": "2019-02-26T08:27:16Z",
        "InputFileUrl": "http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv",
        "ErrorMessage": "ErrorMessage",
        "ErrorCode": "200",
        "CompleteTime": "2019-02-26T08:30:16Z",
        "TranscodeProgress": 100,
        "Priority": "6",
        "TranscodeJobStatus": "Transcoding",
        "TranscodeTemplateId": "174b0534fea3*****b51c8f0ad1374",
        "TranscodeJobId": "38f0e513c88*****85515f9d50be188",
        "OutputFile": {
          "VideoStreamList": "[{\\\"AvgFPS\\\":\\\"30.0\\\",\\\"Bitrate\\\":\\\"933.814\\\",\\\"CodecLongName\\\":\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\",\\\"CodecName\\\":\\\"h264\\\",\\\"CodecTag\\\":\\\"0x31637661\\\",\\\"CodecTagString\\\":\\\"avc1\\\",\\\"CodecTimeBase\\\":\\\"1/60\\\",\\\"Dar\\\":\\\"9:16\\\",\\\"Duration\\\":\\\"12.033333\\\",\\\"Fps\\\":\\\"30.0\\\",\\\"HasBFrames\\\":\\\"2\\\",\\\"Height\\\":\\\"360\\\",\\\"Index\\\":\\\"0\\\",\\\"Lang\\\":\\\"und\\\",\\\"Level\\\":\\\"30\\\",\\\"PixFmt\\\":\\\"yuv420p\\\",\\\"Profile\\\":\\\"High\\\",\\\"Sar\\\":\\\"81:256\\\",\\\"StartTime\\\":\\\"0.000000\\\",\\\"Timebase\\\":\\\"1/15360\\\",\\\"Width\\\":\\\"640\\\"}]",
          "OutputFileUrl": "http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4",
          "Encryption": "{\\\"EncryptType\\\":\\\"AliyunVoDEncryption\\\"}",
          "Height": "360",
          "SubtitleStreamList": "[]",
          "Bitrate": "964",
          "AudioStreamList": "\"AudioStreamList\": \"[{\\\"Bitrate\\\":\\\"64.533\\\",\\\"ChannelLayout\\\":\\\"stereo\\\",\\\"Channels\\\":\\\"2\\\",\\\"CodecLongName\\\":\\\"AAC (Advanced Audio Coding)\\\",\\\"CodecName\\\":\\\"aac\\\",\\\"CodecTag\\\":\\\"0x6134706d\\\",\\\"CodecTagString\\\":\\\"mp4a\\\",\\\"CodecTimeBase\\\":\\\"1/44100\\\",\\\"Duration\\\":\\\"12.615533\\\",\\\"Index\\\":\\\"1\\\",\\\"Lang\\\":\\\"und\\\",\\\"SampleFmt\\\":\\\"fltp\\\",\\\"Samplerate\\\":\\\"44100\\\",\\\"StartTime\\\":\\\"-0.046440\\\",\\\"Timebase\\\":\\\"1/44100\\\"}]",
          "Width": "640",
          "Fps": "25",
          "Duration": "12",
          "Format": "m3u8",
          "Filesize": 851076,
          "WatermarkIdList": [
            "[\"64079a0e3e286*****b48a8c9413\"]"
          ]
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
NoSuchResourceThe specified resource %s does not exist.404特定的信息不存在,%s 表示指定的信息。
  • 本页导读 (1)
文档反馈