Use the QueryJobList API to query transcoding jobs by job ID - ApsaraVideo Media Processing

You can query multiple transcoding jobs by their IDs.

Operation description

This API lets you query a maximum of 10 transcoding jobs at a time.
If you do not provide JobIds, the system returns the InvalidParameter error code.

QPS limits

This API has a single-user QPS (Queries Per Second) limit of 100 calls per second. If you exceed this limit, API calls are rate-limited, which might affect your business. Call the API as needed. For more information, see QPS limits.

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 ID of the transcoding job. You can query a maximum of 10 jobs at a time. Separate multiple job IDs with commas (,). You can obtain the job ID from the Job Management page in the MPS console or from the response parameters that are returned after you submit a transcoding job. Note If this parameter is not specified, the `InvalidParameter` error code is returned.	bb558c1cc25b45309aab5be44d19**,d1ce4d3efcb549419193f50f1fcd**

Response elements

Element	Type	Description	Example
	object	Response parameters.
NonExistJobIds	object
String	array	IDs of jobs that do not exist.
	string	List of transcoding job IDs that do not exist. This structure is not returned if no such IDs exist.	d1ce4d3efcb549419193f50f1fcd****
RequestId	string	The request ID.	197ADF44-104C-514C-9F92-D8924CB34E2A
JobList	object
Job	array<object>	List of transcoding jobs.
	array<object>	Details of a transcoding job.
