QueryJobList-阿里云帮助中心

Queries transcoding jobs in batches by job IDs.

Operation description

This operation can query up to 10 transcoding jobs at a time.
If you do not specify JobIds, the InvalidParameter error code is returned.

QPS limit

The QPS limit for a single user is 100 queries per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make API calls at a reasonable rate. For more information, see QPS limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:QueryJobList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The IDs of the transcoding jobs. You can specify up to 10 IDs at a time. Separate multiple IDs with commas (,). You can obtain the IDs from the MPS console by choosing Job Management, or from the response parameters of the Submit a transcoding job operation. Note If you do not specify this parameter, the `InvalidParameter` error code is returned.	bb558c1cc25b45309aab5be44d19**,d1ce4d3efcb549419193f50f1fcd**

Response elements

Element	Type	Description	Example
	object	The response parameters.
NonExistJobIds	object
String	array	The IDs of the jobs that do not exist.
	string	The list of IDs of the transcoding jobs that do not exist. This structure is not returned if no data is available.	d1ce4d3efcb549419193f50f1fcd****
RequestId	string	The request ID.	197ADF44-104C-514C-9F92-D8924CB34E2A
JobList	object
Job	array<object>	The collection of transcoding jobs.
	array<object>	The details of the transcoding job.
CreationTime	string	The time when the job was added. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format.	2014-01-10T12:00:00Z
Percent	integer	The transcoding progress.	100
FinishTime	string	The time when the job was completed. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format.	2014-01-10T12:20:25Z
State	string	The job status. Valid values: Submitted: The job is submitted. Transcoding: The job is being transcoded. TranscodeSuccess: The transcoding is successful. TranscodeFail: The transcoding failed. TranscodeCancelled: The transcoding is canceled.	TranscodeSuccess
JobId	string	The job ID.	31fa3c9ca8134fb4b0b0f7878301****
Code	string	The error code returned when the job fails. This parameter is not returned if the job is successful.	InvalidParameter.NullValue
Message	string	The error message returned when the job fails. This parameter is not returned if the job is successful.	The specified parameter "%s" cannot be null.
Output	object	The job output.
Video	object	The video configurations.
Bufsize	string	The buffer size. Unit: Kb. Default value: 6000.	6000
Degrain	string	The strength of the independent denoising algorithm.	5
BitrateBnd	object	The range of the average video bitrate.
Max	string	The maximum bitrate.	1000
Min	string	The minimum bitrate.	300
PixFmt	string	The video color format. Valid values: standard color formats such as yuv420p and yuvj420p.	yuv420p
Pad	string	The black borders added to the video. Unit: px. Parameter format: width:height:left:top.	1280:800:0:140
Codec	string	The encoding format. Valid values: H.264 and H.265. Default value: H.264.	H.264
Height	string	The height. Unit: px. Default value: the original height of the video.	720
Qscale	string	The video quality control factor.	15
Crop	string	The video cropping settings. Two cropping methods are supported: Automatic detection and cropping of black borders. Set this parameter to border. Custom cropping. The parameter format is width:height:left:top.	1280:800:0:140
Bitrate	string	The average video bitrate. Unit: Kbit/s.	500
Maxrate	string	The peak video bitrate. Unit: Kbit/s.	3000
MaxFps	string	The maximum frame rate.	60
Profile	string	The encoding profile. Valid values: baseline, main, and high. Note If you have multiple resolutions, set the profile of the lowest resolution to baseline to ensure playback on low-end devices. Set the profiles of other resolutions to main or high. baseline: for mobile devices. main: for standard-resolution devices. high: for high-resolution devices. Default value: high.	high
Crf	string	The constant rate factor (CRF) for bitrate and quality control. Default value: When the encoding format is H.264, the default value is 23. When the encoding format is H.265, the default value is 26. If Crf is specified, the Bitrate setting becomes invalid.	26
Gop	string	The maximum time interval or maximum number of frames between keyframes. Unit: seconds. Default value: 250. No unit is used when this parameter specifies the maximum number of frames.	250
Width	string	The width. Unit: px. Default value: the original width of the video.	1280
Fps	string	The frame rate. Unit: fps. If the frame rate of the input file exceeds 60 fps, the value 60 is used. Default value: the frame rate of the input file.	25
Preset	string	The video algorithm preset. Default value: medium. Valid values: veryfast: ultra-fast. fast: fast. medium: medium. slow: slow. slower: ultra-slow.	medium
ScanMode	string	The scan mode. Valid values: Not set: The original mode of the input file is used. auto: automatic deinterlacing. progressive: progressive scan. interlaced: interlaced scan. Default value: empty, which means not set. Best practices: Interlaced scan saves more bandwidth than progressive scan, but the image quality is poor. Therefore, progressive scan is widely used in mainstream video production. If you set progressive scan or interlaced scan that does not match the original raw mode, the transcoding fails. Set this parameter to the original raw mode or automatic deinterlacing to improve compatibility.	interlaced
ResoPriority	string	The resource priority.	1
TransConfig	object	The general transcoding configurations. Note If this value is specified in the request parameters, it overwrites the corresponding parameter in the specified transcoding template.
IsCheckAudioBitrate	string	Specifies whether to check the audio bitrate. If the output audio bitrate is greater than the audio bitrate of the media source, the output audio bitrate is considered equal to the audio bitrate of the media source, and the configured audio bitrate parameter does not take effect. The priority of this parameter is lower than that of IsCheckAudioBitrateFail. true: The audio bitrate is checked. false: The audio bitrate is not checked. Default value: If this parameter is left empty and the codec is different from that of the input source: false. If this parameter is left empty and the codec is the same as that of the input source: true.	false
TransMode	string	The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: onepass.	onepass
IsCheckReso	string	Specifies whether to check the resolution. If the output resolution is greater than the input resolution in width or height, the output resolution is considered equal to the input resolution. true: The resolution is checked. false: The resolution is not checked. Default value: false.	false
IsCheckVideoBitrateFail	string	Specifies whether to check the bitrate. If the output video bitrate is greater than the video bitrate of the media source, the transcoding is not performed and a transcoding failure is returned. The priority of this parameter is higher than that of IsCheckVideoBitrate. true: The bitrate is checked. false: The bitrate is not checked. Default value: false.	false
AdjDarMethod	string	The resolution adjustment method. Default value: none. Valid values: rescale, crop, pad, and none.	none
IsCheckVideoBitrate	string	Specifies whether to check the video bitrate. If the output video bitrate is greater than the input video bitrate, the output video bitrate is considered equal to the input video bitrate. true: The video bitrate is checked. false: The video bitrate is not checked. Default value: false.	false
IsCheckResoFail	string	Specifies whether to check the resolution. If the output resolution is greater than the input resolution in width or height, a transcoding failure is returned. true: The resolution is checked. false: The resolution is not checked. Default value: false.	false
IsCheckAudioBitrateFail	string	Specifies whether to check the audio bitrate. If the output audio bitrate is greater than the audio bitrate of the media source, the transcoding is not performed and a transcoding failure is returned. The priority of this parameter is higher than that of IsCheckAudioBitrate. true: The audio bitrate is checked. false: The audio bitrate is not checked. Default value: false.	false
Encryption	object	The data encryption settings. Only output in M3U8 format is supported.
Type	string	The encryption type. Valid value: hls-aes-128.	hls-aes-128
Key	string	The key used to encrypt the video.	encryptionkey128
KeyType	string	The key encryption method. Valid values: Base64 and KMS. Note For example, if the key is `"encryptionkey128"`, the value is `Base64("encryptionkey128")` or `KMS(Base64("encryptionkey128"))`.	Base64
Id	string	The encryption ID.	31fa3c9ca8134f9cec2b4b0b0f78****
KeyUri	string	The access URL of the key, which is Base64-encoded.	https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/
SkipCnt	string	The number of initial segments that are not encrypted. This allows the video to start playing quickly.	3
WaterMarkList	object
WaterMark	array<object>	The watermark list.
	array<object>	The watermark details.
