Queries multiple transcoding jobs at a time based on transcoding job IDs.

Usage notes

  • 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 limits

You can call this 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryJobList

The operation that you want to perform. Set the value to QueryJobList.

JobIds String No bb558c1cc25b45309aab5be44d19****,d1ce4d3efcb549419193f50f1fcd****

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.

Response parameters

Parameter Type Example Description
NonExistJobIds Array of String d1ce4d3efcb549419193f50f1fcd****

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

RequestId String 197ADF44-104C-514C-9F92-D8924CB34E2A

The ID of the request.

JobList Array of Job

The list of transcoding jobs.

Job
CreationTime String 2014-01-10T12:00:00Z

The time when the job was created.

Percent Long 100

The transcoding progress.

FinishTime String 2014-01-10T12:20:25Z

The time when the transcoding job was complete.

State String TranscodeSuccess

The status of the job. Valid values:

  • Submitted: The job has been submitted.
  • Transcoding: The job is being processed.
  • TranscodeSuccess: The job succeeded.
  • TranscodeFail: Transcoding failed.
  • TranscodeCancelled: The job has been canceled.
JobId String 31fa3c9ca8134fb4b0b0f7878301****

The ID of the task.

Code String InvalidParameter.NullValue

The error code that is returned if the transcoding job fails. This parameter is not returned if the job succeeds.

Message String The specified parameter "%s" cannot be null.

The message that is returned if the job fails. This parameter is not returned if the job succeeds.

Output Object

The output of the job.

Video Object

The video configuration.

Bufsize String 6000

The size of the buffer.

  • Unit: KB.
  • Default value: 6000.
Degrain String 5

The level of the independent denoising algorithm.

BitrateBnd Object

The average bitrate range of the video.

Max String 1000

The maximum bitrate.

Min String 300

The minimum bitrate.

PixFmt String yuv420p

The pixel format for video color encoding. Standard pixel formats such as yuv420p and yuvj420p are supported.

Pad String 1280:800:0:140

The black borders to be added to the video.

  • Unit: pixel.
  • Format: width:height:left:top.
Codec String H.264

The codec.

  • Valid values: H.264 and H.265.
  • Default value: H.264.
Height String 720

The height of the video.

  • Unit: pixel.
  • By default, the original video height is used.
Qscale String 15

The level of quality control on the video.

Crop String 1280:800:0:140

The crop mode. The following two modes are supported:

  • border: automatically detects and removes black bars.
  • A value in the format of width:height:left:top: crops the video image based on the custom setting.
Bitrate String 500

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

Maxrate String 3000

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

MaxFps String 60

The maximum frame rate.

Profile String high

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

Note If multiple definitions exist, we recommend that you set this parameter to baseline for the lowest definition to ensure normal playback on low-end devices. Set this parameter to 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.
Crf String 26

The constant rate factor.

  • Default value when the Codec parameter is set to H.264: 23. Default value when the Codec parameter is set to H.265: 26.
  • If this parameter is returned, the setting of the Bitrate parameter is invalid.
Gop String 250

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

  • Default value: 250.
  • If you specified the maximum number of frames, the value does not contain a unit.
Width String 1280

The width of the video.

  • Unit: pixel.
  • By default, the original width of the video is used.
Fps String 25

The frame rate.

  • Unit: frames per second.
  • The value is 60 if the frame rate of the input file exceeds 60.
  • By default, the frame rate of the input file is used.
Preset String medium

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

  • veryfast
  • fast
  • medium
  • slow
  • slower
ScanMode String interlaced

The scan mode. Valid values:

  • interlaced: An interlaced scan is performed.
  • progressive: A progressive scan is performed.
  • auto: A scan is performed based on the video source.
ResoPriority String 1

The priority of the resource.

TransConfig Object

The general transcoding configuration.

Note If this parameter is specified in the request, the value overwrites the corresponding parameter in the specified transcoding template.
IsCheckAudioBitrate String false