CreationTime	string	Time when the job was submitted.	2014-01-10T12:00:00Z
Percent	integer	Transcoding progress, as a percentage.	100
FinishTime	string	Time when the job completed.	2014-01-10T12:20:25Z
State	string	Status of the job. Submitted: The job has been submitted. Transcoding: Transcoding is in progress. TranscodeSuccess: Transcoding succeeded. TranscodeFail: Transcoding failed. TranscodeCancelled: Transcoding was canceled.	TranscodeSuccess
JobId	string	The job ID.	31fa3c9ca8134fb4b0b0f7878301****
Code	string	Error code for a failed job. This parameter is not returned for successful jobs.	InvalidParameter.NullValue
Message	string	Error message for a failed job. This parameter is not returned for successful jobs.	The specified parameter "%s" cannot be null.
Output	object	Job output.
Video	object	Video configuration.
Bufsize	string	Buffer size. Unit: Kb. Default value: 6000.	6000
Degrain	string	Strength of the standalone denoising algorithm.	5
BitrateBnd	object	Range of the average video bitrate.
Max	string	Maximum bitrate.	1000
Min	string	Minimum bitrate.	300
PixFmt	string	Video color format. Valid values include yuv420p and yuvj420p.	yuv420p
Pad	string	Add black bars to the video. Unit: px. Format: width:height:left:top.	1280:800:0:140
Codec	string	Codec format. Valid values: H.264 and H.265. Default value: H.264.	H.264
Height	string	Height of the output video. Unit: px. Default value: Original height of the input video.	720
Qscale	string	Video quality control factor.	15
Crop	string	Crop the video frame. Supported methods: Auto-detect and crop black bars. Set this parameter to border. Custom cropping. Format: width:height:left:top.	1280:800:0:140
Bitrate	string	Average video bitrate. Unit: Kbps.	500
Maxrate	string	Peak video bitrate. Unit: Kbps.	3000
MaxFps	string	Maximum frame rate.	60
Profile	string	Encoding profile. Valid values: baseline, main, and high. Note If you have multiple resolutions, use baseline for the lowest resolution to ensure playback on low-end devices. Use main or high for other resolutions. baseline: For mobile devices. main: For standard-resolution devices. high: For high-resolution devices. Default value: high.	high
Crf	string	Constant Rate Factor (CRF) for bitrate-quality control. Default values: 23 for H.264 and 26 for H.265. If CRF is set, the Bitrate setting is ignored.	26
Gop	string	Maximum time interval or number of frames between keyframes. Unit: seconds. Default value: 250. No unit when specifying the maximum number of frames.	250
Width	string	Width of the output video. Unit: px. Default value: Original width of the input video.	1280
Fps	string	Frame rate. Unit: fps. If the input file's frame rate exceeds 60, the value is capped at 60. Default value: Frame rate of the input file.	25
Preset	string	Preset for the video encoder. Default value: medium. Valid values: veryfast: Very fast. fast: Fast. medium: Medium. slow: Slow. slower: Very slow.	medium
ScanMode	string	Scanning mode. Valid values: Not set: Use the original scanning mode of the input file. auto: Auto-deinterlace. progressive: Progressive scan (line-by-line). interlaced: Interlaced scan. Default value: Empty (not set). Best practice: Interlaced scan saves bandwidth but reduces quality. Most modern videos use progressive scan. If you set progressive or interlaced but it does not match the source, transcoding fails. We recommend using original scanning mode or auto-deinterlace for better compatibility.	interlaced
ResoPriority	string	Resource priority.	1
TransConfig	object	General transcoding configurations. Note If you specify these values in the request, they override corresponding settings in the transcoding template.
IsCheckAudioBitrate	string	Whether to check the audio bitrate. If the output audio bitrate exceeds the source audio bitrate, the output bitrate is set to the source bitrate, and your configured bitrate is ignored. This setting has lower priority than IsCheckAudioBitrateFail. true: Check. false: Do not check. Default value: Empty parameter and codec differs from the source: false. Empty parameter and codec matches the source: true.	false
TransMode	string	Transcoding mode. Valid values: onepass, twopass, and CBR. Default value: onepass.	onepass
IsCheckReso	string	Whether to check the resolution. If the output resolution exceeds the input resolution (width or height), the output resolution is set to the input resolution. true: Check. false: Do not check. Default value: false.	false
IsCheckVideoBitrateFail	string	Whether to check the video bitrate. If the output video bitrate exceeds the source video bitrate, transcoding fails immediately. This setting has higher priority than IsCheckVideoBitrate. true: Check. false: Do not check. Default value: false.	false
AdjDarMethod	string	Resolution adjustment method. Default value: none. Valid values: rescale, crop, pad, and none.	none
IsCheckVideoBitrate	string	Whether to check the video bitrate. If the output video bitrate exceeds the input video bitrate, the output bitrate is set to the input bitrate. true: Check. false: Do not check. Default value: false.	false
IsCheckResoFail	string	Whether to check the resolution. If the output resolution exceeds the input resolution (width or height), transcoding fails. true: Check. false: Do not check. Default value: false.	false
IsCheckAudioBitrateFail	string	Whether to check the audio bitrate. If the output audio bitrate exceeds the source audio bitrate, transcoding fails immediately. This setting has higher priority than IsCheckAudioBitrate. true: Check. false: Do not check. Default value: false.	false
Encryption	object	Data encryption. Only supported for m3u8 outputs.
Type	string	Encryption type. Valid value: hls-aes-128.	hls-aes-128
Key	string	Encryption key for the video.	encryptionkey128
KeyType	string	Key encryption method. Valid values: Base64 and KMS. Note For example, if the key is `"encryptionkey128"`, then `Base64("encryptionkey128")` or `KMS(Base64("encryptionkey128"))`.	Base64
Id	string	Encryption ID.	31fa3c9ca8134f9cec2b4b0b0f78****
KeyUri	string	URL to access the key. Encoded with BASE64.	https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/
SkipCnt	string	Number of initial segments not encrypted (to enable fast playback).	3
WaterMarkList	object
WaterMark	array<object>	List of watermarks.
	array<object>	Details of a watermark.
