查询媒体文件的转码任务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:ListTranscodeJobs |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| StartOfCreateTime |
string |
否 |
任务创建时间筛选条件的起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ。 |
2022-07-01T00:00:00Z |
| EndOfCreateTime |
string |
否 |
任务创建时间筛选条件的结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ。 |
2022-07-15T00:00:00Z |
| ParentJobId |
string |
否 |
按 jobId 筛选。 |
7b38a5d86f1e47838927b6e7ccb1**** |
| Status |
string |
否 |
任务状态
|
Success |
| OrderBy |
string |
否 |
排序顺序。目前只支持两种:
|
CreateTimeDesc |
| PageSize |
integer |
否 |
分页大小。范围:0~100,默认值:20。 |
10 |
| NextPageToken |
string |
否 |
连续分页查询时下一页的标记(第一页没有)。 |
ab4802364a2e49208c99efab82df**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 id |
31E30781-9495-5E2D-A84D-759B0A01E262 |
| Jobs |
array<object> |
任务列表。 |
|
|
array<object> |
任务信息。 |
||
| 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。 |
8b2198504dd340b7b3c9842a74fc**** |
| JobCount |
integer |
子任务数量。 |
1 |
| Status |
string |
任务状态。
|
Success |
| TriggerSource |
string |
任务来源。
|
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> |
任务输入组。单个输入为转码任务。多个输入为音视频合流任务。 |
|
|
object |
任务输入。 |
||
| Type |
string |
媒体对象类型。 取值:
|
OSS |
| Media |
string |
媒体值:
|
oss://bucket/path/to/video.mp4 |
| InputUrl |
string |
媒资流地址,只有当对媒资流进行转码时填写此参数。 |
oss://bucket/path/to/video.mp4 |
| OutputGroup |
array<object> |
任务输出组。 |
|
|
array<object> |
任务输出。 |
||
| Output |
object |
输出媒体配置 |
|
| Type |
string |
媒体对象类型。 取值:
|
OSS |
| Media |
string |
媒体值:
|
oss://bucket/path/to/video.mp4 |
| OutputUrl |
string |
转码输出流地址,仅当输出到媒资流时需要填此参数 |
oss://bucket/path/to/{MediaId}/{JobId}.mp4 |
| ProcessConfig |
object |
任务处理配置。 |
|
| Transcode |
object |
转码配置。 |
|
| TemplateId |
string |
模板 ID。 |
9547c6ad97cb4f2aaa29683ebd18**** |
| OverwriteParams |
object |
覆盖参数, 若填写会覆盖模板对应参数。 |
|
| Video |
object |
video 设置。 |
|
| Codec |
string |
编码格式。 |
H.264 |
| Profile |
string |
编码级别。支持 baseline、main、high。
默认值:high。 |
Main |
| Bitrate |
string |
视频平均码率。
|
3000 |
| Crf |
string |
码率-质量控制因子。
如果设置了 Crf,则 Bitrate 的设置失效。 |
23 |
| Width |
string |
宽。
|
1920 |
| Height |
string |
高。
|
1080 |
| Fps |
string |
帧率。
|
25 |
| Gop |
string |
关键帧间最大帧数。
|
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 种方式。
|
1280:800:0:140 |
| Pad |
string |
视频贴黑边。
|
1280:800:0:140 |
| LongShortMode |
string |
是否开启横竖屏自适应(即:长短边模式) |
false |
| Bufsize |
string |
缓冲区大小。
|
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 |
| Bitrate |
string |
输出文件的音频码率。
|
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 |
| Tags |
object |
||
|
string |
|||
| ImageWatermarks |
array<object> |
图片水印配置。 |
|
|
array<object> |
图片水印配置。 |
||
| TemplateId |
string |
模板 ID。 |
9547c6ad97cb4f2aaa29683ebd18**** |
| OverwriteParams |
object |
覆盖参数, 若填写会覆盖模板对应参数。 |
|
| Width |
string |
宽。 |
32 |
| Height |
string |
高。 |
32 |
| Dx |
string |
水印位置,x |
10 |
| Dy |
string |
水印位置,y |
10 |
| ReferPos |
string |
参考位置:TopLeft, TopRight, BottomLeft, BottomRight |
TopLeft |
| Timeline |
object |
显示时间设置。 |
|
| Start |
string |
开始时间。 |
00:00:05 |
| Duration |
string |
显示时长,秒数或者 "ToEND" |
ToEND |
| File |
object |
水印图片文件。 |
|
| Type |
string |
媒体对象类型。 取值:
|
OSS |
| Media |
string |
媒体值:
|
oss://bucket/path/to/video.mp4 |
| TextWatermarks |
array<object> |
文字水印配置。 |
|
|
array<object> |
文字水印配置。 |
||
| TemplateId |
string |
模板 ID。 |
9547c6ad97cb4f2aaa29683ebd18**** |
| 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。
默认值:false |
false |
| Subtitles |
array<object> |
字幕压制配置。 |
|
|
array<object> |
字幕压制配置。 |
||
| TemplateId |
string |
模板 ID。 |
9547c6ad97cb4f2aaa29683ebd18**** |
| OverwriteParams |
object |
覆盖参数, 若填写会覆盖模板对应参数。 |
|
| Format |
string |
字幕文件格式。 |
vtt |
| CharEnc |
string |
文件 encoding 格式。 |
UTF-8 |
| File |
object |
字幕文件。 |
|
| Type |
string |
媒体对象类型。 取值:
|
OSS |
| Media |
string |
媒体值:
|
oss://bucket/path/to/video.mp4 |
| Encryption |
object |
加密配置。 |
|
| EncryptType |
string |
加密类型。 |
PrivateEncryption |
| CipherText |
string |
标准加密的密钥密文。 |
MTYi00NDU0LTg5O**** |
| DecryptKeyUri |
string |
标准加密的解密服务地址。 |
https://sample.com/path?CipherText=MTYi00NDU0LTg5O**** |
| CombineConfigs |
array<object> |
多输入合流配置 |
|
|
object |
|||
| AudioIndex |
string |
音频流 Index |
0 或 exclude |
| VideoIndex |
string |
视频流 Index |
0 或 exclude |
| Start |
number |
输入流的开始时间。 默认为 0 |
0.0 |
| Duration |
number |
输入流的持续时间。 默认为视频时长。 |
20.0 |
| IsInheritTags |
boolean |
是否继承输入流的 tag。 当输入不是媒资是该参数不生效。 默认值:false |
|
| UserData |
string |
用户数据。 |
user-data |
| ScheduleConfig |
object |
任务调度配置。 |
|
| PipelineId |
string |
管道 ID。 |
e37ebee5d98b4781897f6086e89f**** |
| Priority |
integer |
任务优先级。数字越大优先级越高,取值范围:1~10 |
5 |
| NextPageToken |
string |
下一页标识,第一次提交时为空即可。下一页标识将在第一次查询后返回。 |
019daf5780f74831b0e1a767c9f1**** |
示例
正常返回示例
JSON格式
{
"RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
"Jobs": [
{
"CreateTime": "2022-01-12T08:49:41Z",
"Name": "transcode-job",
"RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
"ParentJobId": "8b2198504dd340b7b3c9842a74fc****",
"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",
"InputUrl": "oss://bucket/path/to/video.mp4"
}
],
"OutputGroup": [
{
"Output": {
"Type": "OSS",
"Media": "oss://bucket/path/to/video.mp4",
"OutputUrl": "oss://bucket/path/to/{MediaId}/{JobId}.mp4"
},
"ProcessConfig": {
"Transcode": {
"TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
"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"
}
},
"Tags": {
"key": ""
}
}
},
"ImageWatermarks": [
{
"TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
"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": "9547c6ad97cb4f2aaa29683ebd18****",
"OverwriteParams": {
"Content": "测试水印",
"FontName": "SimSun",
"FontColor": "#006400",
"FontAlpha": "1.0",
"Top": "10",
"Left": "10",
"FontSize": 16,
"BorderWidth": 0,
"BorderColor": "#006400",
"Adaptive": "false"
}
}
],
"Subtitles": [
{
"TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
"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
}
],
"IsInheritTags": true
}
}
],
"UserData": "user-data",
"ScheduleConfig": {
"PipelineId": "e37ebee5d98b4781897f6086e89f****",
"Priority": 5
}
}
],
"NextPageToken": "019daf5780f74831b0e1a767c9f1****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。