Indicates whether the audio bitrate is checked. If the feature is enabled and the system detects that the audio bitrate of the output file is greater than that of the input file, the audio bitrate of the input file is retained after transcoding. In this case, the setting of the Bitrate parameter is invalid. This parameter has a lower priority than the IsCheckAudioBitrateFail parameter.

  • true: The audio bitrate is checked.
  • false: The audio bitrate is not checked.
    • Default value when the Bitrate parameter is not specified and the codec of the output file is different from the codec of the input file: false.
    • Default value when the Bitrate parameter is not specified and the codec of the output file is the same as the codec of the input file: true.
TransMode String onepass

The transcoding mode.

  • Valid values: onepass, twopass, and CBR.
  • Default value: onepass.
IsCheckReso String false

Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the system considers that the output resolution equals the input resolution.

  • true: The resolution is checked.
  • false: The resolution is not checked.
  • Default value: false.
IsCheckVideoBitrateFail String false

Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, a transcoding failure is returned without transcoding the video. This parameter has a higher priority than the IsCheckVideoBitrate parameter.

  • true: The video bitrate is checked.
  • false: The video bitrate is not checked.
  • Default value: false.
AdjDarMethod String none

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

IsCheckVideoBitrate String false

Indicates whether the video bitrate is checked. If the output bitrate is higher than the input bitrate, the system considers that the output bitrate equals the input bitrate.

  • true: The video bitrate is checked.
  • false: The video bitrate is not checked.
  • Default value: false.
IsCheckResoFail String false

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.

  • true: The video bitrate is checked.
  • false: The video bitrate is not checked.
  • Default value: false.
IsCheckAudioBitrateFail String false

Indicates whether the audio bitrate is checked. If the output audio bitrate is higher than the audio bitrate of the media source, a transcoding failure is returned without transcoding the media. This value has a higher priority than IsCheckAudioBitrate.

  • true: The audio bitrate is checked.
  • false: The audio bitrate is not checked.
  • Default value: false.
Encryption Object

The encryption configuration. Only outputs in the M3U8 format are supported.

Type String hls-aes-128

The encryption type. Valid value: hls-aes-128.

Key String encryptionkey128

The key that is used to encrypt the video.

KeyType String Base64

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