Type	string	Watermark type. If specified in the request, this value overrides the corresponding parameter in the watermark template. For more information, see Parameter details. Valid values: Image: Image watermark. Text: Text watermark.	Image
ReferPos	string	Position of the watermark. If specified in the request, this value overrides the corresponding parameter in the watermark template. Valid values: TopRight: Top right. TopLeft: Top left. BottomRight: Bottom right. BottomLeft: Bottom left.	TopRight
Dx	string	Horizontal offset of the watermark image relative to the output video. If specified in the request, this value overrides the corresponding parameter in the watermark template. Default value: 0. Values can be: Integer: Offset in pixels. Range: [8,4096]. Unit: px. Decimal: Ratio of the horizontal offset to the output video width. Range: (0,1). Supports up to four decimal places. For example: 0.9999. Extra digits are truncated.	100
Width	string	Width of the watermark image. If specified in the request, this value overrides the corresponding parameter in the watermark template. Values can be: Integer: Width in pixels. Range: [8,4096]. Unit: px. Decimal: Ratio of the watermark width to the output video width. Range: (0,1). Supports up to four decimal places. For example: 0.9999. Extra digits are truncated.	50
Height	string	Height of the watermark image. If specified in the request, this value overrides the corresponding parameter in the watermark template. Values can be: Integer: Height in pixels. Range: [8,4096]. Unit: px. Decimal: Ratio of the watermark height to the output video height. Range: (0,1). Supports up to four decimal places. For example: 0.9999. Extra digits are truncated.	50
InputFile	object	Input file for the watermark. Supported formats: PNG images and MOV files.
Object	string	OSS object of the input file.	example-logo-****.png
Location	string	OSS location of the input file.	oss-cn-hangzhou
Bucket	string	OSS bucket of the input file.	example-bucket
WaterMarkTemplateId	string	ID of the watermark template.	88c6ca184c0e47098a5b665e2a12****
Dy	string	Vertical offset of the watermark image relative to the output video. If specified in the request, this value overrides the corresponding parameter in the watermark template. Values can be: Integer: Vertical offset in pixels. Range: [8,4096]. Unit: px. Decimal: Ratio of the vertical offset to the output video height. Range: (0,1). Supports up to four decimal places. For example: 0.9999. Extra digits are truncated.	100
WaterMarkConfigUrl	string	URL of the watermark configuration file.	http://example.com/configure
DeWatermark	string	Blur configuration, as a JSON object. For more information, see the blur configuration 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	m3u8 non-standard support, as a JSON object. For more information, see the m3u8 non-standard parameter support details in Parameter details.
TS	object	JSON object for TS file non-standard support. For more information, see the TS parameter support details in Parameter details.
SizeSupport	boolean	Whether to include the TS file size in the m3u8 file. Valid values: true: Include. false: Do not include.	true
Md5Support	boolean	Whether to include the MD5 hash of the TS file in the m3u8 file. Valid values: true: Include. false: Do not include.	true
Priority	string	Priority of the job within its pipeline. Maximum priority: 10. Default value: 6.	6
Audio	object	Audio configuration. Note If you specify audio configurations in the request, they override corresponding settings in the transcoding template.
Profile	string	Audio codec profile. Valid values when Codec is aac: aaclow, aache, aachev2, aacld, and aaceld.	aaclow
Codec	string	Audio codec format. Valid values: aac, mp3, vorbis, and flac. Default value: aac.	aac
Samplerate	string	Sample rate. Valid values: 22050, 32000, 44100, 48000, and 96000. Unit: Hz. Default value: 44100. Note If the container format is flv and the audio codec is mp3, sample rates 32000, 48000, and 96000 are not supported. If the audio codec is mp3, sample rate 96000 is not supported.	44100
Qscale	string	Audio quality control factor.	15
Channels	string	Number of sound channels. Valid values: 1, 2, 3, 4, 5, 6, 7, and 8. Default value: 2.	2
Volume	object	Volume configuration.
Method	string	Volume adjustment method. Valid values: auto: Automatic adjustment. dynamic: Dynamic adjustment. linear: Linear adjustment.	auto
Level	string	Volume adjustment level. Default value: -20 dB.	-20
Bitrate	string	Audio bitrate of the output file. Unit: Kbps. Default value: 128.	128
AudioStreamMap	string	Index of the audio stream. Format: 0:a:{index}. Example: 0:a:0. The index is the position in the audio stream list, starting from 0. If not set, the default audio stream is used.	0:a:0
MergeList	object
Merge	array<object>	Merge settings. Up to four MergeURLs are supported.
	object	Details of a merge operation.
