文档

QueryJobList - 查询转码作业

更新时间:

通过转码作业ID,批量查询转码作业。

接口说明

  • 本接口一次最多查询 10 个转码作业。
  • 如果不传入 JobIds,则会返回InvalidParameter(参数无效)错误码。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

转码作业 ID。

  • 一次最多查询 10 个,使用半角逗号(,)分隔。
  • 可以通过 MPS 控制台 > 任务管理获取,也可以从提交转码作业的返回参数中获取。
说明 如果不传入此参数,则会返回InvalidParameter(参数无效)错误码。
bb558c1cc25b45309aab5be44d19****,d1ce4d3efcb549419193f50f1fcd****

返回参数

名称类型描述示例值
object

返回参数。

NonExistJobIdsarray

不存在的作业 ID。

string

不存在的转码作业 ID 列表,无数据时该结构不返回。

d1ce4d3efcb549419193f50f1fcd****
RequestIdstring

请求 ID。

197ADF44-104C-514C-9F92-D8924CB34E2A
JobListobject []

转码作业集合。

CreationTimestring

作业添加时间。

2014-01-10T12:00:00Z
Percentlong

转码进度。

100
FinishTimestring

作业完成时间。

2014-01-10T12:20:25Z
Statestring

作业状态。

  • Submitted:作业已提交。
  • Transcoding:转码中。
  • TranscodeSuccess:转码成功。
  • TranscodeFail:转码失败。
  • TranscodeCancelled:转码取消。
TranscodeSuccess
JobIdstring

任务 ID。

31fa3c9ca8134fb4b0b0f7878301****
Codestring

任务失败时的错误码。成功则不返回此参数。

InvalidParameter.NullValue
Messagestring

任务失败时的消息。成功则不返回此参数。

The specified parameter "%s" cannot be null.
Outputobject

作业输出。

Videoobject

视频配置。

Bufsizestring

缓冲区大小。

  • 单位:Kb。
  • 默认值:6000
6000
Degrainstring

独立去噪算法强度。

5
BitrateBndobject

视频平均码率范围。

Maxstring

最大码率。

1000
Minstring

最小码率。

300
PixFmtstring

视频颜色格式。范围:yuv420p,yuvj420p 等标准颜色格式。

yuv420p
Padstring

视频贴黑边。

  • 单位:px。

  • 参数格式:width:height:left:top。

1280:800:0:140
Codecstring

编解码格式。

  • 支持 H.264、H.265。
  • 默认值:H.264。
H.264
Heightstring

高。

  • 单位:px。
  • 默认值:视频原始高度。
720
Qscalestring

视频质量控制度。

15
Cropstring

视频画面裁剪,支持 2 种方式:

  • 自动检测黑边并裁切,设置为 border
  • 自定义裁切,参数格式为 width:height:left:top。
1280:800:0:140
Bitratestring

视频平均码率。单位:Kbps。

500
Maxratestring

视频码率峰值。单位:Kbps。

3000
MaxFpsstring

最大帧率。

60
Profilestring

编码级别。支持 baseline、main、high。

说明 如果您有多个清晰度,建议最低清晰度配置成 baseline,以保证最低端设备可播放。其他清晰度配置为 main 或 high。
  • baseline:针对移动设备。
  • main:针对标准分辨率设备。
  • high:针对高分辨率设备。
  • 默认值:high
high
Crfstring

码率-质量控制因子。

  • 默认值:编码格式为 H264,默认值为 23。编码格式为 H265,默认值为 26
  • 如果设置了 Crf,则 Bitrate 的设置失效。
26
Gopstring

关键帧间最大时间间隔或最大帧数。单位:秒。

  • 默认值:250

  • 最大帧数时无单位。

250
Widthstring

宽。

  • 单位:px。
  • 默认值:视频原始宽度。
1280
Fpsstring

帧率。

  • 单位:fps。

  • 当输入文件帧率超过 60 时取 60。

  • 默认值:取输入文件帧率。

25
Presetstring

视频算法器预置。默认值:medium。可取值:

  • veryfast:超快。

  • fast:快。

  • medium:中等。

  • slow:慢。

  • slower:超慢。

medium
ScanModestring

扫描模式。取值如下:

  • 不设置:按输入文件的原始模式。
  • auto:自动去隔行。
  • progressive:顺序扫描(逐行扫描)。
  • interlaced:交叉扫描(隔行扫描)。
  • 默认值:空,即不设置。