Type	string	The watermark type. If this parameter is specified in the request parameters, it overwrites the corresponding parameter in the watermark template. For more information, see Parameter details. Valid values: Image: image watermark. Text: text watermark.	Image
ReferPos	string	The position of the watermark. If this value is specified in the request parameters, it overwrites the corresponding parameter in the watermark template. Valid values: TopRight: upper right. TopLeft: upper left. BottomRight: lower right. BottomLeft: lower left.	TopRight
Dx	string	The horizontal offset of the watermark image relative to the output video. If this value is specified in the request parameters, it overwrites the corresponding parameter in the watermark template. Default value: 0. The value can be in one of the following formats: Integer: the offset in pixels. Valid values: [8,4096]. Unit: px. Decimal: the ratio of the horizontal offset to the width of the output resolution. Valid values: (0,1). Up to four decimal places are supported, such as 0.9999. Excess decimal places are automatically discarded.	100
Width	string	The width of the watermark image. If this value is specified in the request parameters, it overwrites the width of the watermark image in the watermark template. The value can be in one of the following formats: Integer: the width of the watermark image in pixels. Valid values: [8,4096]. Unit: px. Decimal: the ratio of the watermark image width to the width of the output video resolution. Valid values: (0,1). Up to four decimal places are supported, such as 0.9999. Excess decimal places are automatically discarded.	50
Height	string	The height of the watermark image. If this value is specified in the request parameters, it overwrites the height of the watermark image in the watermark template. The value can be in one of the following formats: Integer: the height of the watermark image in pixels. Valid values: [8,4096]. Unit: px. Decimal: the ratio of the watermark image height to the height of the output video resolution. Valid values: (0,1). Up to four decimal places are supported, such as 0.9999. Excess decimal places are automatically discarded.	50
InputFile	object	The input file for the watermark. PNG images and MOV files are supported as input files.
Object	string	The OSS object of the input file.	example-logo-****.png
Location	string	The OSS location of the input file.	oss-cn-hangzhou
Bucket	string	The OSS bucket of the input file.	example-bucket
WaterMarkTemplateId	string	The watermark template ID.	88c6ca184c0e47098a5b665e2a12****
Dy	string	The vertical offset of the watermark image relative to the output video. If this value is specified in the request parameters, it overwrites the vertical offset of the watermark image relative to the output video in the watermark template. The value can be in one of the following formats: Integer: the vertical offset of the watermark image relative to the output video in pixels. Valid values: [8,4096]. Unit: px. Decimal: the ratio of the vertical offset of the watermark image relative to the output video. Valid values: (0,1). Up to four decimal places are supported, such as 0.9999. Excess decimal places are automatically discarded.	100
WaterMarkConfigUrl	string	The URL of the watermark configuration file.	http://example.com/configure
DeWatermark	string	The blurring settings. This is a JSON object. For more information, see the blurring details in Parameter details.	{"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	object	The non-standard M3U8 support settings. This is a JSON object. For more information, see the non-standard M3U8 parameter support details in Parameter details.
TS	object	The non-standard support settings for TS files. This is a JSON object. For more information, see the TS parameter support details in Parameter details.
SizeSupport	boolean	Specifies whether to support outputting the size of the TS file in the M3U8 file. Valid values: true: Supported. false: Not supported.	true
Md5Support	boolean	Specifies whether to support outputting the MD5 hash value of the TS file in the M3U8 file. Valid values: true: Supported. false: Not supported.	true
Priority	string	The priority of the job in its corresponding MPS queue. Highest priority: 10. Default value: 6.	6
Audio	object	The audio configurations. Note If the audio configurations are specified in the request parameters, they overwrite the corresponding parameters in the specified transcoding template.
Profile	string	The audio encoding preset. When Codec is set to aac, valid values are aaclow, aache, aachev2, aacld, and aaceld.	aaclow
Codec	string	The audio encoding format. Valid values: aac, mp3, vorbis, and flac. Default value: aac.	aac
Samplerate	string	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 encoding format is MP3, the sampling rates 32000, 48000, and 96000 are not supported. If the audio encoding format is MP3, the sampling rate 96000 is not supported.	44100
Qscale	string	The audio quality control factor.	15
Channels	string	The number of sound channels. Valid values: 1, 2, 3, 4, 5, 6, 7, and 8. Default value: 2.	2
Volume	object	The volume configurations.
Method	string	The volume adjustment method. Valid values: auto: Automatic adjustment. dynamic: Dynamic adjustment. linear: Linear adjustment.	auto
Level	string	The volume adjustment level. Default value: -20db.	-20
Bitrate	string	The audio bitrate of the output file. Unit: Kbps. Default value: 128.	128
AudioStreamMap	string	The index of the audio stream. Format: 0:a:{index}. Example: 0:a:0. The index indicates the subscript of the audio stream in the audio stream list. The index starts from 0. If this parameter is not specified, the default audio stream is selected.	0:a:0
MergeList	object
Merge	array<object>	The concatenation settings. A maximum of four MergeURLs are supported.
	object	The concatenation details.
Start	string	The start time. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Example: 01:59:59.999 or 32000.23.	01:59:59.999
RoleArn	string	The role information used for authorization.	acs:ram:::role/
MergeURL	string	The URL of the clip to be concatenated. Example: `http://example-bucket-.oss-cn-hangzhou.aliyuncs.com/example-object.flv`. The object name must be URL-encoded in UTF-8. For more information, see URL encoding.	http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv
Duration	string	The duration. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Example: 01:59:59.999 or 32000.23.	01:59:59.999
SuperReso	object	The resolution follows the source.
IsHalfSample	string	Specifies whether to obtain sampling rate-related parameters. Valid values: true: Yes. false: No.	true
UserData	string	The custom user data.	testid-001
ExtendData	string	The custom extended fields.	testid-002
OutSubtitleList	object
OutSubtitle	array<object>	The list of output captions.
	array<object>	The output caption details.
Map	string	The video track. Format: `0:{stream}:{stream_index}`, which is `0:v:{video_index}`. The stream value is v for video streams. The index indicates the subscript of the video stream in the video stream list. The index starts from 0.	0:v:0
OutSubtitleFile	object	The output file details.
RoleArn	string	The role information used for authorization.	acs:ram:::role/
Object	string	The OSS object of the output file.	example.flv
Location	string	The OSS location of the output file.	oss-cn-hangzhou
Bucket	string	The OSS bucket of the output file.	exampleBucket
Success	boolean	Indicates whether the operation is successful. Valid values: true: Successful. false: Failed.	true
Message	string	The error message returned when the job fails to be created. This parameter is not returned when the job is created.	The specified parameter “%s” cannot be null.
VideoStreamMap	string	The index of the video stream. The index starts from 0 and indicates the subscript of the video stream in the video stream list. If this parameter is not specified, the default video stream is selected.	0
OutputFile	object	The output file.
RoleArn	string	The role information used for authorization.	acs:ram:::role/
Object	string	The OSS object of the output file.	example-output.flv
Location	string	The OSS location of the output file.	oss-cn-hangzhou
Bucket	string	The OSS bucket of the output file.	example-bucket
Rotate	string	The video rotation angle.	90
Container	object	The container.
Format	string	The container format. Default value: mp4. Valid values for video transcoding: flv, mp4, HLS (m3u8+ts), and MPEG-DASH (MPD+fMP4). Valid values for audio transcoding: mp3, mp4, ogg, flac, and m4a. Valid values for images: gif and WEBP. If the container format is gif, the VideoCodec parameter must be set to GIF. If the container format is webp, the VideoCodec parameter must be set to WEBP. If the container format is flv, the VideoCodec parameter cannot be set to H265.	mp4
Clip	object	The clip.
TimeSpan	object	The time span of the clip.
Seek	string	The start time. Format: `hh:mm:ss[.SSS]`. Example: 01:59:59.999. Or: Format: `sssss[.SSS]`. Example: 32000.23.	01:59:59.999
Duration	string	The duration. Format: `hh:mm:ss[.SSS]`. Example: 01:00:59.999. Or: Format: `sssss[.SSS]`. Example: 32000.23.	01:00:59.999
MergeConfigUrl	string	The URL of the concatenation configuration file. You can specify either MergeList or MergeConfigUrl. The configuration file specified by MergeConfigUrl supports a maximum of 50 clips. MergeConfigUrl is the URL of the concatenation configuration file. Only configuration files stored in OSS are supported, and you must ensure that MPS has the authorization and access permissions. For more information about the file content, see the concatenation parameter details. Example of the file content: `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`.	https://ceshi-***.oss-cn-shanghai.aliyuncs.com/ccc/p0903q9wkkb.m3u8
OpeningList	object
Opening	array<object>	The opening list. The value is a JSON object.
	object	The opening details.
openUrl	string	The OSS URL of the opening video.	http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4
Start	string	The start time relative to the main video. The delay before the opening video is displayed, starting from 0. Unit: seconds. Default value: 0.	0
Width	string	The width. Valid values: (0, 4096), 1, and full. -1 indicates the value of the source video. full indicates that the screen is filled. Default value: -1.	-1
Height	string	The height. Valid values: (0, 4096), -1, and full. -1 indicates the value of the source video. full indicates that the screen is filled. Default value: -1.	-1
MuxConfig	object	The transcoding muxing settings. If this parameter is set in the request parameters, it overwrites the corresponding parameter in the specified transcoding template.
Webp	object	The muxing configuration for WebP.
Loop	string	The number of loops.	0
Gif	object	The muxing configuration for GIF.
FinalDelay	string	The pause time of the last frame. Unit: centiseconds.	0
DitherMode	string	The color dithering method for the palette. Valid values: sierra and bayer.	bayer
Loop	string	The number of loops.	0
IsCustomPalette	string	Specifies whether to use a custom palette. Valid values: true: Custom. false: Non-custom.	false
Segment	object	The segment configuration. The value is a JSON object.
Duration	string	The segment duration. Unit: seconds.	20
TailSlateList	object
TailSlate	array<object>	The tail slate list.
	object	The tail slate details.
Start	string	The start time of the tail slate video.	00000.00
BgColor	string	The background color used to fill the blank space when the width and height of the tail slate video are smaller than those of the main video. Default value: White. For valid values, see bgcolor.	White
IsMergeAudio	boolean	Specifies whether to concatenate the audio content of the tail slate video. Valid values: true: Concatenate. false: Do not concatenate.	true
Width	string	The width. Valid values: (0, 4096), -1, and full. -1 indicates the value of the source video. full indicates that the screen is filled. Default value: -1.	-1
Height	string	The height. Valid values: (0, 4096), -1, and full. -1 indicates the value of the source video. full indicates that the screen is filled. Default value: -1.	-1
BlendDuration	string	The duration of the transition between the main video and the tail slate video. The transition effect is fade-in and fade-out: the last frame of the main video is displayed while the tail slate video is played. The last frame of the main video gradually darkens, and the tail slate video gradually brightens. Unit: seconds. Default value: 0.	0
TailUrl	string	The OSS URL of the tail slate video.	http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
TemplateId	string	The template ID.	S00000001-200010
SubtitleConfig	object	The caption configuration.
ExtSubtitleList	object
ExtSubtitle	array<object>	The list of external captions.
	array<object>	The caption details.
CharEnc	string	The character encoding of the external captions. Valid values: UTF-8, GBK, BIG5, and auto. Default value: auto. Note When the character encoding of the external captions is set to auto, false detection may occur. Specify a specific character encoding.	auto
FontName	string	The font name used when external captions are converted to hard-coded captions. Default value: SimSum. For more information, see Font list.	"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"
Input	object	The external input caption file. Supported formats: srt and ass. For more information, see the Input parameter in Parameter details. Example: `{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"}`.
Object	string	The OSS object of the input file.	example-output.flv
Location	string	The OSS location of the input file.	oss-cn-hangzhou
Bucket	string	The OSS bucket of the input file.	example-bucket-****
SubtitleList	object
Subtitle	array<object>	The caption list.
	object	The caption details.
Map	string	The audio track. Format: `0:{stream}:{stream_index}`, which is `0:a:{audio_index}`. The stream value is a for audio streams. The index indicates the subscript of the audio stream in the audio stream list. The index starts from 0.	0:a:0
Properties	object	The media properties.
Width	string	The video width.	720
Height	string	The video height.	1280
SourceLogos	object
SourceLogo	array<object>	The keywords at the non-engine layer.
	object	The detailed information about the keyword.
Source	string	The keyword.	example
Duration	string	The duration.	17
Fps	string	The frame rate.	30
Bitrate	string	The bitrate.	490
FileFormat	string	The file format.	mp4
Streams	object	The stream information.
VideoStreamList	object
VideoStream	array<object>	The list of video streams.
	array<object>	The detailed information about the video stream.
Index	string	The index of the video stream, which identifies the position of the video stream in all media streams.	0
Timebase	string	The time base.	1/15360
AvgFPS	string	The average frame rate.	30.0
PixFmt	string	The pixel format.	yuv420p
Sar	string	The sample aspect ratio.	1:1
Lang	string	The language. For more information, see FFmpeg language definitions and ISO-639.	eng
CodecLongName	string	The long name of the encoding format.	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Height	string	The height of the video resolution.	1280
NumFrames	string	The total number of frames.	30
Bitrate	string	The bitrate.	421.117
CodecTagString	string	The text of the encoding format mark.	avc1
HasBFrames	string	Indicates whether the video stream contains B-frames.	2
Profile	string	The encoding profile.	high
StartTime	string	The start time.	0.000000
NetworkCost	object	The network bandwidth consumption.
PreloadTime	string	The preload time.	8
AvgBitrate	string	The average bitrate.	300
CostBandwidth	string	The maximum consumed bandwidth.	10
Dar	string	The display aspect ratio.	9:16
CodecName	string	The short name of the encoding format.	h264
Width	string	The width of the video resolution.	720
Duration	string	The duration.	17.233333
Fps	string	The frame rate.	30.0
CodecTag	string	The encoding format mark.	0x31637661
CodecTimeBase	string	The codec time base.	1/60
Level	string	The encoding level.	31
colorTransfer	string	The color transfer.	bt709
colorPrimaries	string	The color primaries.	bt709
bitsPerRawSample	string	The number of bits used per sample or pixel.	8
AudioStreamList	object
AudioStream	array<object>	The list of audio streams.
	object	The detailed information about the audio stream.
Timebase	string	The time base.	1/32000
Index	string	The index of the audio stream, which identifies the position of the audio stream in all media streams.	1
SampleFmt	string	The sample format.	fltp
ChannelLayout	string	The channel layout.	mono
Lang	string	The language. For more information, see FFmpeg language definitions and ISO-639.	und
Samplerate	string	The sample rate.	32000
CodecLongName	string	The long name of the encoding format.	AAC (Advanced Audio Coding)
Channels	string	The number of channels.	1
NumFrames	string	The total number of frames.	50
Bitrate	string	The bitrate.	64.136
CodecTagString	string	The text of the encoding format mark.	mp4
StartTime	string	The start time.	0.064000
CodecName	string	The short name of the encoding format.	aac
Duration	string	The duration.	17.223562
CodecTag	string	The encoding format mark.	0x6134706d
CodecTimeBase	string	The codec time base.	1/32000
SubtitleStreamList	object
SubtitleStream	array<object>	The list of caption streams.
	object	The detailed information about the caption stream.
Index	string	The index of the caption stream. It identifies the position of the caption stream in all media streams.	1
Lang	string	The language. For more information, see FFmpeg language definitions and ISO-639.	eng
Format	object	The format information.
StartTime	string	The start time.	-0.064000
NumPrograms	string	The total number of program streams.	0
Size	string	The file size.	1057273
NumStreams	string	The total number of media streams.	2
FormatLongName	string	The long name of the container or packaging format.	QuickTime / MOV
Duration	string	The total duration.	17.234000
Bitrate	string	The total bitrate.	490.784
FormatName	string	The short name of the container or packaging format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov
FileMd5	string	The MD5 checksum of the output file.	ad195fd1317a761d4425232867759d1e
FileSize	string	The file size.	1057273
MultiSpeedInfo	object	The information about the accelerated job. This information is available only for jobs submitted through an accelerated MPS queue and is not available for legacy accelerated jobs.
Enable	string	Indicates whether the acceleration feature is enabled.	true
Code	string	The error code, which is returned when the acceleration feature is not actually enabled.	Boost.NotNeedSpeed
Message	string	The error message, which is returned when the acceleration feature is not actually enabled.	success
SettingSpeed	integer	The configured speed.	30
DowngradePolicy	string	The downgrade policy when acceleration is not supported.	NormalSpeed
RealSpeed	number	The actual acceleration speed.	6.576886940181647
Duration	number	The duration of the output video.	21.0
TimeCost	number	The time consumed by the job.	3.193
PipelineId	string	The ID of the MPS queue.	88c6ca184c0e47b665e2a1267971****
Input	object	The job input.
Object	string	The OSS object of the input file.	video_01.mp4
Location	string	The OSS location of the input file.	oss-cn-shanghai
Bucket	string	The OSS bucket of the input file.	exampleBucket
MNSMessageResult	object	The result of the MNS message sent to notify the user of job completion.
MessageId	string	The ID of the message returned upon success.	123
ErrorMessage	string	The error message returned upon failure. This parameter is not returned if the execution is successful.	The resource operated “%s” cannot be found.
ErrorCode	string	The error code returned upon failure. This parameter is not returned if the execution is successful.	InvalidParameter.ResourceNotFound
SubmitTime	string	The time when the job is dequeued and submitted for execution. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format.	2021-03-04T06:44:43Z

Callback message format

When the execution status of a transcoding job changes, MPS sends a message to the user-specified queue. For more information about how to specify a callback queue, see UpdatePipeline. The message body is a JSON string that contains the following fields:

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

Name	Type	Description
Type	String	The fixed string "Transcode", which indicates a transcoding job.
JobId	String	The unique ID of the job.
State	String	The current status of the job, which is the same as the State value returned by QueryJobList.
UserData	String	The user data passed in the SubmitJobs operation.

Examples

Success response

JSON format

{
  "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:::role/",
                "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:::role/",
                  "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:::role/",
            "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"
            },
            "FileMd5": "ad195fd1317a761d4425232867759d1e",
            "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.