Start	string	Start time point. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Example: 01:59:59.999 or 32000.23.	01:59:59.999
RoleArn	string	Role ARN for agent authorization.	acs:ram:::role/
MergeURL	string	URL of the segment to merge. Example: `http://example-bucket-.oss-cn-hangzhou.aliyuncs.com/example-object.flv`. The object name must be URL-encoded using UTF-8. For more information, see URL encoding instructions.	http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv
Duration	string	Duration. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Example: 01:59:59.999 or 32000.23.	01:59:59.999
SuperReso	object	Resolution follows the source.
IsHalfSample	string	Whether to obtain sampling rate-related parameters. Valid values: true: Yes. false: No.	true
UserData	string	User-defined data.	testid-001
ExtendData	string	User-defined extension field.	testid-002
OutSubtitleList	object
OutSubtitle	array<object>	List of output subtitles.
	array<object>	Details of an output subtitle.
Map	string	Video track. Format: `0:{stream}:{index}`, i.e., `0:v:{video_index}`. Stream values: v for video. Index is the position in the video stream list, starting from 0.	0:v:0
OutSubtitleFile	object	Details of the output file.
RoleArn	string	Role ARN for agent authorization.	acs:ram:::role/
Object	string	OSS object of the output file.	example.flv
Location	string	OSS location of the output file.	oss-cn-hangzhou
Bucket	string	OSS bucket of the output file.	exampleBucket
Success	boolean	Whether the operation succeeded. Valid values: true: Succeeded. false: Failed.	true
Message	string	Error message for a failed job. This parameter is not returned for successful jobs.	The specified parameter “%s” cannot be null.
VideoStreamMap	string	Index of the video stream. Index starts from 0. Index is the position in the video stream list. If not set, the default video stream is used.	0
OutputFile	object	Output file.
RoleArn	string	Role ARN for agent authorization.	acs:ram:::role/
Object	string	OSS object of the output file.	example-output.flv
Location	string	OSS location of the output file.	oss-cn-hangzhou
Bucket	string	OSS bucket of the output file.	example-bucket
Rotate	string	Video rotation angle.	90
Container	object	Container.
Format	string	Container format. Default value: mp4. For video transcoding, valid values are flv, mp4, HLS (m3u8+ts), and MPEG-DASH (MPD+fMP4). For audio transcoding, valid values are mp3, mp4, ogg, flac, and m4a. For images, valid values are gif and WEBP. If the container is gif, VideoCodec must be GIF. If the container is webp, VideoCodec must be WEBP. If the container is flv, VideoCodec cannot be H.265.	mp4
Clip	object	Clipped segment.
TimeSpan	object	Clipping time span.
Seek	string	Start time point. Format: `hh:mm:ss[.SSS]`. Example: 01:59:59.999. Or Format: `sssss[.SSS]`. Example: 32000.23.	01:59:59.999
Duration	string	Duration. Format: `hh:mm:ss[.SSS]`. Example: 01:00:59.999. Or Format: `sssss[.SSS]`. Example: 32000.23.	01:00:59.999
MergeConfigUrl	string	URL of the merge configuration file. You can specify either MergeList or MergeConfigUrl, but not both. The configuration file specified by MergeConfigUrl supports up to 50 merge segments. MergeConfigUrl is the URL of the merge configuration file. The file must be stored in OSS and accessible to MPS. For details about the file content, see merge parameter details. Example mergeConfigfile 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>	List of opening videos, as a JSON object.
	object	The opening details.
openUrl	string	OSS URL of the opening video.	http://example.oss-cn-shanghai.aliyuncs.com/t5.mp4
Start	string	Start time relative to the main video. Delay before displaying the opening video. Unit: seconds. Default value: 0.	0
Width	string	Width. Valid values: (0,4096), 1, and full. -1 means use the source video's width. full means fill the entire screen. Default value: -1.	-1
Height	string	Height. Valid values: (0,4096), -1, and full. -1 means use the source video's height. full means fill the entire screen. Default value: -1.	-1
MuxConfig	object	Muxing configuration. If you specify this parameter in the request, it overrides corresponding settings in the transcoding template.
Webp	object	WebP muxing configuration.
Loop	string	Number of loops.	0
Gif	object	GIF muxing configuration.
FinalDelay	string	Pause duration at the final frame. Unit: centiseconds.	0
DitherMode	string	Dithering method for the color palette. Valid values: sierra and bayer.	bayer
Loop	string	Number of loops.	0
IsCustomPalette	string	Whether to use a custom color palette. Valid values: true: Use a custom palette. false: Do not use a custom palette.	false
Segment	object	Segmentation configuration, as a JSON object.
Duration	string	Segment duration. Unit: seconds.	20
TailSlateList	object
TailSlate	array<object>	List of tail slate videos.
	object	Details of a tail slate video.