最佳实践:交叉扫描虽然比顺序扫描更节省数据量,但画质不佳,所以现在主流视频制作都采用顺序扫描。

  • 如果您设置了顺序扫描交叉扫描,但与原视频模式不符,会导致转码失败。
  • 建议您设置原视频模式自动去隔行,以提高兼容性。
interlaced
ResoPrioritystring

资源优先级。

1
TransConfigobject

转码通用配置。

说明 如果请求参数中设置了该值,则覆盖指定转码模板中的对应参数。
IsCheckAudioBitratestring

是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于 IsCheckAudioBitrateFail。

  • true 表示检查。
  • false 表示不检查。
  • 默认值:
    • 参数为空,并且 codec 和输入源不一样:false。
    • 参数为空,并且 codec 和输入源一样:true。
false
TransModestring

转码模式。

  • 可选范围:onepass、twopass、CBR。
  • 默认值:onepass
onepass
IsCheckResostring

是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则视为输出分辨率等于输入分辨率。

  • true 表示检查。

  • false 表示不检查。

  • 默认值:false

false
IsCheckVideoBitrateFailstring

是否检查码率。当输出视频码率大于媒体源视频码率时,则不进行转码,直接返回转码失败。此值优先级大于 IsCheckVideoBitrate。

  • true 表示检查。

  • false 表示不检查。

  • 默认值:false

false
AdjDarMethodstring

分辨率改写方式。默认值:none。可取值:rescale、crop、pad、none。

none
IsCheckVideoBitratestring

是否检查视频码率。如果视频输出码率大于视频输入码率,则视为视频输出码率等于视频输入码率。

  • true 表示检查。

  • false 表示不检查。

  • 默认值:false

false
IsCheckResoFailstring

是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。

  • true 表示检查。

  • false 表示不检查。

  • 默认值:false

false
IsCheckAudioBitrateFailstring

是否检查音频码率。当输出音频码率大于媒体源音频码率时,则不进行转码,直接返回转码失败,此值优先级大于 IsCheckAudioBitrate。

  • true 表示检查。

  • false 表示不检查。

  • 默认值:false

false
Encryptionobject

数据加密,只支持 m3u8 格式的输出。

Typestring

加密类型。取值:hls-aes-128

hls-aes-128
Keystring

加密视频的密钥。

encryptionkey128
KeyTypestring

密钥加密方式,可取值:Base64、KMS。