Note For example, if the key is encryptionkey128, the value can be Base64("encryptionkey128") or KMS(Base64("encryptionkey128"), depending on the encryption method used.
Id String 31fa3c9ca8134f9cec2b4b0b0f78****

The encryption ID.

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

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

SkipCnt String 3

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

WaterMarkList Array of WaterMark

The list of watermarks.

WaterMark
Type String Image

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

  • Image: an image watermark.
  • Text: a text watermark.
ReferPos String TopRight

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

  • TopRight: the upper-right corner.
  • TopLeft: the upper-left corner.
  • BottomRight: the lower-right corner.
  • BottomLeft: the lower-left corner.
Dx String 100

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

  • An integer indicates the pixel value of the horizontal offset.
    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal 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 deleted.
Width String 50

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

  • An integer indicates the pixel value of the watermark width.
    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal indicates the ratio of the watermark width to the width in the output video resolution.
    • Valid values: (0,1).
    • The decimal can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically deleted.
Height String 50

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

  • An integer indicates the pixel value of the watermark height.
    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal indicates the ratio of the watermark height to the height in the output video resolution.
    • Valid values: (0,1).
    • The decimal can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically deleted.
InputFile Object

The watermark input file. You can use an image in the PNG format or a file in the MOV format as the watermark input file.

Object String example-logo-****.png

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

Location String oss-cn-hangzhou

The OSS region in which the input file resides.

Bucket String example-bucket

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

WaterMarkTemplateId String 88c6ca184c0e47098a5b665e2a12****

The ID of the watermark template.

Dy String 100

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

  • An integer indicates the pixel value of the vertical offset.
    • Valid values: [8,4096].
    • Unit: pixel.
  • A decimal indicates the ratio of the vertical offset to the height in the output video resolution.
    • Valid values: (0,1).
    • The decimal can be accurate to four decimal places, such as 0.9999. Excessive digits are automatically deleted.
WaterMarkConfigUrl String http://example.com/configure

The URL of the watermark configuration file.

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

The configuration of watermark blurring. The value must be a JSON object. For more information, see Parameter details.

M3U8NonStandardSupport Object

The non-standard support configuration for M3U8. The value must be a JSON object. For more information, see Parameter details.

TS Object

The non-standard support configuration for M3U8 about TS files. The value must be a JSON object. For more information, see Parameter details.

SizeSupport Boolean true

Indicates whether to support the output of the size of the TS file in the M3U8 file. Valid values:

  • true: supported.
  • false: not supported.
Md5Support Boolean true

Indicates whether to support the output of the md5 value of the TS file in the M3U8 file. Valid values:

  • true: supported.
  • false: not supported.
Priority String 6

The priority of the job in the MPS queue to which the job is added.

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

The audio configuration.

Note If this parameter is specified in the request, the value overwrites the corresponding parameter in the specified transcoding template.
Profile String aaclow

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

Codec String aac

The audio encoding and decoding format.

  • Valid values: aac, mp3, vorbis, and flac.
  • Default value: aac.
Samplerate String 44100

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, you cannot set this parameter to 32000, 48000, or 96000. If the audio codec is MP3, you cannot set this parameter to 96000.
Qscale String 15

The level of quality control on the audio.

Channels String 2

The number of sound channels.

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

The volume configuration.

Method String auto

The volume adjustment method. Valid values:

  • auto: The volume is automatically adjusted.
  • dynamic: The volume is dynamically adjusted.
  • linear: The volume is linearly adjusted.
Level String -20

The volume adjustment range. Default value: -20db.

Bitrate String 128

The audio bitrate of the output file.

  • Unit: Kbit/s.
  • Default value: 128.
AudioStreamMap String 0:a:0

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 you do not specify a sequence number, the default audio stream is used.
MergeList Array of Merge

The merging configuration. A maximum of four URLs can be merged.

Merge
Start String 01:59:59.999

The start point in time of the clip.

  • Format: hh:mm:ss[.SSS] or sssss[.SSS].
  • Examples: 01:59:59.999 and 32000.23.
RoleArn String acs:ram::<your uid>:role/<your role name>

The Alibaba Cloud Resource Name (ARN) of the role used for proxy authorization.

MergeURL String http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv

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.
Duration String 01:59:59.999

The duration of the clip.

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

Indicates that the resolution of the source video is used.

IsHalfSample String true

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

  • true: yes.
  • false: no.
UserData String testid-001

The custom data.

ExtendData String testid-002

The custom fields.

OutSubtitleList Array of OutSubtitle

The output subtitle list.

OutSubtitle
Map String 0:v:0

The video track. Format: 0:{stream}:{stream sequence number}, that 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.

OutSubtitleFile Object

The details of the output file.

RoleArn String acs:ram::<your uid>:role/<your role name>

The ARN of the role used for proxy authorization.

Object String example.flv

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

Location String oss-cn-hangzhou

The ID of the OSS region in which the output file resides.

Bucket String exampleBucket

The OSS bucket in which the output file is stored.

Success Boolean true

Indicates whether the job succeeded. Valid values:

  • true: succeeded.
  • fasle: failed.
Message String The specified parameter "%s" cannot be null.

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

VideoStreamMap String 0

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 you do not set the corresponding parameter in the request, the default video stream is selected.

OutputFile Object

The information about the output file.

RoleArn String acs:ram::<your uid>:role/<your role name>

The ARN of the role used for proxy authorization.

Object String example-output.flv

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

Location String oss-cn-hangzhou

The ID of the OSS region in which the output file resides.

Bucket String example-bucket

The OSS bucket in which the output file is stored.

Rotate String 90

The video rotation angle.

Container Object

The container configuration.

Format String mp4

The format of the container.

  • 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 set to GIF.
  • If the container format is WebP, the video codec must be set to WebP.
  • If the container format is FLV, the video codec cannot be set to H.265.
Clip Object

The information about the media clip.

TimeSpan Object

The time span of the clip.

Seek String 01:59:59.999

The time when the clip starts.

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

Or

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

The duration of the clip.

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

Or

  • Format: sssss[.SSS].
  • Example: 32000.23.
MergeConfigUrl String https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8

The URL of the merging configuration file. You can specify only one of the MergeList and MergeConfigUrl parameters.

  • The file that you specify for the MergeConfigUrl parameter can contain up to 50 merged clips.
  • The MergeConfigUrl parameter specifies 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 mergeConfigfile: {"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}.
OpeningList Array of Opening

The list of opening parts. The value is a JSON object.

Opening
openUrl String http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4

The OSS URL of the opening part of the video.

Start String 0

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

  • The value starts from 0.
  • Unit: seconds.
  • Default value: 0.
Width String -1

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 height of the source of the opening part is retained.
  • A value of full indicates that the width of the main part is used for the opening part.
  • Default value: -1.
Height String -1

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 height of the source of the opening part is retained.
  • A value of full indicates that the height of the main part is used for the opening part.
  • Default value: -1.
MuxConfig Object

The transmuxing configuration. The transmuxing configuration. If this parameter is specified in the request, the value overwrites the corresponding parameter in the specified transcoding template.

Webp Object

The transmuxing configuration for WebP.

Loop String 0

The loop count.

Gif Object

The transmuxing configuration for GIF.

FinalDelay String 0

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

DitherMode String bayer

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

Loop String 0

The loop count.

IsCustomPalette String false

Indicates whether the custom palette is used. Valid values:

  • true: The custom palette is used.
  • false: The custom palette is not used.
Segment Object

The segment configuration. The value is a JSON object.

Duration String 20

The length of the segment. Unit: seconds.

TailSlateList Array of TailSlate

The list of ending parts.

TailSlate
Start String 00000.00

The time at which the ending part is played.

BgColor String White

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 Background colors.

IsMergeAudio Boolean true

Indicates whether to merge the audio content of the ending part. Valid values:

  • true: yes.
  • false: no.
Width String -1

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 width of the source of the ending part is retained.
  • A value of full indicates that the height of the main part is used for the ending part.
  • Default value: -1.
Height String -1

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 height of the source of the ending part is retained.
  • A value of full indicates that the height of the main part is used for the ending part.
  • Default value: -1.
BlendDuration String 0

The amount of time between the end of the main part and the beginning of the ending part. During the video part transition, the last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0.

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

The OSS URL of the ending part.

TemplateId String S00000001-200010

The ID of the template.

SubtitleConfig Object

The subtitle configuration.

ExtSubtitleList Array of ExtSubtitle

The list of external subtitles.

ExtSubtitle
CharEnc String auto

The character set used by the external subtitle.

  • Valid values: UTF-8, GBK, BIG5, and auto.
  • Default value: auto.
Note If you set this parameter to auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.
FontName String "WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"

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

Input Object

The input subtitle file.

  • Files in the SRT or ASS format are supported. For more information, see the part about input parameters in Parameter details.
  • Example: {“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”}.
Object String example-output.flv

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

Location String oss-cn-hangzhou

The ID of the OSS region in which the input file resides.

Bucket String example-bucket-****

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

SubtitleList Array of Subtitle

The list of subtitles.

Subtitle
Map String 0:a:0

The audio track. Format: 0:{stream}:{stream sequence number}, that 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.

Properties Object

The media properties.

Width String 720

The width of the video.

Height String 1280

The length of the video.

SourceLogos Array of SourceLogo

The non-engine layer keywords.

SourceLogo
Source String example

The keyword.

Duration String 17

The duration.

Fps String 30

The frame rate.

Bitrate String 490

The bitrate.

FileFormat String mp4

The format of the input media file.

Streams Object

The media streams contained in the input media file.

VideoStreamList Array of VideoStream

The list of video streams.

VideoStream
Index String 0

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

Timebase String 1/15360

The time base.

AvgFPS String 30.0

The average frame rate.

PixFmt String yuv420p

The pixel format.

Sar String 1:1

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

Lang String eng

The language of the subtitle stream. For more information, see FFmpeg language definition and ISO 639.

CodecLongName String H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10

The full name of the encoding format.

Height String 1280

The height of the video stream in pixels.

NumFrames String 30

The total number of frames.

Bitrate String 421.117

The bitrate.

CodecTagString String avc1

The tag string of the encoding format.

HasBFrames String 2

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

Profile String high

The codec profile.

StartTime String 0.000000

The start time.

NetworkCost Object

The network bandwidth that was consumed.

PreloadTime String 8

The amount of preload time.

AvgBitrate String 300

The average bitrate.

CostBandwidth String 10

The maximum bandwidth that is consumed.

Dar String 9:16

The display aspect ratio (DAR).

CodecName String h264

The short name of the encoding format.

Width String 720

The width of the video in pixels.

Duration String 17.233333

The duration.

Fps String 30.0

The frame rate.

CodecTag String 0x31637661

The tag of the encoding format.

CodecTimeBase String 1/60

The codec time base.

Level String 31

The codec level.

colorTransfer String bt709

The color transfer configuration.

colorPrimaries String bt709

The primary colors.

bitsPerRawSample String 8

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

AudioStreamList Array of AudioStream

The list of audio streams.

AudioStream
Timebase String 1/32000

The time base.

Index String 1

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

SampleFmt String fltp

The sampling format.

ChannelLayout String mono

The output layout of the sound channels.

Lang String und

The language of the subtitle stream. For more information, see FFmpeg language definition and ISO 639.

Samplerate String 32000

The sampling rate.

CodecLongName String AAC (Advanced Audio Coding)

The full name of the encoding format.

Channels String 1

The number of sound channels.

NumFrames String 50

The total number of frames.

Bitrate String 64.136

The bitrate.

CodecTagString String mp4

The tag string of the encoding format.

StartTime String 0.064000

The start time.

CodecName String aac

The short name of the encoding format.

Duration String 17.223562

The duration.

CodecTag String 0x6134706d

The tag of the encoding format.

CodecTimeBase String 1/32000

The codec time base.

SubtitleStreamList Array of SubtitleStream

The list of subtitle streams.

SubtitleStream
Index String 1

The sequence number of the subtitle stream.

This parameter indicates the position of the subtitle stream in all subtitle streams.

Lang String eng

The language of the subtitle stream. For more information, see FFmpeg language definition and ISO 639.

Format Object

The format information.

StartTime String -0.064000

The start time.

NumPrograms String 0

The total number of program streams.

Size String 1057273

The size of the file.

NumStreams String 2

The total number of media streams.

FormatLongName String QuickTime / MOV

The full name of the container format.

Duration String 17.234000

The total duration.

Bitrate String 490.784

The total bitrate.

FormatName String mov

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

FileSize String 1057273

The size of the file.

PipelineId String 88c6ca184c0e47b665e2a1267971****

The ID of the MPS queue.

Input Object

The information about the job input.

Object String video_01.mp4

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

Location String oss-cn-shanghai

The OSS region in which the input file resides.

Bucket String exampleBucket

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

MNSMessageResult Object

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

MessageId String 123

The ID of the success message returned when the job is successful.

ErrorMessage String The resource operated "%s" cannot be found.

The error message that is returned when the job fails. This parameter is not returned if the job is successful.

ErrorCode String InvalidParameter.ResourceNotFound

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

Callback parameters

When the status of the transcoding job changes, MPS sends a message to the specified MNS queue. For more information about how to specify an MNS queue for receiving callbacks, see the UpdatePipeline topic.~~188374~~ The callback message is a JSON string that contains the parameters described in the following table.


{
  "Type": "Transcode",
  "State": "Success",
  "JobId": "39f8e0bc005e4f309379701645f4****",
  "UserData": "{\"key\":\"value\"}",
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642****"
}

Parameter

Type

Description

Type

String

The value is fixed to Transcode, which indicates a transcoding job.

JobId

String

The unique ID of the job.

State

String

The current status of the job. The value is the same as the value of the State parameter returned in the QueryJobList operation.

UserData

String

The user data that was specified for the job in the SubmitJobs operation.

Examples

Sample requests

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QueryJobList
&JobIds=bb558c1cc25b45309aab5be44d19****,d1ce4d3efcb549419193f50f1fcd****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryJobListResponse>
    <NonExistJobIds>d1ce4d3efcb549419193f50f1fcd****</NonExistJobIds>
    <RequestId>197ADF44-104C-514C-9F92-D8924CB34E2A</RequestId>
    <JobList>
        <CreationTime>2014-01-10T12:00:00Z</CreationTime>
        <Percent>100</Percent>
        <FinishTime>2014-01-10T12:20:25Z</FinishTime>
        <State>TranscodeSuccess</State>
        <JobId>31fa3c9ca8134fb4b0b0f7878301****</JobId>
        <Code>InvalidParameter.NullValue</Code>
        <Message>The specified parameter "%s" cannot be null.</Message>
        <Output>
            <Video>
                <Bufsize>6000</Bufsize>
                <Degrain>5</Degrain>
                <BitrateBnd>
                    <Max>1000</Max>
                    <Min>300</Min>
                </BitrateBnd>
                <PixFmt>yuv420p</PixFmt>
                <Pad>1280:800:0:140</Pad>
                <Codec>H.264</Codec>
                <Height>720</Height>
                <Qscale>15</Qscale>
                <Crop>1280:800:0:140</Crop>
                <Bitrate>500</Bitrate>
                <Maxrate>3000</Maxrate>
                <MaxFps>60</MaxFps>
                <Profile>high</Profile>
                <Crf>26</Crf>
                <Gop>250</Gop>
                <Width>1280</Width>
                <Fps>25</Fps>
                <Preset>medium</Preset>
                <ScanMode>interlaced</ScanMode>
                <ResoPriority>1</ResoPriority>
            </Video>
            <TransConfig>
                <IsCheckAudioBitrate>false</IsCheckAudioBitrate>
                <TransMode>onepass</TransMode>
                <IsCheckReso>false</IsCheckReso>
                <IsCheckVideoBitrateFail>false</IsCheckVideoBitrateFail>
                <AdjDarMethod>none</AdjDarMethod>
                <IsCheckVideoBitrate>false</IsCheckVideoBitrate>
                <IsCheckResoFail>false</IsCheckResoFail>
                <IsCheckAudioBitrateFail>false</IsCheckAudioBitrateFail>
            </TransConfig>
            <Encryption>
                <Type>hls-aes-128</Type>
                <Key>encryptionkey128</Key>
                <KeyType>Base64</KeyType>
                <Id>31fa3c9ca8134f9cec2b4b0b0f78****</Id>
                <KeyUri>https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/</KeyUri>
                <SkipCnt>3</SkipCnt>
            </Encryption>
            <WaterMarkList>
                <Type>Image</Type>
                <ReferPos>TopRight</ReferPos>
                <Dx>100</Dx>
                <Width>50</Width>
                <Height>50</Height>
                <InputFile>
                    <Object>example-logo-****.png</Object>
                    <Location>oss-cn-hangzhou</Location>
                    <Bucket>example-bucket</Bucket>
                </InputFile>
                <WaterMarkTemplateId>88c6ca184c0e47098a5b665e2a12****</WaterMarkTemplateId>
                <Dy>100</Dy>
            </WaterMarkList>
            <WaterMarkConfigUrl>http://example.com/configure</WaterMarkConfigUrl>
            <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}]}</DeWatermark>
            <M3U8NonStandardSupport>
                <TS>
                    <SizeSupport>true</SizeSupport>
                    <Md5Support>true</Md5Support>
                </TS>
            </M3U8NonStandardSupport>
            <Priority>6</Priority>
            <Audio>
                <Profile>aaclow</Profile>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Qscale>15</Qscale>
                <Channels>2</Channels>
                <Volume>
                    <Method>auto</Method>
                    <Level>-20</Level>
                </Volume>
                <Bitrate>128</Bitrate>
            </Audio>
            <AudioStreamMap>0:a:0</AudioStreamMap>
            <MergeList>
                <Start>01:59:59.999</Start>
                <RoleArn>acs:ram::&lt;your uid&gt;:role/&lt;your role name&gt;</RoleArn>
                <MergeURL>http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv</MergeURL>
                <Duration>01:59:59.999</Duration>
            </MergeList>
            <SuperReso>
                <IsHalfSample>true</IsHalfSample>
            </SuperReso>
            <UserData>testid-001</UserData>
            <ExtendData>testid-002</ExtendData>
            <OutSubtitleList>
                <Map>0:v:0</Map>
                <OutSubtitleFile>
                    <RoleArn>acs:ram::&lt;your uid&gt;:role/&lt;your role name&gt;</RoleArn>
                    <Object>example.flv</Object>
                    <Location>oss-cn-hangzhou</Location>
                    <Bucket>exampleBucket</Bucket>
                </OutSubtitleFile>
                <Success>true</Success>
                <Message>The specified parameter "%s" cannot be null.</Message>
            </OutSubtitleList>
            <VideoStreamMap>0</VideoStreamMap>
            <OutputFile>
                <RoleArn>acs:ram::&lt;your uid&gt;:role/&lt;your role name&gt;</RoleArn>
                <Object>example-output.flv</Object>
                <Location>oss-cn-hangzhou</Location>
                <Bucket>example-bucket</Bucket>
            </OutputFile>
            <Rotate>90</Rotate>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Clip>
                <TimeSpan>
                    <Seek>01:59:59.999</Seek>
                    <Duration>01:00:59.999</Duration>
                </TimeSpan>
            </Clip>
            <MergeConfigUrl>https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8</MergeConfigUrl>
            <OpeningList>
                <openUrl>http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4</openUrl>
                <Start>0</Start>
                <Width>-1</Width>
                <Height>-1</Height>
            </OpeningList>
            <MuxConfig>
                <Webp>
                    <Loop>0</Loop>
                </Webp>
                <Gif>
                    <FinalDelay>0</FinalDelay>
                    <DitherMode>bayer</DitherMode>
                    <Loop>0</Loop>
                    <IsCustomPalette>false</IsCustomPalette>
                </Gif>
                <Segment>
                    <Duration>20</Duration>
                </Segment>
            </MuxConfig>
            <TailSlateList>
                <Start>00000.00</Start>
                <BgColor>White</BgColor>
                <IsMergeAudio>true</IsMergeAudio>
                <Width>-1</Width>
                <Height>-1</Height>
                <BlendDuration>0</BlendDuration>
                <TailUrl>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv</TailUrl>
            </TailSlateList>
            <TemplateId>S00000001-200010</TemplateId>
            <SubtitleConfig>
                <ExtSubtitleList>
                    <CharEnc>auto</CharEnc>
                    <FontName>"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"</FontName>
                    <Input>
                        <Object>example-output.flv</Object>
                        <Location>oss-cn-hangzhou</Location>
                        <Bucket>example-bucket-****</Bucket>
                    </Input>
                </ExtSubtitleList>
                <SubtitleList>
                    <Map>0:a:0</Map>
                </SubtitleList>
            </SubtitleConfig>
            <Properties>
                <Width>720</Width>
                <Height>1280</Height>
                <SourceLogos>
                    <Source>example</Source>
                </SourceLogos>
                <Duration>17</Duration>
                <Fps>30</Fps>
                <Bitrate>490</Bitrate>
                <FileFormat>mp4</FileFormat>
                <Streams>
                    <VideoStreamList>
                        <Index>0</Index>
                        <Timebase>1/15360</Timebase>
                        <AvgFPS>30.0</AvgFPS>
                        <PixFmt>yuv420p</PixFmt>
                        <Sar>1:1</Sar>
                        <Lang>eng</Lang>
                        <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>
                        <Height>1280</Height>
                        <NumFrames>30</NumFrames>
                        <Bitrate>421.117</Bitrate>
                        <CodecTagString>avc1</CodecTagString>
                        <HasBFrames>2</HasBFrames>
                        <Profile>high</Profile>
                        <StartTime>0.000000</StartTime>
                        <NetworkCost>
                            <PreloadTime>8</PreloadTime>
                            <AvgBitrate>300</AvgBitrate>
                            <CostBandwidth>10</CostBandwidth>
                        </NetworkCost>
                        <Dar>9:16</Dar>
                        <CodecName>h264</CodecName>
                        <Width>720</Width>
                        <Duration>17.233333</Duration>
                        <Fps>30.0</Fps>
                        <CodecTag>0x31637661</CodecTag>
                        <CodecTimeBase>1/60</CodecTimeBase>
                        <Level>31</Level>
                        <colorTransfer>bt709</colorTransfer>
                        <colorPrimaries>bt709</colorPrimaries>
                        <bitsPerRawSample>8</bitsPerRawSample>
                    </VideoStreamList>
                    <AudioStreamList>
                        <Timebase>1/32000</Timebase>
                        <Index>1</Index>
                        <SampleFmt>fltp</SampleFmt>
                        <ChannelLayout>mono</ChannelLayout>
                        <Lang>und</Lang>
                        <Samplerate>32000</Samplerate>
                        <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>
                        <Channels>1</Channels>
                        <NumFrames>50</NumFrames>
                        <Bitrate>64.136</Bitrate>
                        <CodecTagString>mp4</CodecTagString>
                        <StartTime>0.064000</StartTime>
                        <CodecName>aac</CodecName>
                        <Duration>17.223562</Duration>
                        <CodecTag>0x6134706d</CodecTag>
                        <CodecTimeBase>1/32000</CodecTimeBase>
                    </AudioStreamList>
                    <SubtitleStreamList>
                        <Index>1</Index>
                        <Lang>eng</Lang>
                    </SubtitleStreamList>
                </Streams>
                <Format>
                    <StartTime>-0.064000</StartTime>
                    <NumPrograms>0</NumPrograms>
                    <Size>1057273</Size>
                    <NumStreams>2</NumStreams>
                    <FormatLongName>QuickTime / MOV</FormatLongName>
                    <Duration>17.234000</Duration>
                    <Bitrate>490.784</Bitrate>
                    <FormatName>mov</FormatName>
                </Format>
                <FileSize>1057273</FileSize>
            </Properties>
        </Output>
        <PipelineId>88c6ca184c0e47b665e2a1267971****</PipelineId>
        <Input>
            <Object>video_01.mp4</Object>
            <Location>oss-cn-shanghai</Location>
            <Bucket>exampleBucket</Bucket>
        </Input>
        <MNSMessageResult>
            <MessageId>123</MessageId>
            <ErrorMessage>The resource operated "%s" cannot be found.</ErrorMessage>
            <ErrorCode>InvalidParameter.ResourceNotFound</ErrorCode>
        </MNSMessageResult>
    </JobList>
</QueryJobListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NonExistJobIds" : [ "d1ce4d3efcb549419193f50f1fcd****" ],
  "RequestId" : "197ADF44-104C-514C-9F92-D8924CB34E2A",
  "JobList" : [ {
    "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" : [ {
        "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" : [ {
        "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" : [ {
        "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" : [ {
        "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" : [ {
        "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" : [ {
          "CharEnc" : "auto",
          "FontName" : "\"WenQuanYi Zen Hei\", \"Yuanti SC Regular\", \"SimSun\"",
          "Input" : {
            "Object" : "example-output.flv",
            "Location" : "oss-cn-hangzhou",
            "Bucket" : "example-bucket-****"
          }
        } ],
        "SubtitleList" : [ {
          "Map" : "0:a:0"
        } ]
      },
      "Properties" : {
        "Width" : "720",
        "Height" : "1280",
        "SourceLogos" : [ {
          "Source" : "example"
        } ],
        "Duration" : "17",
        "Fps" : "30",
        "Bitrate" : "490",
        "FileFormat" : "mp4",
        "Streams" : {
          "VideoStreamList" : [ {
            "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" : [ {
            "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" : [ {
            "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"
      }
    },
    "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"
    }
  } ]
}

Error codes

For a list of error codes, see Service error codes.