All Products
Search
Document Center

ApsaraVideo Media Processing:QueryJobList

Last Updated:Mar 03, 2024

Queries transcoding jobs at a time by job ID.

Operation description

  • By default, returned jobs are sorted in descending order by CreationTime.
  • You can call this operation to query up to 10 transcoding jobs at a time.
  • If you do not set the JobIds parameter, the InvalidParameter error code is returned.

QPS limit

You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdsstringNo

The IDs of transcoding jobs. Separate multiple IDs with commas (,). You can query a maximum of 10 transcoding jobs at a time. You can log on to the ApsaraVideo Media Processing (MPS) console and click Tasks in the left-side navigation pane to obtain job IDs. Alternatively, you can obtain job IDs from the response to the SubmitJobs operation.

Note If you do not set the JobIds parameter, the InvalidParameter error code is returned.
bb558c1cc25b45309aab5be44d19****,d1ce4d3efcb549419193f50f1fcd****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NonExistJobIdsarray

The list of nonexistent job IDs. If all queried job IDs exist, the response does not contain this parameter.

string

The nonexistent job ID.

d1ce4d3efcb549419193f50f1fcd****
RequestIdstring

The ID of the request.

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

The transcoding jobs.

CreationTimestring

The time when the job was created.

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

The transcoding progress.

100
FinishTimestring

The time when the job was complete.

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

The job state. Valid values:

  • Submitted: The job was submitted.
  • Transcoding: Transcoding is in process.
  • TranscodeSuccess: The job was successful.
  • TranscodeFail: The job failed.
  • TranscodeCancelled: The job was canceled.
TranscodeSuccess
JobIdstring

The job ID.

31fa3c9ca8134fb4b0b0f7878301****
Codestring

The error code returned if the job failed. If the job was successful, this parameter is not returned.

InvalidParameter.NullValue
Messagestring

The error message returned if the job failed. If the job was successful, this parameter is not returned.

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

The job output.

Videoobject

The video configurations.

Bufsizestring

The buffer size.

  • Unit: KB.
  • Default value: 6000.
6000
Degrainstring

The strength of the independent noise reduction algorithm.

5
BitrateBndobject

The average bitrate range of the video.

Maxstring

The maximum bitrate.

1000
Minstring

The minimum bitrate.

300
PixFmtstring

The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.

yuv420p
Padstring

The black bars that are added to the video.

  • Unit: pixel.
  • Format: width:height:left:top.
1280:800:0:140
Codecstring

The video codec.

  • Valid values: H.264 and H.265.
  • Default value: H.264.
H.264
Heightstring

The height of the video.

  • Unit: pixel.
  • Default value: the height of the input video.
720
Qscalestring

The level of quality control on the video.

15
Cropstring

The method of video cropping. Valid values:

  • border: automatically detects and removes borders.
  • A value in the width:height:left:top format: The video image is cropped based on custom settings.
1280:800:0:140
Bitratestring

The average bitrate of the video. Unit: Kbit/s.

500
Maxratestring

The maximum bitrate of the video. Unit: Kbit/s.

3000
MaxFpsstring

The maximum frame rate.

60
Profilestring

The codec profile of the video. Valid values: baseline, main, and high.

Note If multiple definitions are involved, we recommend that you use baseline for the lowest definition to ensure normal playback on low-end devices, and use main or high for other definitions.
  • baseline: applicable to mobile devices.
  • main: applicable to standard-definition devices.
  • high: applicable to high-definition devices.
  • Default value: high.
high
Crfstring

The constant rate factor.

  • Default value when the value of Codec is H.264: 23, default value when the value of Codec is H.265: 26.
  • If the value of this parameter is returned, the value of Bitrate becomes invalid.
26
Gopstring

The maximum interval between keyframes or the maximum number of frames in a frame group. Unit: seconds.

  • Default value: 250.
  • If the maximum number of frames is returned, the value does not contain a unit.
250
Widthstring

The width of the video.

  • Unit: pixel.
  • Default value: the width of the input video.
1280
Fpsstring