说明 例如密钥为"encryptionkey128",则Base64("encryptionkey128"),或KMS(Base64("encryptionkey128")
Base64
Idstring

加密 ID。

31fa3c9ca8134f9cec2b4b0b0f78****
KeyUristring

密钥的访问 URL,使用 BASE64 进行编码。

https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/
SkipCntstring

前面不加密的片数(视频能快速播放起来)。

3
WaterMarkListobject []

水印列表。

Typestring

水印类型。如果请求参数中设置了此参数,则此值覆盖水印模板对应参数。更多信息,请参见参数详情。可取值:

  • Image:图片水印。

  • Text:文字水印。

Image
ReferPosstring

水印的位置。如果请求参数中设置了此值,测覆盖水印模板对应参数。可取值:

  • TopRight:右上。

  • TopLeft:左上。

  • BottomRight:右下。

  • BottomLeft:左下。

TopRight
Dxstring

水印图片相对输出视频的水平偏移量。如果请求参数中设置了此值,则覆盖水印模板对应参数。默认值为 0。值有两种形式:

  • 整数型:代表偏移像素值。

    • 范围:[8,4096]

    • 单位:px。

  • 小数型:代表水平偏移量与输出分辨率宽的比率。

    • 范围:(0,1)。

    • 支持四位小数,例如:0.9999,超出部分系统自动丢弃。

100
Widthstring

水印图片宽。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片宽。值有两种形式:

  • 整数型:代表水印图片宽的像素值。

    • 范围:[8,4096]

    • 单位:px。

  • 小数型:代表相对输出视频分辨率宽的比率。

    • 范围:(0,1)

    • 支持 4 位小数,例如:0.9999,超出部分系统自动丢弃。

50
Heightstring

水印图片搞高。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片高。值有两种形式:

  • 整数型:代表水印图片高的像素值。

    • 范围:[8,4096]

    • 单位:px。

  • 小数型:代表相对输出视频分辨率高的比率。

    • 范围:(0,1)

    • 支持 4 位小数,例如:0.9999,超出部分系统自动丢弃。

50
InputFileobject

水印输入文件。目前支持 png 图片、mov 文件作为输入文件。

Objectstring

输入文件的 OSS Object。

example-logo-****.png
Locationstring

输入文件的 OSS Location。

oss-cn-hangzhou
Bucketstring

输入文件的 OSS Bucket。

example-bucket
WaterMarkTemplateIdstring

水印模板 ID。

88c6ca184c0e47098a5b665e2a12****
Dystring

水印图片相对输出视频的垂直偏移量。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片相对输出视频的垂直偏移量。值有两种形式:

  • 整数型:代表水印图片相对输出视频的垂直偏移量像素。

    • 范围:[8,4096]

    • 单位:px。

  • 小数型:代表水印图片相对输出视频的垂直偏移量比率。

    • 范围:(0,1)

    • 支持 4 位小数,例如:0.9999,超出部分系统自动丢弃。

100
WaterMarkConfigUrlstring

水印配置文件 URL。

http://example.com/configure
DeWatermarkstring

模糊处理,JSON 对象。更多信息请参见参数详情中的模糊处理详情。

{"0":[{"l":10,"t":10,"w":10,"h":10},{"l":100,"t":0.1,"w":10,"h":10}],"128000":[],"250000":[{"l":0.2,"t":0.1,"w":0.01,"h":0.05}]}
M3U8NonStandardSupportobject

m3u8 非标准支持,JSON 对象。更多信息请参见参数详情中的 m3u8 非标准参数支持详情。

TSobject

JSON 对象,TS 文件相关非标准支持。更多信息请参见参数详情中的 TS 参数支持详情。

SizeSupportboolean

是否支持在 m3u8 文件中输出 TS 文件的大小。可取值:

  • true:支持。

  • false:不支持。

true
Md5Supportboolean

是否支持在 m3u8 文件中输出 TS 的 md5 值。可取值:

  • true:支持。

  • false:不支持。

true
Prioritystring

任务在其对应管道内的优先级。

  • 最高优先级:10。

  • 默认值:6

6
Audioobject

音频配置。

说明 如果请求参数中指定了音频配置则覆盖指定转码模板中的对应参数。
Profilestring

音频编码预置。当 Codec 为 aac 时可取值:aaclow、aache、aachev2、aacld、aaceld。

aaclow
Codecstring

音频编解码格式。

  • 支持 aac、mp3、vorbis、flac。

  • 默认值:aac

aac
Sampleratestring

采样率。

  • 支持 22050、32000、44100、48000、96000。

  • 单位:Hz。

  • 默认值:44100。

说明 若视频容器格式为 flv,音频编解码格式选择为 mp3 时,采样率不支持 32000、48000、96000;音频编解码格式为 mp3 时,采样率不支持 96000。
44100
Qscalestring

音频质量控制度。

15
Channelsstring

声道数。

  • 支持 1、2、3、4、5、6、7、8。
  • 默认值:2
2
Volumeobject

音量配置。

Methodstring

音量调整方式。可取值:

  • auto:自动调整。

  • dynamic:动态调整。

  • linear:线性调整。

auto
Levelstring

音量调整幅度,默认为**-20db**。

-20
Bitratestring

输出文件的音频码率。

  • 单位:Kbps。
  • 默认值:128
128
AudioStreamMapstring

音频流序号。

  • 格式:格式:0:a:{序号},示例:0:a:0。

  • 序号的含义是音频流列表的下标,序号从 0 开始。

  • 若未设置,选择默认的音频流。

0:a:0
MergeListobject []

拼接设置。最多支持 4 个 MergeURL。

Startstring

起始时间点。

  • 格式:hh:mm:ss[.SSS]或者sssss[.SSS]
  • 示例:01:59:59.999 或者 32000.23。
01:59:59.999
RoleArnstring

代理授权使用的角色信息。

acs:ram::<your uid>:role/<your role name>
MergeURLstring

拼接片段地址。

  • 示例:http://example-bucket-.oss-cn-hangzhou.aliyuncs.com/example-object.flv
  • Object 需要经过 URL Encode,采用 UTF-8 编码。更多信息,请参见 URL 编码说明
http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv
Durationstring

持续时间。

  • 格式:hh:mm:ss[.SSS]或者sssss[.SSS]
  • 示例:01:59:59.999 或者 32000.23。
01:59:59.999
SuperResoobject

分辨率随源。

IsHalfSamplestring

是否获取采样率相关参数。可取值:

  • true:是。

  • false:否。

true
UserDatastring

用户自定义数据。

testid-001
ExtendDatastring

用户自定义扩展字段。

testid-002
OutSubtitleListobject []

输出字幕列表。

Mapstring

视频轨。格式:0:{流}:{流序号} ,即0:v:{video_index}。流取值为 v: video 音频流,序号的含义是音频流列表的下标,序号从 0 开始。

0:v:0
OutSubtitleFileobject

输出文件详细信息。

RoleArnstring

代理授权使用的角色信息。

acs:ram::<your uid>:role/<your role name>
Objectstring

输出文件的 OSS Object。

example.flv
Locationstring

输出文件的 OSS Location。

oss-cn-hangzhou
Bucketstring

输出文件的 OSS Bucket。

exampleBucket
Successboolean

是否成功。可取值:

  • true:成功。

  • fasle:失败。

true
Messagestring

创建作业失败时错误消息。创建成功时此参数不返回。

The specified parameter “%s” cannot be null.
VideoStreamMapstring

视频流序号。序号从 0 开始,序号的含义是视频流列表的下标,若不设置,选择默认的视频流。

0
OutputFileobject

输出文件。

RoleArnstring

代理授权使用的角色信息。

acs:ram::<your uid>:role/<your role name>
Objectstring

输出文件的 OSS Object。

example-output.flv
Locationstring

输出文件的 OSS Location。

oss-cn-hangzhou
Bucketstring

输出文件的 OSS Bucket。

example-bucket
Rotatestring

视频旋转角度。

90
Containerobject

容器。

Formatstring

容器格式。

  • 默认值:mp4。

  • 视频转码可取值 flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。

  • 音频转码可取值 mp3、mp4、ogg、flac、m4a。

  • 图片可取值 gif、WEBP。容器格式为 gif 时,VideoCodec 设置只能设置为 GIF。

  • 容器格式为 webp 时,VideoCodec 设置只能设置为 WEBP。

  • 容器格式为 flv 时,VideoCodec 不能设置为 H265。

mp4
Clipobject

剪辑片段。

TimeSpanobject

剪辑时间段。

Seekstring

开始时间点。

  • 格式:hh:mm:ss[.SSS]

  • 示例:01:59:59.999。

或者

  • 格式:sssss[.SSS]

  • 示例:32000.23。

01:59:59.999
Durationstring

持续时长。

  • 格式:hh:mm:ss[.SSS]
  • 示例:01:00:59.999。

或者

  • 格式:sssss[.SSS]
  • 示例:32000.23。
01:00:59.999
MergeConfigUrlstring

拼接配置文件 URL 地址。MergeList 与 MergeConfigUrl 两个参数只支持二选一。

  • MergeConfigUrl 指定的配置文件允许 50 个拼接片段上限。

  • MergeConfigUrl 是拼接配置文件 URL 地址。只支持存放在 OSS 上的配置文件,且需要保证有授权给 MPS 可访问权限,文件内部内容参见拼接参数详情。

  • mergeConfigfile 文件内部内容示例:{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}

https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8
OpeningListobject []

开板列表,JSON 对象。

openUrlstring

开板视频的 OSS URL 地址。

http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4
Startstring

相对正片视频的开始时间。

  • 从 0 开始延迟多长时间后,显示开板视频。
  • 单位:秒。
  • 默认值:0
0
Widthstring

宽。

  • 范围:(0,4096)、1、full。
  • -1 代表片源的值。
  • full 表示填满画面。
  • 默认值:-1
-1
Heightstring

高。

  • 范围:(0,4096)、-1、full。
  • -1 代表片源的值。
  • full 表示填满画面。
  • 默认为:-1
-1
MuxConfigobject

转码封包配置。转码封包配置。如果请求参数中设置了此参数,则覆盖指定转码模板中的对应参数。

Webpobject

Webp 对应的封包配置。

Loopstring

循环次数。

0
Gifobject

Gif 对应的封包配置。

FinalDelaystring

终帧暂停时间。单位:厘秒。

0
DitherModestring

调色板颜色抖动方式。可取值:sierra、bayer。

bayer
Loopstring

循环次数。

0
IsCustomPalettestring

自定义调色板功能。可取值:

  • true:自定义。

  • false:非自定义。

false
Segmentobject

切片配置,JSON 对象。

Durationstring

分片时长。单位:秒。

20
TailSlateListobject []

尾板列表。

Startstring

尾板视频开始时间。

00000.00
BgColorstring

如果尾板视频的宽、高小于正片时,设置空白处填充的背景色。默认为 White,取值请参见 bgcolor

White
IsMergeAudioboolean

是否要拼接尾板视频的音频内容。可取值:

  • true:拼接。

  • false:不拼接。

true
Widthstring

宽,范围:(0,4096)、-1、full。

  • -1 代表片源的值。
  • full 表示填满画面。
  • 默认为**-1**。
-1
Heightstring

高。

  • 范围:(0,4096)、-1、full。

  • -1 代表片源的值。

  • full 表示填满画面。

  • 默认为**-1**。

-1
BlendDurationstring

正片视频和尾板视频过渡的时长。过渡的效果是淡入淡出:正片显示最后一帧,同时播放尾板视频,正片最后一帧逐步变暗,尾板视频逐步变亮。单位秒,默认 0。

0
TailUrlstring

尾板视频的 OSS URL 地址。

http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
TemplateIdstring

模板 ID。

S00000001-200010
SubtitleConfigobject

字幕配置。

ExtSubtitleListobject []

外部字幕列表。

CharEncstring

外部字幕字符编码。

  • 范围:UTF-8、GBK、BIG5、auto。

  • 默认:auto

说明 外部字幕字符编码设置为 auto 时,存在误检情况,建议您指定具体的字符编码。
auto
FontNamestring

外挂字幕转换成硬字幕对应的字体名称。默认值:SimSum。更多信息,请参见字体列表

"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"
Inputobject

外部输入字幕文件。

  • 目前支持 srt、ass 格式。更多信息请参见参数详情中的 Input 参数。

  • 示例:{“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”}

Objectstring

输入文件的 OSS Object。

example-output.flv
Locationstring

输入文件所在的 OSS Location。

oss-cn-hangzhou
Bucketstring

输入文件所在的 OSS Bucket。

example-bucket-****
SubtitleListobject []

字幕列表。

Mapstring

音轨。格式:0:{流}:{流序号} ,即0:a:{audio_index}。流取值为 a: audio 音频流,序号的含义是音频流列表的下标,序号从 0 开始。

0:a:0
Propertiesobject

媒体属性。

Widthstring

视频宽。

720
Heightstring

视频长。

1280
SourceLogosobject []

非引擎层的关键字。

Sourcestring

关键字。

example
Durationstring

时长。

17
Fpsstring

帧率。

30
Bitratestring

码率。

490
FileFormatstring

文件格式。

mp4
Streamsobject

流信息。

VideoStreamListobject []

视频流列表。

Indexstring

视频流序号,标识视频流在整个媒体流中的位置。

0
Timebasestring

时基。

1/15360
AvgFPSstring

平均帧率。

30.0
PixFmtstring

像素格式。

yuv420p
Sarstring

编码信号分辨率比。

1:1
Langstring

语言。更多信息,请参见 FFmeg 语言定义ISO-639

eng
CodecLongNamestring

编码格式长述名。

H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Heightstring

视频分辨率长。

1280
NumFramesstring

总帧数。

30
Bitratestring

码率。

421.117
CodecTagStringstring

编码格式标记文本。

avc1
HasBFramesstring

是否有 B 帧。

2
Profilestring

编码预置。

high
StartTimestring

开始时间。

0.000000
NetworkCostobject

网络带宽消耗。

PreloadTimestring

预加载时间。

8
AvgBitratestring

平均码率。

300
CostBandwidthstring

最大消耗带宽。

10
Darstring

编码显示分辨率比。

9:16
CodecNamestring

编码格式简述名。

h264
Widthstring

视频分辨率宽,数字。

720
Durationstring

时长。

17.233333
Fpsstring

帧率。

30.0
CodecTagstring

编码格式标记。

0x31637661
CodecTimeBasestring

编码时基。

1/60
Levelstring

编码等级。

31
colorTransferstring

色彩转换。

bt709
colorPrimariesstring

基色、原色。

bt709
bitsPerRawSamplestring

每个样本或像素使用的二进制位数。

8
AudioStreamListobject []

音频流列表。

Timebasestring

时基。

1/32000
Indexstring

音频流序号,标识音频流在整个媒体流中的位置。

1
SampleFmtstring

采样格式。

fltp
ChannelLayoutstring

声道输出样式。

mono
Langstring

语言。更多信息,请参见 FFmeg 语言定义ISO-639

und
Sampleratestring

采样率。

32000
CodecLongNamestring

编码格式长述名。

AAC (Advanced Audio Coding)
Channelsstring

声道数。

1
NumFramesstring

总帧数。

50
Bitratestring

码率。

64.136
CodecTagStringstring

编码格式标记文本。

mp4
StartTimestring

开始时间。

0.064000
CodecNamestring

编码格式简述名。

aac
Durationstring

时长。

17.223562
CodecTagstring

编码格式标记。

0x6134706d
CodecTimeBasestring

编码时基。

1/32000
SubtitleStreamListobject []

字幕流列表。

Indexstring

字幕流序号。 标识字幕流在整个媒体流中的位置。

1
Langstring

语言。更多信息,请参见 FFmeg 语言定义ISO-639

eng
Formatobject

格式信息。

StartTimestring

起始时间。

-0.064000
NumProgramsstring

节目流总数。

0
Sizestring

文件大小。

1057273
NumStreamsstring

媒体流总数。

2
FormatLongNamestring

容器、封装格式长述名。

QuickTime / MOV
Durationstring

总时长。

17.234000
Bitratestring

总码率。

490.784
FormatNamestring

容器、封装格式简述名。可取值:mov、mp4、m4a、3gp、3g2、mj2。

mov
FileSizestring

文件大小。

1057273
MultiSpeedInfoobject

倍速作业信息。使用倍速管道提交的任务才有(老版倍速无该信息)。

Enablestring

是否打开倍速开关。

true
Codestring

错误码(未实际启用倍速时的说明)。

Boost.NotNeedSpeed
Messagestring

错误信息(未实际启用倍速时的说明)。

success
SettingSpeedinteger

设定速率。

30
DowngradePolicystring

不支持倍速时的降级策略。

NormalSpeed
RealSpeeddouble

实际倍速值。

6.576886940181647
Durationdouble

输出视频时长。

21.0
TimeCostdouble

任务耗时。

3.193
PipelineIdstring

管道 ID。

88c6ca184c0e47b665e2a1267971****
Inputobject

作业输入。

Objectstring

输入文件的 OSS Object。

video_01.mp4
Locationstring

输入文件的 OSS Location。

oss-cn-shanghai
Bucketstring

输入文件的 OSS Bucket。

exampleBucket
MNSMessageResultobject

MNS 通知用户作业完成的消息结果。

MessageIdstring

成功时消息 ID。

123
ErrorMessagestring

失败时错误信息。执行成功则不返回此参数。

The resource operated “%s” cannot be found.
ErrorCodestring

失败时错误码。执行成功则不返回此参数。

InvalidParameter.ResourceNotFound
SubmitTimestring

任务出队提交执行的时间。

2021-03-04T06:44:43Z

回调消息格式定义

当转码任务执行状态改变时,mps 会发送消息到用户指定的 queue 中(如何指定回调 queue 详见 mps 的更新管道接口)。消息体是一个 JSON 字符串,包含字段如下:

{
  "Type": "Transcode",
  "State": "Success",
  "JobId": "39f8e0bc005e4f309379701645f4****",
  "UserData": "{\"key\":\"value\"}",
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642****"
}
名称类型描述
TypeString固定字符串“Transcode”,表示转码任务。
JobIdString任务唯一 ID。
StateString任务当前状态,与 QueryJobList 中的 State 一致。
UserDataString用户在 SubmitJobs 中传入的 UserData。

示例

正常返回示例

JSON格式

{
  "NonExistJobIds": {
    "String": [
      "d1ce4d3efcb549419193f50f1fcd****"
    ]
  },
  "RequestId": "197ADF44-104C-514C-9F92-D8924CB34E2A",
  "JobList": {
    "Job": [
      {
        "CreationTime": "2014-01-10T12:00:00Z",
        "Percent": 100,
        "FinishTime": "2014-01-10T12:20:25Z",
        "State": "TranscodeSuccess",
        "JobId": "31fa3c9ca8134fb4b0b0f7878301****",
        "Code": "InvalidParameter.NullValue",
        "Message": "The specified parameter \"%s\" cannot be null.",
        "Output": {
          "Video": {
            "Bufsize": "6000",
            "Degrain": "5",
            "BitrateBnd": {
              "Max": "1000",
              "Min": "300"
            },
            "PixFmt": "yuv420p",
            "Pad": "1280:800:0:140",
            "Codec": "H.264",
            "Height": "720",
            "Qscale": "15",
            "Crop": "1280:800:0:140",
            "Bitrate": "500",
            "Maxrate": "3000",
            "MaxFps": "60",
            "Profile": "high",
            "Crf": "26",
            "Gop": "250",
            "Width": "1280",
            "Fps": "25",
            "Preset": "medium",
            "ScanMode": "interlaced",
            "ResoPriority": "1"
          },
          "TransConfig": {
            "IsCheckAudioBitrate": "false",
            "TransMode": "onepass",
            "IsCheckReso": "false",
            "IsCheckVideoBitrateFail": "false",
            "AdjDarMethod": "none",
            "IsCheckVideoBitrate": "false",
            "IsCheckResoFail": "false",
            "IsCheckAudioBitrateFail": "false"
          },
          "Encryption": {
            "Type": "hls-aes-128",
            "Key": "encryptionkey128",
            "KeyType": "Base64",
            "Id": "31fa3c9ca8134f9cec2b4b0b0f78****",
            "KeyUri": "https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/",
            "SkipCnt": "3"
          },
          "WaterMarkList": {
            "WaterMark": [
              {
                "Type": "Image",
                "ReferPos": "TopRight",
                "Dx": "100",
                "Width": "50",
                "Height": "50",
                "InputFile": {
                  "Object": "example-logo-****.png",
                  "Location": "oss-cn-hangzhou",
                  "Bucket": "example-bucket"
                },
                "WaterMarkTemplateId": "88c6ca184c0e47098a5b665e2a12****",
                "Dy": "100"
              }
            ]
          },
          "WaterMarkConfigUrl": "http://example.com/configure",
          "DeWatermark": "{\"0\":[{\"l\":10,\"t\":10,\"w\":10,\"h\":10},{\"l\":100,\"t\":0.1,\"w\":10,\"h\":10}],\"128000\":[],\"250000\":[{\"l\":0.2,\"t\":0.1,\"w\":0.01,\"h\":0.05}]}",
          "M3U8NonStandardSupport": {
            "TS": {
              "SizeSupport": true,
              "Md5Support": true
            }
          },
          "Priority": "6",
          "Audio": {
            "Profile": "aaclow",
            "Codec": "aac",
            "Samplerate": "44100",
            "Qscale": "15",
            "Channels": "2",
            "Volume": {
              "Method": "auto",
              "Level": "-20"
            },
            "Bitrate": "128"
          },
          "AudioStreamMap": "0:a:0",
          "MergeList": {
            "Merge": [
              {
                "Start": "01:59:59.999",
                "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                "MergeURL": "http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv",
                "Duration": "01:59:59.999"
              }
            ]
          },
          "SuperReso": {
            "IsHalfSample": "true"
          },
          "UserData": "testid-001",
          "ExtendData": "testid-002",
          "OutSubtitleList": {
            "OutSubtitle": [
              {
                "Map": "0:v:0",
                "OutSubtitleFile": {
                  "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                  "Object": "example.flv",
                  "Location": "oss-cn-hangzhou",
                  "Bucket": "exampleBucket"
                },
                "Success": true,
                "Message": "The specified parameter “%s” cannot be null."
              }
            ]
          },
          "VideoStreamMap": "0",
          "OutputFile": {
            "RoleArn": "acs:ram::<your uid>:role/<your role name>",
            "Object": "example-output.flv",
            "Location": "oss-cn-hangzhou",
            "Bucket": "example-bucket"
          },
          "Rotate": "90",
          "Container": {
            "Format": "mp4"
          },
          "Clip": {
            "TimeSpan": {
              "Seek": "01:59:59.999",
              "Duration": "01:00:59.999"
            }
          },
          "MergeConfigUrl": "https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8",
          "OpeningList": {
            "Opening": [
              {
                "openUrl": "http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4",
                "Start": "0",
                "Width": "-1",
                "Height": "-1"
              }
            ]
          },
          "MuxConfig": {
            "Webp": {
              "Loop": "0"
            },
            "Gif": {
              "FinalDelay": "0",
              "DitherMode": "bayer",
              "Loop": "0",
              "IsCustomPalette": "false"
            },
            "Segment": {
              "Duration": "20"
            }
          },
          "TailSlateList": {
            "TailSlate": [
              {
                "Start": "00000.00",
                "BgColor": "White",
                "IsMergeAudio": true,
                "Width": "-1",
                "Height": "-1",
                "BlendDuration": "0",
                "TailUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv"
              }
            ]
          },
          "TemplateId": "S00000001-200010",
          "SubtitleConfig": {
            "ExtSubtitleList": {
              "ExtSubtitle": [
                {
                  "CharEnc": "auto",
                  "FontName": "\"WenQuanYi Zen Hei\", \"Yuanti SC Regular\", \"SimSun\"",
                  "Input": {
                    "Object": "example-output.flv",
                    "Location": "oss-cn-hangzhou",
                    "Bucket": "example-bucket-****"
                  }
                }
              ]
            },
            "SubtitleList": {
              "Subtitle": [
                {
                  "Map": "0:a:0"
                }
              ]
            }
          },
          "Properties": {
            "Width": "720",
            "Height": "1280",
            "SourceLogos": {
              "SourceLogo": [
                {
                  "Source": "example"
                }
              ]
            },
            "Duration": "17",
            "Fps": "30",
            "Bitrate": "490",
            "FileFormat": "mp4",
            "Streams": {
              "VideoStreamList": {
                "VideoStream": [
                  {
                    "Index": "0",
                    "Timebase": "1/15360",
                    "AvgFPS": "30.0",
                    "PixFmt": "yuv420p",
                    "Sar": "1:1",
                    "Lang": "eng",
                    "CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
                    "Height": "1280",
                    "NumFrames": "30",
                    "Bitrate": "421.117",
                    "CodecTagString": "avc1",
                    "HasBFrames": "2",
                    "Profile": "high",
                    "StartTime": "0.000000",
                    "NetworkCost": {
                      "PreloadTime": "8",
                      "AvgBitrate": "300",
                      "CostBandwidth": "10"
                    },
                    "Dar": "9:16",
                    "CodecName": "h264",
                    "Width": "720",
                    "Duration": "17.233333",
                    "Fps": "30.0",
                    "CodecTag": "0x31637661",
                    "CodecTimeBase": "1/60",
                    "Level": "31",
                    "colorTransfer": "bt709",
                    "colorPrimaries": "bt709",
                    "bitsPerRawSample": "8"
                  }
                ]
              },
              "AudioStreamList": {
                "AudioStream": [
                  {
                    "Timebase": "1/32000",
                    "Index": "1",
                    "SampleFmt": "fltp",
                    "ChannelLayout": "mono",
                    "Lang": "und",
                    "Samplerate": "32000",
                    "CodecLongName": "AAC (Advanced Audio Coding)",
                    "Channels": "1",
                    "NumFrames": "50",
                    "Bitrate": "64.136",
                    "CodecTagString": "mp4",
                    "StartTime": "0.064000",
                    "CodecName": "aac",
                    "Duration": "17.223562",
                    "CodecTag": "0x6134706d",
                    "CodecTimeBase": "1/32000"
                  }
                ]
              },
              "SubtitleStreamList": {
                "SubtitleStream": [
                  {
                    "Index": "1",
                    "Lang": "eng"
                  }
                ]
              }
            },
            "Format": {
              "StartTime": "-0.064000",
              "NumPrograms": "0",
              "Size": "1057273",
              "NumStreams": "2",
              "FormatLongName": "QuickTime / MOV",
              "Duration": "17.234000",
              "Bitrate": "490.784",
              "FormatName": "mov"
            },
            "FileSize": "1057273"
          },
          "MultiSpeedInfo": {
            "Enable": "true",
            "Code": "Boost.NotNeedSpeed",
            "Message": "success",
            "SettingSpeed": 30,
            "DowngradePolicy": "NormalSpeed",
            "RealSpeed": 6.576886940181647,
            "Duration": 21,
            "TimeCost": 3.193
          }
        },
        "PipelineId": "88c6ca184c0e47b665e2a1267971****",
        "Input": {
          "Object": "video_01.mp4",
          "Location": "oss-cn-shanghai",
          "Bucket": "exampleBucket"
        },
        "MNSMessageResult": {
          "MessageId": "123",
          "ErrorMessage": "The resource operated “%s” cannot be found.",
          "ErrorCode": "InvalidParameter.ResourceNotFound"
        },
        "SubmitTime": "2021-03-04T06:44:43Z"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-03OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更
2023-06-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-13OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:IncludePipelineInfo
  • 本页导读 (1)
文档反馈