Start	string	Start time of the tail slate video.	00000.00
BgColor	string	Background color for blank areas when the tail slate video is smaller than the main video. Default value: White. For more information, see bgcolor.	White
IsMergeAudio	boolean	Whether to merge the audio from the tail slate video. Valid values: true: Merge. false: Do not merge.	true
Width	string	Width. Valid values: (0,4096), -1, and full. -1 means use the source video's width. full means fill the entire screen. Default value: -1.	-1
Height	string	Height. Valid values: (0,4096), -1, and full. -1 means use the source video's height. full means fill the entire screen. Default value: -1.	-1
BlendDuration	string	Transition duration between the main video and the tail slate video. Transition effect: fade out the last frame of the main video while fading in the tail slate video. Unit: seconds. Default value: 0.	0
TailUrl	string	OSS URL of the tail slate video.	http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
TemplateId	string	Template ID.	S00000001-200010
SubtitleConfig	object	Subtitle configuration.
ExtSubtitleList	object
ExtSubtitle	array<object>	List of external subtitles.
	array<object>	Subtitle details.
CharEnc	string	Character encoding for external subtitles. Valid values: UTF-8, GBK, BIG5, and auto. Default value: auto. Note When set to auto, character encoding detection may fail. We recommend specifying an explicit encoding.	auto
FontName	string	Font name used when converting external subtitles to hard subtitles. Default value: SimSun. For more information, see Font list.	"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"
Input	object	External subtitle input file. Supported formats: srt and ass. For more information, see Parameter details, Input parameter. Example: `{“Bucket”:”example-bucket”,“Location”:”oss-cn-hangzhou”,“Object”:”example.srt”}`.
Object	string	OSS object of the input file.	example-output.flv
Location	string	OSS location of the input file.	oss-cn-hangzhou
Bucket	string	OSS bucket of the input file.	example-bucket-****
SubtitleList	object
Subtitle	array<object>	List of subtitles.
	object	Subtitle details.
Map	string	Audio track. Format: `0:{stream}:{index}`, i.e., `0:a:{audio_index}`. Stream values: a for audio. Index is the position in the audio stream list, starting from 0.	0:a:0
Properties	object	Media properties.
Width	string	Video width.	720
Height	string	Video height.	1280
SourceLogos	object
SourceLogo	array<object>	Keywords not processed by the engine layer.
	object	Keyword details.
Source	string	Keyword.	example
Duration	string	Duration.	17
Fps	string	Frame rate.	30
Bitrate	string	Bitrate.	490
FileFormat	string	File format.	mp4
Streams	object	Stream information.
VideoStreamList	object
VideoStream	array<object>	List of video streams.
	array<object>	Video stream details.
Index	string	Index of the video stream, indicating its position in the media stream.	0
Timebase	string	Time base.	1/15360
AvgFPS	string	Average frame rate.	30.0
PixFmt	string	Pixel format.	yuv420p
Sar	string	Sample aspect ratio.	1:1
Lang	string	Language. For more information, see FFmpeg language definitions and ISO-639.	eng
CodecLongName	string	Long name of the codec.	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Height	string	Video resolution height.	1280
NumFrames	string	Total number of frames.	30
Bitrate	string	Bitrate.	421.117
CodecTagString	string	Codec tag string.	avc1
HasBFrames	string	Whether B-frames exist.	2
Profile	string	Encoding profile.	high
StartTime	string	Start time.	0.000000
NetworkCost	object	Network bandwidth consumption.
PreloadTime	string	Preload time.	8
AvgBitrate	string	Average bitrate.	300
CostBandwidth	string	Maximum bandwidth consumed.	10
Dar	string	Display aspect ratio.	9:16
CodecName	string	Short name of the codec.	h264
Width	string	Video resolution width, as a number.	720
Duration	string	Duration.	17.233333
Fps	string	Frame rate.	30.0
CodecTag	string	Codec tag.	0x31637661
CodecTimeBase	string	Codec time base.	1/60
Level	string	Encoding level.	31
colorTransfer	string	Color transfer.	bt709
colorPrimaries	string	Color primaries.	bt709
bitsPerRawSample	string	Number of bits per raw sample or pixel.	8
AudioStreamList	object
AudioStream	array<object>	List of audio streams.
	object	Audio stream details.
