GetTranscodeJob - 查询转码任务

查询单个转码任务详情。

调试

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

授权信息

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

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

请求参数

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

任务 ID

ab4802364a2e49208c99efab82dfa8e8

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

9EDC30DC-0050-5459-B788-F761B2BE359B
TranscodeParentJobobject

TranscodeParentJobWithSubJobDTO

TranscodeJobListarray<object>

子任务列表。

TranscodeJobListobject

子任务。

CreateTimestring

任务创建时间。

2022-01-12T08:49:41Z
Namestring

任务名。

transcode-job
ParentJobIdstring

主任务 ID。

8b2198504dd340b7b3c9842a74fc9baa
JobIdstring

子任务 ID。

7d6a7e0d4db2457a8d45ff5d43e1bf0a
JobIndexinteger

子任务在整个任务中的索引号。

0
InputGrouparray<object>

任务输入组。单个输入为转码任务。多个输入为音视频合流任务。

InputGroupobject

作业输入。

Typestring

媒体对象类型。 取值:

  • OSS:OSS 文件。
  • Media:媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
InputUrlstring

媒资流地址,只有当对媒资流进行转码时填写此参数。

oss://bucket/path/to/video.mp4
ProcessConfigobject

转码处理配置。

Transcodeobject

转码配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Videoobject

video 设置。

Codecstring

编码格式。

H.264
Profilestring

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

  • baseline:针对移动设备。
  • main:针对标准分辨率设备。
  • high:针对高分辨率设备。

默认值:high。

Main
Bitratestring

视频平均码率。

  • 取值范围:[10,50000]。
  • 单位:Kbps。
3000
Crfstring

码率-质量控制因子。

  • 取值范围:[0,51]。
  • 默认值:编码格式为 H264,默认值为 23。编码格式为 H265,默认值为 26。

如果设置了 Crf,则 Bitrate 的设置失效。

23
Widthstring

宽。

  • 取值范围:[128,4096]。
  • 单位:px。

默认值:视频原始宽度。

1920
Heightstring

高。

  • 取值范围:[128,4096]。
  • 单位:px。

默认值:视频原始高度。

1080
Fpsstring

帧率。

  • 取值范围:(0,60]。 当输入文件帧率超过 60 时取 60。

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

25
Gopstring

关键帧间最大帧数。

  • 取值范围:[1,1080000]。
  • 默认值:250。
250
Presetstring

视频算法器预置。只有 H264 支持该参数。 支持 veryfast、fast、medium、slow、slower。

默认值:medium。

medium
ScanModestring

扫描模式。 支持 interlaced、progressive。

progressive
PixFmtstring

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

yuv420p
Removestring

是否去掉视频。

false
Cropstring

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

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

视频贴黑边,参数格式:width:height:left:top。

1280:800:0:140
LongShortModestring

是否开启横竖屏自适应(即:长短边模式)。

false
Bufsizestring

缓冲区大小:

  • 值范围:[1000,128000];
  • 默认值:6000;
  • 单位:Kb。
6000
Maxratestring

视频码率峰值:

  • 值范围[10,50000];
  • 单位 Kbps。
9000
AbrMaxstring

abr 最大码率(只有窄高 1 有效):

  • 值范围[10,50000];
  • 单位 Kbps。
6000
Audioobject

audio 设置。

Codecstring

音频编解码格式,AAC、MP3、VORBIS、FLAC。

默认值:AAC

AAC
Profilestring

音频编码预置。 当 Codec 为 AAC 时,范围 aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。

aac_low
Sampleratestring

采样率。

  • 默认值:44100 支持 22050、32000、44100、48000、96000,
  • 单位:Hz
44100
Bitratestring

输出文件的音频码率。

  • 值范围:[8,1000]
  • 单位:Kbps
  • 默认值:128
128
Channelsstring

声道数。 默认值:2

2
Removestring

是否删除音频流。

false
Volumeobject

音量控制。

Methodstring

音量调整方式。

auto
IntegratedLoudnessTargetstring

目标音量。

-6
TruePeakstring

最大峰值。

-1
LoudnessRangeTargetstring

音量范围。

8
Containerobject

封装格式设置。

Formatstring

容器格式。

mp4
MuxConfigobject

封装设置。

Segmentobject

切片设置。

Durationstring

切片时长。

10
ForceSegTimestring

强制切片时间点。

2,3
TransConfigobject

条件转码参数。

TransModestring

视频转码模式。取值如下:

  • onepass:一般用于 ABR。编码速度较 twopass 更快。

  • twopass:一般用于 VBR。编码速度较 onepass 更慢。

  • CBR:固定码率模式。

默认值:onepass。

onepass
IsCheckResostring

是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一,IsCheckResoFail 优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,按输入视频分辨率转码。

  • false:不检查。

默认值:false。

true
IsCheckResoFailstring

是否检查视频分辨率。IsCheckReso 和 IsCheckResoFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入视频分辨率(宽或高)小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
IsCheckVideoBitratestring

是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一,IsCheckVideoBitrateFail 优先级更高。

  • true:检查。当输入视频码率小于输出设置时,按输入视频码率转码。

  • false:不检查。

默认值:false。

true
IsCheckVideoBitrateFailstring

是否检查视频码率。IsCheckVideoBitrate 和 IsCheckVideoBitrateFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入视频码率小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
IsCheckAudioBitratestring

是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一,IsCheckAudioBitrateFail 优先级更高。

  • true:检查。当输入音频码率小于输出设置时,按输入音频码率转码。

  • false:不检查。

默认值:

  • 参数为空,并且 codec 和输入源不一样:false。

  • 参数为空,并且 codec 和输入源一样:true。

true
IsCheckAudioBitrateFailstring

是否检查音频码率。IsCheckAudioBitrate 和 IsCheckAudioBitrateFail 只支持二选一,本参数优先级更高。

  • true:检查。当输入音频码率小于输出设置时,返回转码失败。

  • false:不检查。

默认值:false。

true
AdjDarMethodstring

分辨率改写方式。当 Width 或 Height 都填写时才生效,可以和 LongShortMode 搭配使用。

可选值:rescale、crop、pad、none。

默认值:none。

示例:请参见如何设置分辨率。

none
ImageWatermarksarray<object>

图片水印配置。

ImageWatermarkobject

图片水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Widthstring

宽。

32
Heightstring

高。

32
Dxstring

水印位置,x。

10
Dystring

水印位置,y。

10
ReferPosstring

参考位置:TopLeft, TopRight, BottomLeft, BottomRight
默认值:TopLeft。

TopLeft
Timelineobject

显示时间设置。

Startstring

开始时间。

00:00:05
Durationstring

显示时长,秒数或者 "ToEND"。

ToEND
Fileobject

水印图片文件。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
TextWatermarksarray<object>

文字水印配置。

TextWatermarkobject

文字水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

覆盖参数, 若填写会覆盖模板对应参数。

Contentstring

水印文本,不需要 base64 encode,字符串需要 utf-8 编码。

测试水印
FontNamestring

字体。

SimSun
FontColorstring

颜色。

#006400
FontAlphastring

透明度。

1.0
Topstring