The frame rate of the video.

  • Unit: frames per second.
  • The value is 60 if the frame rate of the input file exceeds 60.
  • Default value: the frame rate of the input video.
25
Presetstring

The preset video algorithm. Default value: medium. Valid values:

  • veryfast
  • fast
  • medium
  • slow
  • slower
medium
ScanModestring

The scan mode. Valid values:

  • If this parameter is left empty, the scan mode of the input video is used.
  • auto: automatic deinterlacing.
  • progressive: progressive scan.
  • interlaced: interlaced scan.
  • By default, this parameter is left empty.

Best practice: The interlaced scan mode saves data traffic than the progressive scan mode but provides poor image quality. Therefore, the progressive scan mode is commonly used in mainstream video production.

  • If progressive or interlaced is used when the scan mode of the input video is neither of them, the transcoding job fails.
  • We recommend that you use the scan mode of the input video or automatic deinterlacing for higher compatibility.
interlaced
ResoPrioritystring

The resource priority.

1
TransConfigobject

The general transcoding configurations.

Note If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.
IsCheckAudioBitratestring

Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values:

  • true

  • false

  • Default value:

    • If this parameter is empty and the codec of the output audio is different from that of the input audio, the default value is false.
    • If this parameter is empty and the codec of the output audio is the same as that of the input audio, the default value is true.
false
TransModestring

The transcoding mode.

  • Valid values: onepass, twopass, and CBR.
  • Default value: onepass.
onepass
IsCheckResostring

Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values:

  • true:
  • false
  • Default value: false.
false
IsCheckVideoBitrateFailstring

Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input video is not transcoded and a transcoding failure is returned. This parameter has a higher priority than IsCheckVideoBitrate. Valid values:

  • true
  • false
  • Default value: false.
false
AdjDarMethodstring

The method of resolution adjustment. Default value: none. Valid values: rescale, crop, pad, and none.

none
IsCheckVideoBitratestring

Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values:

  • true
  • false
  • Default value: false.
false
IsCheckResoFailstring

Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values:

  • true
  • false
  • Default value: false.
false
IsCheckAudioBitrateFailstring

Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input audio is not transcoded and a transcoding failure is returned. This parameter has a higher priority than IsCheckAudioBitrate. Valid values:

  • true
  • false
  • Default value: false.
false
Encryptionobject

The encryption configurations. The encrypted video file is generated in the M3U8 format.

Typestring

The encryption type. Only hls-aes-128 may be returned.

hls-aes-128
Keystring

The key that is used to encrypt the video.

encryptionkey128
KeyTypestring

The key encryption method. Valid values: Base64 and KMS.