Timebase	string	Time base.	1/32000
Index	string	Index of the audio stream, indicating its position in the media stream.	1
SampleFmt	string	Sample format.	fltp
ChannelLayout	string	Channel layout.	mono
Lang	string	Language. For more information, see FFmpeg language definitions and ISO-639.	und
Samplerate	string	Sample rate.	32000
CodecLongName	string	Long name of the codec.	AAC (Advanced Audio Coding)
Channels	string	Number of sound channels.	1
NumFrames	string	Total number of frames.	50
Bitrate	string	Bitrate.	64.136
CodecTagString	string	Codec tag string.	mp4
StartTime	string	Start time.	0.064000
CodecName	string	Short name of the codec.	aac
Duration	string	Duration.	17.223562
CodecTag	string	Codec tag.	0x6134706d
CodecTimeBase	string	Codec time base.	1/32000
SubtitleStreamList	object
SubtitleStream	array<object>	List of subtitle streams.
	object	Subtitle stream details.
Index	string	Index of the subtitle stream. Indicates its position in the media stream.	1
Lang	string	Language. For more information, see FFmpeg language definitions and ISO-639.	eng
Format	object	Format information.
StartTime	string	Start time.	-0.064000
NumPrograms	string	Total number of program streams.	0
Size	string	File size.	1057273
NumStreams	string	Total number of media streams.	2
FormatLongName	string	Long name of the container or wrapper format.	QuickTime / MOV
Duration	string	Total duration.	17.234000
Bitrate	string	Total bitrate.	490.784
FormatName	string	Short name of the container or wrapper format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov
FileMd5	string		ad195fd1317a761d4425232867759d1e
FileSize	string	File size.	1057273
MultiSpeedInfo	object	Information about a multi-speed job. This field appears only for jobs submitted to a multi-speed pipeline (not available for legacy multi-speed jobs).
Enable	string	Whether the multi-speed feature is enabled.	true
Code	string	Error code (for cases where multi-speed was not actually enabled).	Boost.NotNeedSpeed
Message	string	Error message (for cases where multi-speed was not actually enabled).	success
SettingSpeed	integer	Configured speed.	30
DowngradePolicy	string	Downgrade policy when multi-speed is not supported.	NormalSpeed
RealSpeed	number	Actual multi-speed value.	6.576886940181647
Duration	number	Duration of the output video.	21.0
TimeCost	number	Time spent on the job.	3.193
PipelineId	string	Pipeline ID.	88c6ca184c0e47b665e2a1267971****
Input	object	Job input.
Object	string	OSS object of the input file.	video_01.mp4
Location	string	OSS location of the input file.	oss-cn-shanghai
Bucket	string	OSS bucket of the input file.	exampleBucket
MNSMessageResult	object	MNS notification result for job completion.
MessageId	string	Message ID for successful jobs.	123
ErrorMessage	string	Error message for failed jobs. Not returned for successful jobs.	The resource operated “%s” cannot be found.
ErrorCode	string	Error code for failed jobs. Not returned for successful jobs.	InvalidParameter.ResourceNotFound
SubmitTime	string	Time when the job was dequeued and started execution.	2021-03-04T06:44:43Z

Callback message format

When a transcoding job changes state, MPS (Media Processing Service) sends a message to the queue you specify. To learn how to specify a callback queue, see the MPS UpdatePipeline operation. 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". This indicates a transcoding job.
JobId	String	The unique ID of the job.
State	String	The current job state. This matches the State field in QueryJobList.
UserData	String	The UserData value you passed in SubmitJobs.

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.