调用GetTranscodeJob查询转码任务_智能媒体服务(IMS)-阿里云帮助中心

查询单个转码任务详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ice:GetTranscodeJob		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ParentJobId	string	是	任务 ID	ab4802364a2e49208c99efab82dfa8e8

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	9EDC30DC-0050-5459-B788-F761B2BE359B
TranscodeParentJob	object	TranscodeParentJobWithSubJobDTO
TranscodeJobList	array<object>	子任务列表。
TranscodeJobList	object	子任务。
CreateTime	string	任务创建时间。	2022-01-12T08:49:41Z
Name	string	任务名。	transcode-job
ParentJobId	string	主任务 ID。	8b2198504dd340b7b3c9842a74fc9baa
JobId	string	子任务 ID。	7d6a7e0d4db2457a8d45ff5d43e1bf0a
JobIndex	integer	子任务在整个任务中的索引号。	0
InputGroup	array<object>	任务输入组。单个输入为转码任务。多个输入为音视频合流任务。
InputGroup	object	作业输入。
Type	string	媒体对象类型。取值： OSS：OSS 文件。 Media：媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
InputUrl	string	媒资流地址，只有当对媒资流进行转码时填写此参数。	oss://bucket/path/to/video.mp4
ProcessConfig	object	转码处理配置。
Transcode	object	转码配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Video	object	video 设置。
Codec	string	编码格式。	H.264
Profile	string	编码级别。支持 baseline、main、high。 baseline：针对移动设备。 main：针对标准分辨率设备。 high：针对高分辨率设备。默认值：high。	Main
Bitrate	string	视频平均码率。取值范围：[10，50000]。单位：Kbps。	3000
Crf	string	码率-质量控制因子。取值范围：[0，51]。默认值：编码格式为 H264，默认值为 23。编码格式为 H265，默认值为 26。如果设置了 Crf，则 Bitrate 的设置失效。	23
Width	string	宽。取值范围：[128,4096]。单位：px。默认值：视频原始宽度。	1920
Height	string	高。取值范围：[128,4096]。单位：px。默认值：视频原始高度。	1080
Fps	string	帧率。取值范围：(0,60]。当输入文件帧率超过 60 时取 60。默认值：取输入文件帧率。	25
Gop	string	关键帧间最大帧数。取值范围：[1，1080000]。默认值：250。	250
Preset	string	视频算法器预置。只有 H264 支持该参数。支持 veryfast、fast、medium、slow、slower。默认值：medium。	medium
ScanMode	string	扫描模式。支持 interlaced、progressive。	progressive
PixFmt	string	视频颜色格式。范围：yuv420p，yuvj420p 等标准颜色格式。	yuv420p
Remove	string	是否去掉视频。	false
Crop	string	视频画面裁切，支持 2 种方式：自动检测黑边并裁切，设置为“border”；自定义裁切，参数格式：width:height:left:top。	1280:800:0:140
Pad	string	视频贴黑边，参数格式：width:height:left:top。	1280:800:0:140
LongShortMode	string	是否开启横竖屏自适应（即：长短边模式）。	false
Bufsize	string	缓冲区大小：值范围：[1000，128000]；默认值：6000；单位：Kb。	6000
Maxrate	string	视频码率峰值：值范围[10，50000]；单位 Kbps。	9000
AbrMax	string	abr 最大码率（只有窄高 1 有效）：值范围[10，50000]；单位 Kbps。	6000
Audio	object	audio 设置。
Codec	string	音频编解码格式，AAC、MP3、VORBIS、FLAC。默认值：AAC	AAC
Profile	string	音频编码预置。当 Codec 为 AAC 时，范围 aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。	aac_low
Samplerate	string	采样率。默认值：44100 支持 22050、32000、44100、48000、96000，单位：Hz	44100
Bitrate	string	输出文件的音频码率。值范围：[8，1000] 单位：Kbps 默认值：128	128
Channels	string	声道数。默认值：2	2
Remove	string	是否删除音频流。	false
Volume	object	音量控制。
Method	string	音量调整方式。	auto
IntegratedLoudnessTarget	string	目标音量。	-6
TruePeak	string	最大峰值。	-1
LoudnessRangeTarget	string	音量范围。	8
Container	object	封装格式设置。
Format	string	容器格式。	mp4
MuxConfig	object	封装设置。
Segment	object	切片设置。
Duration	string	切片时长。	10
ForceSegTime	string	强制切片时间点。	2,3
TransConfig	object	条件转码参数。
TransMode	string	视频转码模式。取值如下： onepass：一般用于 ABR。编码速度较 twopass 更快。 twopass：一般用于 VBR。编码速度较 onepass 更慢。 CBR：固定码率模式。默认值：onepass。	onepass
IsCheckReso	string	是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一，IsCheckResoFail 优先级更高。 true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。 false：不检查。默认值：false。	true
IsCheckResoFail	string	是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一，本参数优先级更高。 true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。 false：不检查。默认值：false。	true
IsCheckVideoBitrate	string	是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一，IsCheckVideoBitrateFail 优先级更高。 true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。 false：不检查。默认值：false。	true
IsCheckVideoBitrateFail	string	是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一，本参数优先级更高。 true：检查。当输入视频码率小于输出设置时，返回转码失败。 false：不检查。默认值：false。	true
IsCheckAudioBitrate	string	是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一，IsCheckAudioBitrateFail 优先级更高。 true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。 false：不检查。默认值：参数为空，并且 codec 和输入源不一样：false。参数为空，并且 codec 和输入源一样：true。	true
IsCheckAudioBitrateFail	string	是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一，本参数优先级更高。 true：检查。当输入音频码率小于输出设置时，返回转码失败。 false：不检查。默认值：false。	true
AdjDarMethod	string	分辨率改写方式。当 Width 或 Height 都填写时才生效，可以和 LongShortMode 搭配使用。可选值：rescale、crop、pad、none。默认值：none。示例：请参见如何设置分辨率。	none
ImageWatermarks	array<object>	图片水印配置。
ImageWatermark	object	图片水印配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Width	string	宽。	32
Height	string	高。	32
Dx	string	水印位置，x。	10
Dy	string	水印位置，y。	10
ReferPos	string	参考位置：TopLeft, TopRight, BottomLeft, BottomRight 默认值：TopLeft。	TopLeft
Timeline	object	显示时间设置。
Start	string	开始时间。	00:00:05
Duration	string	显示时长，秒数或者 "ToEND"。	ToEND
File	object	水印图片文件。
Type	string	媒体对象类型。取值： OSS: OSS 文件。 Media: 媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
TextWatermarks	array<object>	文字水印配置。
TextWatermark	object	文字水印配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Content	string	水印文本，不需要 base64 encode，字符串需要 utf-8 编码。	测试水印
FontName	string	字体。	SimSun
FontColor	string	颜色。	#006400
FontAlpha	string	透明度。	1.0
Top	string	水印位置，距离上边距离。	10
Left	string	水印位置，距离左边距离。	10
FontSize	integer	字体大小。	16
BorderWidth	integer	边框宽度。	0
BorderColor	string	边框颜色。	#006400
Adaptive	string	根据输出视频大小调整字体 size。 true / false, default: false。	false
Subtitles	array<object>	字幕压制配置。
Subtitle	object	字幕压制配置。
TemplateId	string	模板 ID	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Format	string	字幕文件格式。	vtt
CharEnc	string	文件 encoding 格式。	UTF-8
File	object	字幕文件。
Type	string	媒体对象类型。取值： OSS: OSS 文件。 Media: 媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
Encryption	object	加密配置。
EncryptType	string	加密类型。	PrivateEncryption
CipherText	string	标准加密的密钥密文。	MTYi00NDU0LTg5O****
DecryptKeyUri	string	标准加密的解密服务地址。	https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
KeyServiceType	string	密钥服务类型。目前仅支持 KMS 和 Base64	KMS
CombineConfigs	array<object>	多输入合流配置
CombineConfig	object
AudioIndex	string	音频流 Index	0 或 exclude
VideoIndex	string	视频流 Index	0 或 exclude
Start	double	输入流的开始时间。默认为 0	0.0
Duration	double	输入流的持续时间。默认为视频时长。	20.0
IsInheritTags	boolean	是否继承输入流的 tag。当输入不是媒资是该参数不生效。默认值：false	true
Output	object	输出媒体配置。
Type	string	媒体对象类型。取值： OSS: OSS 文件。 Media: 媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
OutputUrl	string	转码输出流地址，仅当输出到媒资流时需要填此参数	oss://bucket/path/to/{MediaId}/{JobId}.mp4
UserData	string	用户数据。	user-data
ScheduleConfig	object	任务调度信息。
PipelineId	string	管道 ID。	e37ebee5d98b4781897f6086e89f9c56
Priority	integer	任务优先级。数字越大优先级越高，取值范围：1~10。	5
Status	string	转码任务状态 Init：已提交。 Processing：转码中。 Success：转码成功。 Fail：转码失败。 Deleted：已删除。	Init
OutFileMeta	object	任务生成视频 Media 信息。
FileBasicInfo	object	基础文件信息。
MediaId	string	媒资 ID。	486c2890096871edba6f81848c016303
FileName	string	文件名。	file.m3u8
FileStatus	string	文件状态。	Normal
FileType	string	文件类型。取值：source_file, transcode_file	source_file
FileSize	string	文件大小。单位：Byte。	31737
FileUrl	string	文件 URL。	http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8
Region	string	文件所在区域。	cn-shanghai
FormatName	string	视频格式名称。	hls,applehttp
Duration	string	视频时长（单位：秒）。	403.039999
Bitrate	string	视频码率。	888.563
Width	string	宽。	848
Height	string	高。	478
AudioStreamInfoList	array<object>	音频流信息。
AudioStreamInfoList	object	音频流信息。
Index	string	流序号。	1
CodecName	string	编码格式。	aac
CodecLongName	string	编码格式名。	AAC (Advanced Audio Coding)
CodecTimeBase	string	编码器时间基。	1/44100
CodecTagString	string	编码器标签名。	[15][0][0][0]
CodecTag	string	编码器标签。	0x000f
SampleFmt	string	采样格式。	fltp
SampleRate	string	采样率（单位：Hz）。	44100
Channels	string	声道数。	2
ChannelLayout	string	声道布局。	stereo
Timebase	string	时间基。	1/90000
StartTime	string	开始时间。	1.473556
Duration	string	时长（单位：秒）。	403.039989
Bitrate	string	码率。	0.f
Lang	string	语言。	cn
VideoStreamInfoList	array<object>	视频流信息。
VideoStreamInfoList	object	视频流信息。
Index	string	流序号。	0
Codec_name	string	编码格式。	h264
Codec_long_name	string	编码格式名。	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Profile	string	编码器预设。	High
Codec_time_base	string	编码时基。	1/50
Codec_tag_string	string	编码格式标记文本。	[27][0][0][0]
Codec_tag	string	编码格式标记。	0x001b
Width	string	宽。	848
Height	string	高。	478
Has_b_frames	string	是否有 B 帧。取值： 0：没有 B 帧, 1：有一个 B 帧, 2：有多个连续 B 帧。	2
Sar	string	采集点数宽高比。	478:477
Dar	string	图像显示宽高比。	16:9
PixFmt	string	颜色存储格式。	yuv420p
Level	string	编码等级。	31
Fps	string	帧率。	25.0
Avg_fps	string	平均帧率。	25.0
Time_base	string	时基。	1/90000
Start_time	string	起始时间。	1.473556
Duration	string	时长（单位：秒）。	403.039989
Bit_rate	string	码率。	888.563
NumFrames	string	总帧数。	10040
Lang	string	语言。	cn
Rotate	string	视频画面旋转角度。取值 0, 90, 180, 270。默认值 0	0
SubmitResultJson	object	任务提交结果。	{}
SubmitTime	string	任务提交时间。	2022-01-12T08:49:41Z
FinishTime	string	任务结束时间。	2022-01-12T08:49:41Z
RequestId	string	提交任务时请求 ID。	31E30781-9495-5E2D-A84D-759B0A01E262
CreateTime	string	任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。	2022-01-12T08:49:41Z
Name	string	任务名。	transcode-job
RequestId	string	提交任务时请求 ID。	31E30781-9495-5E2D-A84D-759B0A01E262
ParentJobId	string	主任务 ID。	8b2198504dd340b7b3c9842a74fc9baa
JobCount	integer	子任务数量。	1
Status	string	任务状态。 Success: 所有子任务完成后，有一个子任务则为成功,。 Fail: 所有子任务失败。	Success
TriggerSource	string	任务来源。 API: API WorkFlow: 工作流 Console: 控制台	API
Percent	integer	任务完成百分比。	0
SubmitTime	string	任务提交时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。	2022-01-12T08:49:41Z
FinishTime	string	任务结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。	2022-01-12T08:49:41Z
InputGroup	array<object>	任务输入组。单个输入为转码任务。多个输入为音视频合流任务。
InputGroup	object	作业输入。
Type	string	媒体对象类型。取值： OSS: OSS 文件。 Media: 媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
OutputGroup	array<object>	任务输出组。
OutputGroup	object	任务输出。
Output	object	输出媒体配置。
Type	string	媒体对象类型。取值： OSS: OSS 文件。 Media: 媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
OutputUrl	string	输出流地址。	oss://bucket/path/to/video.mp4
ProcessConfig	object	任务处理配置。
Transcode	object	转码配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Video	object	video 设置。
Codec	string	编码格式。	H.264
Profile	string	编码级别。支持 baseline、main、high。 baseline：针对移动设备。 main：针对标准分辨率设备。 high：针对高分辨率设备。默认值：high。	Main
Bitrate	string	视频平均码率。取值范围：[10，50000]。单位：Kbps。	3000
Crf	string	码率-质量控制因子。取值范围：[0，51]。默认值：编码格式为 H264，默认值为 23。编码格式为 H265，默认值为 26。如果设置了 Crf，则 Bitrate 的设置失效。	23
Width	string	宽。取值范围：[128,4096]。单位：px。默认值：视频原始宽度。	1920
Height	string	高。取值范围：[128,4096]。单位：px。默认值：视频原始高度。	1080
Fps	string	帧率。取值范围：(0,60]。当输入文件帧率超过 60 时取 60。默认值：取输入文件帧率。	25
Gop	string	关键帧间最大帧数。取值范围：[1，1080000]。默认值：250。	250
Preset	string	视频算法器预置。只有 H264 支持该参数。支持 veryfast、fast、medium、slow、slower。默认值：medium。	medium
ScanMode	string	扫描模式。支持 interlaced、progressive。	progressive
PixFmt	string	视频颜色格式。范围：yuv420p，yuvj420p 等标准颜色格式。	yuv420p
Remove	string	是否去掉视频。	false
Crop	string	视频画面裁切支持 2 种方式。自动检测黑边并裁切，设置为“border” 自定义裁切，参数格式：width:height:left:top。示例：1280:800:0:140	1280:800:0:140
Pad	string	视频贴黑边参数格式：width:height:left:top。示例：1280:800:0:140	1280:800:0:140
LongShortMode	string	是否开启横竖屏自适应（即：长短边模式）。	false
Bufsize	string	缓冲区大小值取值范围：[1000，128000] 默认值：6000 单位：Kb	6000
Maxrate	string	视频码率峰值取值范围：[10，50000] 单位：Kbps。	9000
AbrMax	string	abr 最大码率（只有窄高 1 有效）值取值范围：[10，50000]，单位：Kbps。	6000
Audio	object	audio 设置。
Codec	string	音频编解码格式，AAC、MP3、VORBIS、FLAC。默认值：AAC	AAC
Profile	string	音频编码预置。当 Codec 为 AAC 时，范围 aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。	aac_low
Samplerate	string	采样率。默认值：44100 支持 22050、32000、44100、48000、96000，单位：Hz	44100
Bitrate	string	输出文件的音频码率。值范围：[8，1000] 单位：Kbps 默认值：128	128
Channels	string	声道数。默认值：2	2
Remove	string	是否删除音频流。	false
Volume	object	音量控制。
Method	string	音量调整方式。	auto
IntegratedLoudnessTarget	string	目标音量。	-6
TruePeak	string	最大峰值。	-1
LoudnessRangeTarget	string	音量范围。	8
Container	object	封装格式设置。
Format	string	容器格式。	mp4
MuxConfig	object	封装设置。
Segment	object	切片设置。
Duration	string	切片时长。	10
ForceSegTime	string	强制切片时间点。	2,3
TransConfig	object	条件转码参数。
TransMode	string	视频转码模式。取值如下： onepass：一般用于 ABR。编码速度较 twopass 更快。 twopass：一般用于 VBR。编码速度较 onepass 更慢。 CBR：固定码率模式。默认值：onepass。	onepass
IsCheckReso	string	是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一，IsCheckResoFail 优先级更高。 true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。 false：不检查。默认值：false。	true
IsCheckResoFail	string	是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一，本参数优先级更高。 true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。 false：不检查。默认值：false。	true
IsCheckVideoBitrate	string	是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一，IsCheckVideoBitrateFail 优先级更高。 true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。 false：不检查。默认值：false。	true
IsCheckVideoBitrateFail	string	是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一，本参数优先级更高。 true：检查。当输入视频码率小于输出设置时，返回转码失败。 false：不检查。默认值：false。	true
IsCheckAudioBitrate	string	是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一，IsCheckAudioBitrateFail 优先级更高。 true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。 false：不检查。默认值：参数为空，并且 codec 和输入源不一样：false。参数为空，并且 codec 和输入源一样：true。	true
IsCheckAudioBitrateFail	string	是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一，本参数优先级更高。 true：检查。当输入音频码率小于输出设置时，返回转码失败。 false：不检查。默认值：false。	true
AdjDarMethod	string	分辨率改写方式。当 Width 或 Height 都填写时才生效，可以和 LongShortMode 搭配使用。可选值：rescale、crop、pad、none。默认值：none。	none
ImageWatermarks	array<object>	图片水印配置。
ImageWatermark	object	图片水印配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Width	string	宽。	32
Height	string	高。	32
Dx	string	水印位置，x。	10
Dy	string	水印位置，y。	10
ReferPos	string	参考位置：TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft。	TopLeft
Timeline	object	显示时间设置。
Start	string	开始时间。	00:00:05
Duration	string	显示时长，秒数或者 "ToEND"。	ToEND
File	object	水印图片文件。
Type	string	媒体对象类型。取值： OSS: OSS 文件。 Media: 媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
TextWatermarks	array<object>	文字水印配置。
TextWatermark	object	文字水印配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Content	string	水印文本，不需要 base64 encode，字符串需要 utf-8 编码。	测试水印
FontName	string	字体。	SimSun
FontColor	string	颜色。	#006400
FontAlpha	string	透明度。	1.0
Top	string	水印位置，距离上边距离。	10
Left	string	水印位置，距离左边距离。	10
FontSize	integer	字体大小。	16
BorderWidth	integer	边框宽度。	0
BorderColor	string	边框颜色。	#006400
Adaptive	string	根据输出视频大小调整字体 size。 true / false, default: false。	false
Subtitles	array<object>	字幕压制配置。
Subtitle	object	字幕压制配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParams	object	覆盖参数, 若填写会覆盖模板对应参数。
Format	string	字幕文件格式。	vtt
CharEnc	string	文件 encoding 格式。	UTF-8
File	object	字幕文件。
Type	string	媒体对象类型。取值： OSS: OSS 文件。 Media: 媒资 ID。	OSS
Media	string	媒体值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议； type 为 Media 时，为媒资 ID。	oss://bucket/path/to/video.mp4
Encryption	object	加密配置。
EncryptType	string	加密类型。	PrivateEncryption
CipherText	string	标准加密的密钥密文。	MTYi00NDU0LTg5O****
DecryptKeyUri	string	标准加密的解密服务地址。	https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
KeyServiceType	string	密钥服务类型。目前仅支持 KMS 和 Base64	KMS
CombineConfigs	array<object>	多输入合流配置
CombineConfig	object
AudioIndex	string	音频流 Index	0 或 exclude
VideoIndex	string	视频流 Index	0 或 exclude
Start	double	输入流的开始时间。默认为 0	0.0
Duration	double	输入流的持续时间。默认为视频时长。	20.0
UserData	string	用户数据。	user-data
ScheduleConfig	object	任务调度配置。
PipelineId	string	管道 ID。	e37ebee5d98b4781897f6086e89f9c56
Priority	integer	任务优先级。数字越大优先级越高，取值范围：1~10。	5