Note For example, if the key is encryptionkey128, the key can be encrypted as Base64("encryptionkey128") or KMS(Base64("encryptionkey128") depending on the encryption method used.
Base64
Idstring

The encryption ID.

31fa3c9ca8134f9cec2b4b0b0f78****
KeyUristring

The URL that is used to request the key. The URL is Base64-encoded.

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

The number of unencrypted frames at the beginning of the video. Leaving these frames unencrypted enables video playback to quickly start.

3
WaterMarkListobject []

The watermarks.

Typestring

The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. For more information, see Parameter details. Valid values:

  • Image
  • Text
Image
ReferPosstring

The position of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Valid values:

  • TopRight
  • TopLeft
  • BottomRight
  • BottomLeft
TopRight
Dxstring

The horizontal offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Default value: 0. The value can be an integer or a decimal number.

  • An integer indicates the pixel value of the horizontal offset.

    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal number indicates the ratio of the horizontal offset to the width in the output video resolution.

    • Valid values: (0,1).
    • The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.
100
Widthstring

The width of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.

  • An integer indicates the pixel value of the watermark width.

    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal number indicates the ratio of the watermark width to the width in the output video resolution.

    • Valid values: (0,1).
    • The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.
50
Heightstring

The height of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.

  • An integer indicates the pixel value of the watermark height.

    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal number indicates the ratio of the watermark height to the height in the output video resolution.

    • Valid values: (0,1).
    • The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.
50
InputFileobject

The watermark input file. PNG images and MOV files are supported.

Objectstring

The name of the Object Storage Service (OSS) object that is used as the input file.

example-logo-****.png
Locationstring

The OSS region in which the input file resides.

oss-cn-hangzhou
Bucketstring

The name of the OSS bucket in which the input file is stored.

example-bucket
WaterMarkTemplateIdstring

The ID of the watermark template.

88c6ca184c0e47098a5b665e2a12****
Dystring

The vertical offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number.

  • An integer indicates the pixel value of the vertical offset.

    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal number indicates the ratio of the vertical offset to the height in the output video resolution.

    • Valid values: (0,1).
    • The decimal number can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically discarded.
100
WaterMarkConfigUrlstring

The URL of the watermark configuration file.

http://example.com/configure
DeWatermarkstring

The configurations of watermark blurring. The value is a JSON object. For more information, see the DeWatermark section of the Parameter details topic.

{"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

The non-standard support configurations for M3U8. The value is a JSON object. For more information, see the M3U8NonStandardSupport section of the Parameter details topic.

TSobject

The non-standard support configurations for TS files. The value is a JSON object. For more information, see the TS section of the Parameter details topic.

SizeSupportboolean

Indicates whether the output of the size of the TS file is supported in the M3U8 file. Valid values:

  • true
  • false
true
Md5Supportboolean

Indicates whether the output of the MD5 value of the TS file is supported in the M3U8 file. Valid values:

  • true
  • false
true
Prioritystring

The priority of the job in the ApsaraVideo Media Processing (MPS) queue to which the job is added.

  • A value of 10 indicates the highest priority.
  • Default value: 6.
6
Audioobject

The audio configurations.

Note If this parameter is specified in the request, the corresponding parameter in the specified transcoding template are overwritten.
Profilestring

The codec profile of the audio. Valid values when the value of Codec is aac: aaclow, aache, aachev2, aacld, and aaceld.

aaclow
Codecstring

The audio codec.

  • Valid values: aac, mp3, vorbis, and flac.
  • Default value: aac.
aac
Sampleratestring

The sampling rate.

  • Valid values: 22050, 32000, 44100, 48000, and 96000.
  • Unit: Hz.
  • Default value: 44100.
Note If the video container format is FLV and the audio codec is MP3, the value of this parameter cannot be 32000, 48000, or 96000. If the audio codec is MP3, the value of this parameter cannot be 96000.
44100
Qscalestring

The level of quality control on the audio.

15
Channelsstring

The number of sound channels.

  • Valid values: 1, 2, 3, 4, 5, 6, 7, and 8.
  • Default value: 2.
2
Volumeobject

The volume configurations.

Methodstring

The method that is used to adjust the volume. Valid values:

  • auto
  • dynamic
  • linear
auto
Levelstring

The volume adjustment range. Default value: -20. Unit: dB.

-20
Bitratestring

The audio bitrate of the output file.

  • Unit: Kbit/s.
  • Default value: 128.
128
AudioStreamMapstring

The sequence number of the audio stream.

  • Format: 0:a:{Sequence number}. Example: 0:a:0.
  • The sequence number is the index of the audio stream in the list and starts from 0.
  • If no sequence number is specified, the default audio stream is used.
0:a:0
MergeListobject []

The configurations of clip merging. Up to four clips can be merged.

Startstring

The start point in time of the clip.

  • Format: hh:mm:ss[.SSS] or sssss[.SSS].
  • Examples: 01:59:59.999 and 32000.23.
01:59:59.999
RoleArnstring

The Alibaba Cloud Resource Name (ARN) of the Recource Access Management (RAM) role used for delegated authorization.

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

The OSS URL of the clip.

  • Example: http://example-bucket-.oss-cn-hangzhou.aliyuncs.com/example-object.flv.
  • The object must be URL-encoded by using the UTF-8 standard. For more information, see URL encoding.
http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv
Durationstring

The duration of the clip.

  • Format: hh:mm:ss[.SSS] or sssss[.SSS].
  • Examples: 01:59:59.999 and 32000.23.
01:59:59.999
SuperResoobject

The configurations for using the resolution of the source video.

IsHalfSamplestring

Indicates whether parameters related to the sampling rate are obtained. Valid values:

  • true
  • false
true
UserDatastring

The custom data.

testid-001
ExtendDatastring

The custom fields.

testid-002
OutSubtitleListobject []

The output captions.

Mapstring

The video track. Format: 0:{Stream}:{Stream sequence number}, which is 0:v:{video_index}. The value of Stream is v, which indicates a video stream. The sequence number is the index of the video stream in the list and starts from 0.

0:v:0
OutSubtitleFileobject

The details of the output caption.

RoleArnstring

The ARN of the RAM role used for delegated authorization.

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

The name of the OSS object that is used as the output caption.

example.flv
Locationstring

The OSS region in which the output caption resides.

oss-cn-hangzhou
Bucketstring

The name of the OSS bucket in which the output caption is stored.

exampleBucket
Successboolean

Indicates whether the job was successful. Valid values:

  • true: The job was successful.
  • false: The job failed.
true
Messagestring

The error message returned if the job failed to be created. This parameter is not returned if the job was created.

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

The sequence number of the video stream. The sequence number is the index of the video stream in the list and starts from 0. If no sequence number is specified, the default video stream is used.

0
OutputFileobject

The details of the output file.

RoleArnstring

The ARN of the RAM role used for delegated authorization.

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

The name of the OSS object that is used as the output file.

example-output.flv
Locationstring

The OSS region in which the output file resides.

oss-cn-hangzhou
Bucketstring

The name of the OSS bucket in which the output file is stored.

example-bucket
Rotatestring

The rotation angle of the video.

90
Containerobject

The container format configurations.

Formatstring

The container format.

  • Default value: mp4.
  • Video formats include FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4).
  • Audio formats include MP3, MP4, Ogg, FLAC, and M4A.
  • Image formats include GIF and WebP. If the container format is GIF, the video codec must be GIF.
  • If the container format is WebP, the video codec must be WebP.
  • If the container format is FLV, the video codec cannot be H.265.
mp4
Clipobject

The information about clips.

TimeSpanobject

The time span of the clip.

Seekstring

The point in time when the clip starts.

  • Format: hh:mm:ss[.SSS].
  • Example: 01:59:59.999.

Or

  • Format: sssss[.SSS].
  • Example: 32000.23.
01:59:59.999
Durationstring

The duration of the clip.

  • Format: hh:mm:ss[.SSS].
  • Example: 01:00:59.999.

Or

  • Format: sssss[.SSS].
  • Example: 32000.23.
01:00:59.999
MergeConfigUrlstring

The URL of the merging configuration file. Only one of MergeList and MergeConfigUrl takes effect.

  • The configuration file specified by MergeConfigUrl can contain up to 50 clips.
  • MergeConfigUrl indicates the URL of the configuration file for merging clips. Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details about merging parameters.
  • Example of the content of the merging configuration file: {"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}.
https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8
OpeningListobject []

The opening parts. The value is a JSON object.

openUrlstring

The OSS URL of the opening part.

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

The amount of time after which the opening part is played.

  • The value starts from 0.
  • Unit: seconds.
  • Default value: 0.
0
Widthstring

The width of the opening part.

  • Valid values: values in the range of (0,4096), -1, and full.
  • A value of -1 indicates that the original width of the opening part is retained.
  • A value of full indicates that the width of the opening part equals the width of the main part.
  • Default value: -1.
-1
Heightstring

The height of the opening part.

  • Valid values: values in the range of (0,4096), -1, and full.
  • A value of -1 indicates that the original height of the opening part is retained.
  • A value of full indicates that the height of the opening part equals the height of the main part.
  • Default value: -1.
-1
MuxConfigobject

The transmuxing configurations. The transmuxing configurations. If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.

Webpobject

The transmuxing configurations for WebP.

Loopstring

The loop count.

0
Gifobject

The transmuxing configurations for GIF.

FinalDelaystring

The duration for which the final frame is paused. Unit: centisecond.

0
DitherModestring

The color dithering algorithm of the palette. Valid values: sierra and bayer.

bayer
Loopstring

The loop count.

0
IsCustomPalettestring

Indicates whether a custom palette is used. Valid values:

  • true
  • false
false
Segmentobject

The segment configurations. The value is a JSON object.

Durationstring

The segment length. Unit: seconds.

20
TailSlateListobject []

The ending parts.

Startstring

The time when the ending part is played.

00000.00
BgColorstring

The color of the bars that are added to the ending part if the size of the ending part is smaller than that of the main part. Default value: White. For more information, see Parameter details.

White
IsMergeAudioboolean

Indicates whether the audio content of the ending part is merged. Valid values:

  • true
  • false
true
Widthstring

The width of the ending part. Valid values: values in the range of (0,4096), -1, and full.

  • A value of -1 indicates that the original width of the ending part is retained.
  • A value of full indicates that the width of the ending part equals the width of the main part.
  • Default value: -1.
-1
Heightstring

The height of the ending part.

  • Valid values: values in the range of (0,4096), -1, and full.
  • A value of -1 indicates that the original height of the ending part is retained.
  • A value of full indicates that the height of the ending part equals the height of the main part.
  • Default value: -1.
-1
BlendDurationstring

The duration of the transition between the main part and the ending part. A fade transition is used: The last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0.

0
TailUrlstring

The OSS URL of the ending part.

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

The template ID.

S00000001-200010
SubtitleConfigobject

The caption configurations.

ExtSubtitleListobject []

The external captions.

CharEncstring

The character set used by the external caption.

  • Valid values: UTF-8, GBK, BIG5, and auto.
  • Default value: auto.
Note If the value of CharEnc is auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.
auto
FontNamestring

The font of the hardcoded captions converted from external captions. Default value: SimSum. For more information, see Fonts .

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

The input caption file.

  • SRT and ASS files are supported. For more information, see the Input section of the Parameter details topic.
  • Example: {"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"}.
Objectstring

The name of the OSS object that is used as the input caption file.

example-output.flv
Locationstring

The OSS region in which the input caption file resides.

oss-cn-hangzhou
Bucketstring

The name of the OSS bucket in which the input caption file is stored.

example-bucket-****
SubtitleListobject []

The captions.

Mapstring

The audio track. Format: 0:{Stream}:{Stream sequence number}, which is 0:a:{audio_index}. The value of Stream is a, which indicates an audio stream. The sequence number is the index of the audio stream in the list and starts from 0.

0:a:0
Propertiesobject

The media properties.

Widthstring

The video width.

720
Heightstring

The video height.

1280
SourceLogosobject []

The non-engine layer keywords.

Sourcestring

The keyword.

example
Durationstring

The video duration.

17
Fpsstring

The frame rate of the video.

30
Bitratestring

The video bitrate.

490
FileFormatstring

The video format.

mp4
Streamsobject

The stream information.

VideoStreamListobject []

The video streams.

Indexstring

The sequence number of the video stream. The value indicates the position of the video stream in all video streams.

0
Timebasestring

The time base of the video stream.

1/15360
AvgFPSstring

The average frame rate of the video stream.

30.0
PixFmtstring

The pixel format of the video stream.

yuv420p
Sarstring

The sample aspect ratio (SAR) of the video stream.

1:1
Langstring

The language of the video stream. For more information, see FFmpeg documentation and ISO 639.

eng
CodecLongNamestring

The full name of the codec.

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

The height of the video stream in pixels.

1280
NumFramesstring

The total number of frames.

30
Bitratestring

The video bitrate.

421.117
CodecTagStringstring

The tag string of the codec.

avc1
HasBFramesstring

Indicates whether the video stream contains bidirectional frames (B-frames).

2
Profilestring

The codec profile.

high
StartTimestring

The start time.

0.000000
NetworkCostobject

The network bandwidth that was consumed.

PreloadTimestring

The amount of time consumed to preload the video stream.

8
AvgBitratestring

The average bitrate.

300
CostBandwidthstring

The maximum bandwidth that was consumed.

10
Darstring

The display aspect ratio (DAR) of the video stream.

9:16
CodecNamestring

The short name of the codec.

h264
Widthstring

The width of the video stream in pixels.

720
Durationstring

The duration of the video stream.

17.233333
Fpsstring

The frame rate of the video stream.

30.0
CodecTagstring

The tag of the codec.

0x31637661
CodecTimeBasestring

The codec time base.

1/60
Levelstring

The codec level.

31
colorTransferstring

The color transfer configuration.

bt709
colorPrimariesstring

The primary colors.

bt709
bitsPerRawSamplestring

The number of binary bits used by each sample or pixel.

8
AudioStreamListobject []

The audio streams.

Timebasestring

The time base of the audio stream.

1/32000
Indexstring

The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.

1
SampleFmtstring

The sampling format.

fltp
ChannelLayoutstring

The output layout of the sound channels.

mono
Langstring

The language of the audio stream. For more information, see FFmpeg documentation and ISO 639.

und
Sampleratestring

The sampling rate.

32000
CodecLongNamestring

The full name of the codec.

AAC (Advanced Audio Coding)
Channelsstring

The number of sound channels.

1
NumFramesstring

The total number of frames.

50
Bitratestring

The bitrate of the audio stream.

64.136
CodecTagStringstring

The tag string of the codec.

mp4
StartTimestring

The start time.

0.064000
CodecNamestring

The short name of the codec.

aac
Durationstring

The duration of the audio stream.

17.223562
CodecTagstring

The tag of the codec.

0x6134706d
CodecTimeBasestring

The codec time base.

1/32000
SubtitleStreamListobject []

The caption streams.

Indexstring

The sequence number of the caption stream. The value indicates the position of the caption stream in all caption streams.

1
Langstring

The language of the caption stream. For more information, see FFmpeg documentation and ISO 639.

eng
Formatobject

The format information.

StartTimestring

The start time.

-0.064000
NumProgramsstring

The total number of program streams.

0
Sizestring

The size of the media file.

1057273
NumStreamsstring

The total number of media streams.

2
FormatLongNamestring

The full name of the container format.

QuickTime / MOV
Durationstring

The total duration.

17.234000
Bitratestring

The total bitrate.

490.784
FormatNamestring

The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.

mov
FileSizestring

The size of the media file.

1057273
MultiSpeedInfoobject

The information about the high-speed transcoding job. This information is available only for jobs that are submitted by using an MPS queue for high-speed transcoding. This does not support MPS queues for high-speed transcoding of an earlier version.

Enablestring

Indicates whether high-speed transcoding is enabled.

true
Codestring

The error code returned if high-speed transcoding is not enabled.

Boost.NotNeedSpeed
Messagestring

The error message returned if high-speed transcoding is not enabled.

success
SettingSpeedinteger

The speed setting.

30
DowngradePolicystring

The downgrade policy if high-speed transcoding is not supported.

NormalSpeed
RealSpeeddouble

The actual transcoding speed.

6.576886940181647
Durationdouble

The duration of the output video.

21.0
TimeCostdouble

The amount of time consumed.

3.193
PipelineIdstring

The ID of the MPS queue that is used to run the job.

88c6ca184c0e47b665e2a1267971****
Inputobject

The information about the job input.

Objectstring

The name of the OSS object that is used as the input file.

video_01.mp4
Locationstring

The OSS region in which the input file resides.

oss-cn-shanghai
Bucketstring

The name of the OSS bucket in which the input file is stored.

exampleBucket
MNSMessageResultobject

The message sent by Message Service (MNS) to notify users of the job result.

MessageIdstring

The ID of the message returned if the job was successful.

123
ErrorMessagestring

The error message returned if the job failed. This parameter is not returned if the job was successful.

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

The error code returned if the job failed. This parameter is not returned if the job was successful.

InvalidParameter.ResourceNotFound
SubmitTimestring

The time when the job was submitted.

2021-03-04T06:44:43Z

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-21The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-03API Description Update. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Output ParametersThe response structure of the API has changed.
2023-06-13The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-06-13The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: IncludePipelineInfo