ListTranscodeJobs - 查询转码任务列表

查询转码任务列表。

调试

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

调试

授权信息

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

请求参数

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

任务创建时间筛选条件的起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

2022-07-01T00:00:00Z
EndOfCreateTimestring

任务创建时间筛选条件的结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

2022-07-15T00:00:00Z
JobIdstring

按 jobId 筛选。

7b38a5d86f1e47838927b6e7ccb11cbe
Statusstring

任务状态 - Init: 已提交, Success: 成功, Fail: 失败。

Success
OrderBystring

排序顺序。目前只支持两种:CreateTimeDesc: 按创建时间降序和CreateTimeAsc: 按创建时间升序。

CreateTimeDesc
PageSizeinteger

分页大小。范围:0~100,默认值:20。

10
NextPageTokenstring

连续分页查询时下一页的标记(第一页没有)

ab4802364a2e49208c99efab82dfa8e8

返回参数

名称类型描述示例值
object
RequestIdstring

请求 id

31E30781-9495-5E2D-A84D-759B0A01E262
Jobsarray

任务列表。

object

任务信息。

CreateTimestring

任务创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

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

任务名。

transcode-job
RequestIdstring

提交任务时请求 ID。

31E30781-9495-5E2D-A84D-759B0A01E262
ParentJobIdstring

主任务 ID。

8b2198504dd340b7b3c9842a74fc9baa
JobCountinteger

子任务数量。

1
Statusstring

任务状态。 Success: 所有子任务完成后,有一个子任务则为成功, Fail: 所有子任务失败。

Success
TriggerSourcestring

任务来源。 API: API, WorkFlow: 工作流, Console: 控制台

API
Percentinteger

任务完成百分比。

0
SubmitTimestring

任务提交时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

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

任务结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

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

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

object

任务输入。

Typestring

媒体对象类型。 取值:

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

媒体值: type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议; type 为 Media 时,为媒资 ID。

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

任务输出组。

object

任务输出。

Outputobject

输出媒体配置

Typestring

媒体对象类型。 取值:

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

媒体值: type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议; type 为 Media 时,为媒资 ID。

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
1280:800:0:140
Padstring

视频贴黑边。 参数格式:width:height:left:top。 示例:1280:800:0:140

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
ImageWatermarksarray

图片水印配置。

object

图片水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

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

Widthstring

宽。

32
Heightstring

高。

32
Dxstring

水印位置,x

10
Dystring

水印位置,y

10
ReferPosstring

参考位置:TopLeft, TopRight, BottomLeft, BottomRight default: 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

文字水印配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

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

Contentstring

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

测试水印
FontNamestring

字体。

SimSun
FontColorstring

颜色。

#006400
FontAlphastring

透明度。

1.0
Topstring

水印位置,距离上边距离。

10
Leftstring

水印位置,距离左边距离。

10
FontSizeinteger

字体大小。

16
BorderWidthinteger

边框宽度。

0
BorderColorstring

边框颜色。

#006400
Adaptivestring

根据输出视频大小调整字体 size。 true / false, default: false

false
Subtitlesarray

字幕压制配置。

object

字幕压制配置。

TemplateIdstring

模板 ID。

9547c6ad97cb4f2aaa29683ebd18d410
OverwriteParamsobject

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

Formatstring

字幕文件格式。

vtt
CharEncstring

文件 encoding 格式。

UTF-8
Fileobject

字幕文件。

Typestring

媒体对象类型。 取值:

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

媒体值: type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议; type 为 Media 时,为媒资 ID。

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

加密配置。

EncryptTypestring

加密类型。

PrivateEncryption
CipherTextstring

标准加密的密钥密文。

MTYi00NDU0LTg5O****
DecryptKeyUristring

标准加密的解密服务地址。

https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
CombineConfigsarray

多输入合流配置

object
AudioIndexstring

音频流Index

0 或 exclude
VideoIndexstring

视频流Index

0 或 exclude
Startnumber

输入流的开始时间。 默认为0

0.0
Durationnumber

输入流的持续时间。 默认为视频时长。

20.0
UserDatastring

用户数据。

user-data
ScheduleConfigobject

任务调度配置。

PipelineIdstring

管道 ID。

e37ebee5d98b4781897f6086e89f9c56
Priorityinteger

任务优先级。数字越大优先级越高,取值范围:1~10

5
NextPageTokenstring

下一页标识,第一次提交时为空即可。下一页标识将在第一次查询后返回。

019daf5780f74831b0e1a767c9f1c178

示例

正常返回示例

JSON格式

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "Jobs": [
    {
      "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"
          },
          "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"
                  }
                }
              }
            },
            "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****"
            },
            "CombineConfigs": [
              {
                "AudioIndex": "0 或 exclude",
                "VideoIndex": "0 或 exclude",
                "Start": 0,
                "Duration": 20
              }
            ]
          }
        }
      ],
      "UserData": "user-data",
      "ScheduleConfig": {
        "PipelineId": "e37ebee5d98b4781897f6086e89f9c56",
        "Priority": 5
      }
    }
  ],
  "NextPageToken": "019daf5780f74831b0e1a767c9f1c178"
}

错误码

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

阿里云首页 智能媒体生产 相关技术圈