示例

正常返回示例

JSON格式

{
  "RequestId": "9EDC30DC-0050-5459-B788-F761B2BE359B",
  "TranscodeParentJob": {
    "TranscodeJobList": [
      {
        "CreateTime": "2022-01-12T08:49:41Z",
        "Name": "transcode-job",
        "ParentJobId": "8b2198504dd340b7b3c9842a74fc9baa",
        "JobId": "7d6a7e0d4db2457a8d45ff5d43e1bf0a",
        "JobIndex": 0,
        "InputGroup": [
          {
            "Type": "OSS",
            "Media": "oss://bucket/path/to/video.mp4",
            "InputUrl": "oss://bucket/path/to/video.mp4"
          }
        ],
        "ProcessConfig": {
          "Transcode": {
            "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
            "OverwriteParams": {
              "Video": {
                "Codec": "H.264",
                "Profile": "Main",
                "Bitrate": "3000",
                "Crf": "23",
                "Width": "1920",
                "Height": "1080",
                "Fps": "25",
                "Gop": "250",
                "Preset": "medium",
                "ScanMode": "progressive",
                "PixFmt": "yuv420p",
                "Remove": "false",
                "Crop": "1280:800:0:140",
                "Pad": "1280:800:0:140",
                "LongShortMode": "false",
                "Bufsize": "6000",
                "Maxrate": "9000",
                "AbrMax": "6000"
              },
              "Audio": {
                "Codec": "AAC",
                "Profile": "aac_low",
                "Samplerate": "44100",
                "Bitrate": "128",
                "Channels": "2",
                "Remove": "false",
                "Volume": {
                  "Method": "auto",
                  "IntegratedLoudnessTarget": "-6",
                  "TruePeak": "-1",
                  "LoudnessRangeTarget": "8"
                }
              },
              "Container": {
                "Format": "mp4"
              },
              "MuxConfig": {
                "Segment": {
                  "Duration": "10",
                  "ForceSegTime": "2,3"
                }
              },
              "TransConfig": {
                "TransMode": "onepass",
                "IsCheckReso": "true",
                "IsCheckResoFail": "true",
                "IsCheckVideoBitrate": "true",
                "IsCheckVideoBitrateFail": "true",
                "IsCheckAudioBitrate": "true",
                "IsCheckAudioBitrateFail": "true",
                "AdjDarMethod": "none"
              },
              "Tags": {
                "key": ""
              }
            }
          },
          "ImageWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Width": "32",
                "Height": "32",
                "Dx": "10",
                "Dy": "10",
                "ReferPos": "TopLeft",
                "Timeline": {
                  "Start": "00:00:05",
                  "Duration": "ToEND"
                },
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "TextWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Content": "测试水印",
                "FontName": "SimSun",
                "FontColor": "#006400",
                "FontAlpha": "1.0",
                "Top": "10",
                "Left": "10",
                "FontSize": 16,
                "BorderWidth": 0,
                "BorderColor": "#006400",
                "Adaptive": "false"
              }
            }
          ],
          "Subtitles": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Format": "vtt",
                "CharEnc": "UTF-8",
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "Encryption": {
            "EncryptType": "PrivateEncryption",
            "CipherText": "MTYi00NDU0LTg5O****",
            "DecryptKeyUri": "https://sample.com/path?CipherText=MTYi00NDU0LTg5O****",
            "KeyServiceType": "KMS"
          },
          "CombineConfigs": [
            {
              "AudioIndex": "0 或 exclude",
              "VideoIndex": "0 或 exclude",
              "Start": 0,
              "Duration": 20
            }
          ],
          "IsInheritTags": true
        },
        "Output": {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4",
          "OutputUrl": "oss://bucket/path/to/{MediaId}/{JobId}.mp4\n"
        },
        "UserData": "user-data",
        "ScheduleConfig": {
          "PipelineId": "e37ebee5d98b4781897f6086e89f9c56",
          "Priority": 5
        },
        "Status": "Init",
        "OutFileMeta": {
          "FileBasicInfo": {
            "MediaId": "486c2890096871edba6f81848c016303",
            "FileName": "file.m3u8",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "31737",
            "FileUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8",
            "Region": "cn-shanghai",
            "FormatName": "hls,applehttp",
            "Duration": "403.039999",
            "Bitrate": "888.563",
            "Width": "848",
            "Height": "478"
          },
          "AudioStreamInfoList": [
            {
              "Index": "1",
              "CodecName": "aac",
              "CodecLongName": "AAC (Advanced Audio Coding)",
              "CodecTimeBase": "1/44100",
              "CodecTagString": "[15][0][0][0]",
              "CodecTag": "0x000f",
              "SampleFmt": "fltp",
              "SampleRate": "44100",
              "Channels": "2",
              "ChannelLayout": "stereo",
              "Timebase": "1/90000",
              "StartTime": "1.473556",
              "Duration": "403.039989",
              "Bitrate": "0.f",
              "Lang": "cn"
            }
          ],
          "VideoStreamInfoList": [
            {
              "Index": "0",
              "Codec_name": "h264",
              "Codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
              "Profile": "High",
              "Codec_time_base": "1/50",
              "Codec_tag_string": "[27][0][0][0]",
              "Codec_tag": "0x001b",
              "Width": "848",
              "Height": "478",
              "Has_b_frames": "2",
              "Sar": "478:477",
              "Dar": "16:9",
              "PixFmt": "yuv420p",
              "Level": "31",
              "Fps": "25.0",
              "Avg_fps": "25.0",
              "Time_base": "1/90000",
              "Start_time": "1.473556",
              "Duration": "403.039989",
              "Bit_rate": "888.563",
              "NumFrames": "10040",
              "Lang": "cn",
              "Rotate": "0"
            }
          ]
        },
        "SubmitResultJson": {},
        "SubmitTime": "2022-01-12T08:49:41Z",
        "FinishTime": "2022-01-12T08:49:41Z",
        "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262"
      }
    ],
    "CreateTime": "2022-01-12T08:49:41Z",
    "Name": "transcode-job",
    "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
    "ParentJobId": "8b2198504dd340b7b3c9842a74fc9baa",
    "JobCount": 1,
    "Status": "Success",
    "TriggerSource": "API",
    "Percent": 0,
    "SubmitTime": "2022-01-12T08:49:41Z",
    "FinishTime": "2022-01-12T08:49:41Z",
    "InputGroup": [
      {
        "Type": "OSS",
        "Media": "oss://bucket/path/to/video.mp4"
      }
    ],
    "OutputGroup": [
      {
        "Output": {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4",
          "OutputUrl": "oss://bucket/path/to/video.mp4\n"
        },
        "ProcessConfig": {
          "Transcode": {
            "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
            "OverwriteParams": {
              "Video": {
                "Codec": "H.264",
                "Profile": "Main",
                "Bitrate": "3000",
                "Crf": "23",
                "Width": "1920",
                "Height": "1080",
                "Fps": "25",
                "Gop": "250",
                "Preset": "medium",
                "ScanMode": "progressive",
                "PixFmt": "yuv420p",
                "Remove": "false",
                "Crop": "1280:800:0:140",
                "Pad": "1280:800:0:140",
                "LongShortMode": "false",
                "Bufsize": "6000",
                "Maxrate": "9000",
                "AbrMax": "6000"
              },
              "Audio": {
                "Codec": "AAC",
                "Profile": "aac_low",
                "Samplerate": "44100",
                "Bitrate": "128",
                "Channels": "2",
                "Remove": "false",
                "Volume": {
                  "Method": "auto",
                  "IntegratedLoudnessTarget": "-6",
                  "TruePeak": "-1",
                  "LoudnessRangeTarget": "8"
                }
              },
              "Container": {
                "Format": "mp4"
              },
              "MuxConfig": {
                "Segment": {
                  "Duration": "10",
                  "ForceSegTime": "2,3"
                }
              },
              "TransConfig": {
                "TransMode": "onepass",
                "IsCheckReso": "true",
                "IsCheckResoFail": "true",
                "IsCheckVideoBitrate": "true",
                "IsCheckVideoBitrateFail": "true",
                "IsCheckAudioBitrate": "true",
                "IsCheckAudioBitrateFail": "true",
                "AdjDarMethod": "none"
              }
            }
          },
          "ImageWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Width": "32",
                "Height": "32",
                "Dx": "10",
                "Dy": "10",
                "ReferPos": "TopLeft",
                "Timeline": {
                  "Start": "00:00:05",
                  "Duration": "ToEND"
                },
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "TextWatermarks": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Content": "测试水印",
                "FontName": "SimSun",
                "FontColor": "#006400",
                "FontAlpha": "1.0",
                "Top": "10",
                "Left": "10",
                "FontSize": 16,
                "BorderWidth": 0,
                "BorderColor": "#006400",
                "Adaptive": "false"
              }
            }
          ],
          "Subtitles": [
            {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18d410",
              "OverwriteParams": {
                "Format": "vtt",
                "CharEnc": "UTF-8",
                "File": {
                  "Type": "OSS",
                  "Media": "oss://bucket/path/to/video.mp4"
                }
              }
            }
          ],
          "Encryption": {
            "EncryptType": "PrivateEncryption",
            "CipherText": "MTYi00NDU0LTg5O****",
            "DecryptKeyUri": "https://sample.com/path?CipherText=MTYi00NDU0LTg5O****",
            "KeyServiceType": "KMS"
          },
          "CombineConfigs": [
            {
              "AudioIndex": "0 或 exclude",
              "VideoIndex": "0 或 exclude",
              "Start": 0,
              "Duration": 20
            }
          ]
        }
      }
    ],
    "UserData": "user-data",
    "ScheduleConfig": {
      "PipelineId": "e37ebee5d98b4781897f6086e89f9c56",
      "Priority": 5
    }
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-02-20	API 内部配置变更，不影响调用	查看变更详情
2023-06-06	OpenAPI 返回结构发生变更	查看变更详情
2023-05-18	OpenAPI 返回结构发生变更	查看变更详情
2022-09-20	OpenAPI 返回结构发生变更	查看变更详情
2022-07-11	新增 OpenAPI	查看变更详情