ListJob - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Traverses transcoding jobs

Operation description

By default, the returned transcoding jobs are sorted by CreationTime in descending order.
You can call this operation to return transcoding jobs of the last 90 days. The jobs are returned based on the specified time range.
You can filter query results by configuring request parameters such as job status, creation time interval, and ApsaraVideo Media Processing (MPS) queue for transcoding.
By default, MPS does not allow you to access data across regions within the same account. Before you call this operation, make sure that the region that you specify is the same as the region of the transcoding jobs to be queried. Otherwise, this operation may fail to be called, or invalid information may be returned.

QPS limits

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

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mts:ListJob	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextPageToken	string	No	The token that is used to retrieve the next page of the query results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextPageToken.	16f01ad6175e4230ac42bb5182cd****
MaximumPageSize	long	No	The number of entries per page. Default value: 10. Valid values: 1 to 100.	10
State	string	No	The state of the transcoding job. Default value: All. Valid values: All Submitted Transcoding TranscodeSuccess TranscodeFail TranscodeCancelled	All
StartOfJobCreatedTimeRange	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.	2014-01-10T12:00:00Z
EndOfJobCreatedTimeRange	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.	2014-01-11T12:00:00Z
PipelineId	string	No	The ID of the MPS queue to which the job is submitted. To obtain the ID of an MPS queue, you can log on to the MPS console and choose Global Settings > MPS Queue and Callback in the left-side navigation pane.	88c6ca184c0e424d5w5b665e2a12****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BC860F04-778A-472F-AB39-E1BF329C1EA8
NextPageToken	string	The pagination token. It can be used in the next request to retrieve a new page of results.	16f01ad6175e4230ac42bb5182cd****
JobList	array<object>	The transcoding jobs.
Job	object
CreationTime	string	The time when the job was created.	2014-01-10T12:00:00Z
Percent	long	The transcoding progress.	100
FinishTime	string	The time when the job was complete.	2014-01-10T12:20:25Z
State	string	The state of the job. Valid values: Submitted Transcoding TranscodeSuccess TranscodeFail TranscodeCancelled	TranscodeSuccess
JobId	string	The task ID.	31fa3c9ca8134fb4b0b0f7878301****
Code	string	The error code returned if the job failed. This parameter is not returned if the job was successful.	InternalError
Message	string	The error message returned if the job failed. This parameter is not returned if the job was successful.	The operation has failed due to some unknown error, exception or failure.
Output	object	The output of the job.
Video	object	The video configurations.
Bufsize	string	The size of the buffer.	6000
Degrain	string	The strength of the independent noise reduction algorithm.	5
BitrateBnd	object	The bitrate range of the video.
Max	string	The maximum bitrate. Unit: Kbit/s.	1000
Min	string	The minimum bitrate. Unit: Kbit/s.	200
PixFmt	string	The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.	yuv420p
Pad	string	The black borders that are added to the video. Unit: pixel. Format: width:height:left:top. Example: 1280:800:0:140.	1280:800:0:140
Codec	string	The video codec. Valid values: H.264, H.265, GIF, and WEBP.	H.264
Height	string	The height of the video. Unit: pixel. Default value: the height of the input video.	720
Qscale	string	The level of quality control on the video.	15
Crop	string	The video cropping mode. Valid values: border: automatically detects and removes black borders. A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.	border
Bitrate	string	The average bitrate of the video. Unit: Kbit/s.	428
Maxrate	string	The maximum bitrate of the video. Unit: Kbit/s.	1000
MaxFps	string	The maximum frame rate.	60
Profile	string	The codec profile. Valid values: baseline: applicable to mobile devices. main: applicable to standard-definition devices. high: applicable to high-definition devices. Default value: high.	high
Crf	string	The constant rate factor. If this parameter is returned, the value of Bitrate is invalid. Default value: 26.	26
Gop	string	The maximum number of frames between two keyframes. Default value: 250.	250
Width	string	The width of the video. Unit: pixel. Default value: the width of the input video.	1280
Fps	string	The frame rate. The value is 60 if the frame rate of the input video exceeds 60. Default value: the frame rate of the input file.	25
Preset	string	The preset video algorithm. Default value: medium. Valid values: veryfast fast medium slow slower	medium
ScanMode	string	The scan mode. Valid values: If this parameter is empty, the scan mode of the input file is used. auto: automatic deinterlacing. progressive: progressive scan. interlaced: interlaced scan. By default, this parameter is empty. Best practice: Interlaced scan consumes less bandwidth than progressive scan, but the image quality is poor. Therefore, mainstream video production uses progressive scan. If progressive scan or interlaced scan is used when the scan mode of the input file is neither of them, the transcoding job fails. We recommend that you use the scan mode of the input file or automatic deinterlacing to improve compatibility.	interlaced
ResoPriority	string	The priority of the resource.	1
TransConfig	object	The general transcoding configurations. If this parameter is specified in the request, the corresponding parameters in the specified transcoding template are overwritten.
IsCheckAudioBitrate	string	Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values: true false Default value: If this parameter is empty and the codec of the output audio is different from the codec of the input audio, the default value is false. If this parameter is empty and the codec of the output audio is the same as the codec of the input audio, the default value is true.	false
TransMode	string	The transcoding mode. Valid values: onepass, twopass, and CBR. Default value: onepass.	onepass
IsCheckReso	string	Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values: true false Default value: false.	false
IsCheckVideoBitrateFail	string	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 IsCheckVideoBitrate. Valid values: true false Default value: false.	false
AdjDarMethod	string	The method of resolution adjustment. Default value: none. Valid values: rescale, crop, pad, and none.	none
IsCheckVideoBitrate	string	Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values: true false Default value: false.	false
IsCheckResoFail	string	Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values: true false Default value: false.	false
IsCheckAudioBitrateFail	string	Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, a transcoding failure is returned without transcoding the audio. This parameter has a higher priority than IsCheckAudioBitrate. Valid values: false: The audio bitrate is checked. true: The audio bitrate is not checked.	false
Encryption	object	The encryption configurations. Only outputs in the M3U8 format are supported.
Type	string	The encryption type. Only hls-aes-128 may be returned.	hls-aes-128
Key	string	The key that is 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, you can encrypt the key in the Base64 format or use Key Management Service (KMS) to encrypt the key.``````	Base64
Id	string	The encryption ID.	31fa3c9ca8134f9cec2b4b0b0f78****
KeyUri	string	The URL that is used to request the key. The URL is Base64-encoded.	https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/
SkipCnt	string	The number of unencrypted frames at the beginning of the video. Leaving these frames unencrypted enables video playback to quickly start.	3
WaterMarkList	array<object>	The watermarks.
WaterMark	object
Type	string	The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. For more information, see Parameter details. Valid values: Image Text	Image
ReferPos	string	The position of the watermark. TopRight TopLeft BottomRight BottomLeft	TopRight
Dx	string	The horizontal offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Default value: 0. The value can be an integer or a decimal number. An integer indicates the pixel value of the horizontal offset. Valid values: [8,4096]. Unit: pixel. A decimal number indicates the ratio of the horizontal offset to the width in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	100
Width	string	The width of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number. An integer indicates the pixel value of the watermark width. Valid values: [8,4096]. Unit: pixel. A decimal indicates the ratio of the watermark width to the width in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	50
Height	string	The height of the watermark. If this parameter is specified in the request, the corresponding parameter in the specified watermark template is overwritten. The value can be an integer or a decimal number. An integer indicates the pixel value of the watermark height. Valid values: [8,4096]. Unit: pixel. A decimal indicates the ratio of the watermark height to the height in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	50
InputFile	object	The watermark input file.
Object	string	The name of the Object Storage Service (OSS) object that is used as the input file.	example-logo-****.png
Location	string	The ID of the OSS region in which the input file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket
WaterMarkTemplateId	string	The ID of the watermark template.	88c6ca184c0e47098a5b665e2a12****
Dy	string	The vertical offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number. An integer indicates the pixel value of the vertical offset. Valid values: [8,4096]. Unit: pixel. A decimal indicates the ratio of the vertical offset to the height in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	100
WaterMarkConfigUrl	string	The URL of the watermark configuration file.	http://example.com/configure
DeWatermark	string	The configurations of watermark blurring. The value is a JSON object. For more information, see 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 support configuration for M3U8. The value must be a JSON object. For more information, see Parameter details.
TS	object	The non-standard support configurations for TS files. The value is a JSON object. For more information, see Parameter details.
SizeSupport	boolean	Indicates whether the size of the TS file is included in the M3U8 file. true false	true
Md5Support	boolean	Indicates whether the MD5 value of the TS file is included in the M3U8 file. Valid values: true false	true
Priority	string	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.	6
Audio	object	The audio configurations.
Profile	string	The codec profile of the audio. Valid values if the value of Codec is aac: aaclow, aache, aachev2, aacld, and aaceld.	aaclow
Codec	string	The audio codec. 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. If the video container format is FLV and the audio codec is MP3, the value of this parameter cannot be 32000, 48000, or 96000. If the audio codec is MP3, the value of this parameter cannot be 96000.	44100
Qscale	string	The level of quality control on the audio.	15
Channels	string	The number of sound channels. If the value of Codec is mp3, the value of this parameter can only be 1 or 2. If the value of Codec is aac, the value of this parameter can only be 1, 2, 4, 5, 6, or 8. Default value: 2.	2
Volume	object	The volume configurations.
Method	string	The method that is used to adjust the volume. Valid values: auto dynamic linear	auto
Level	string	The volume adjustment range. Unit: decibel. Default value: -20.	-20
Bitrate	string	The audio bitrate of the output file. Unit: Kbit/s. Default value: 128.	128
AudioStreamMap	string	The sequence number of the audio stream. Format: `0:a:{Sequence number}`. The sequence number is the index of the audio stream in the list and starts from 0. If no sequence number is specified, the default audio stream is used.	0:a:0
MergeList	array<object>	The configurations for merging clips.
Merge	object
Start	string	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	The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role used for delegated authorization.	acs:ram::<your uid>:role/<your role name>
MergeURL	string	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.	http://example-bucket.oss-cn-hangzhou.aliyuncs.com/example-object.flv
Duration	string	The duration of the clip. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Examples: 01:59:59.999 and 32000.23.	01:59:59.999
SuperReso	object	The configurations for using the resolution of the source video.
IsHalfSample	string	Indicates whether parameters related to the sampling rate are obtained. Valid values: true false	true
UserData	string	The custom data.	test-001
OutSubtitleList	array<object>	The output subtitles.
OutSubtitle	object
Map	string	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.	0:v:0
OutSubtitleFile	object	The details of the output file.
RoleArn	string	The ARN of the RAM role used for delegated authorization.	acs:ram::<your uid>:role/<your role name>
Object	string	The name of the OSS object that is used as the output file.	example-output.flv
Location	string	The ID of the OSS region in which the output file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket-****
Success	boolean	Indicates whether the job was created. Valid values: true false	true
Message	string	The error message returned if the job failed to be created. This parameter is not returned if the job was created.	The specified parameter “%s” cannot be null.
VideoStreamMap	string	The sequence number of the video stream. Format: 0:a:{Sequence number}. Example value: 0:a:0. The sequence number is the index of the video stream in the list and starts from 0. If no sequence number is specified, the default video stream is used.	0:a:0
OutputFile	object	The details of the output file.
RoleArn	string	The ARN of the RAM role used for delegated authorization.	acs:ram::<your uid>:role/<your role name>
Object	string	The name of the OSS object that is used as the output file.	example-output.flv
Location	string	The ID of the OSS region in which the output file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket
Rotate	string	The rotation angle of the video.	90
Container	object	The container format configurations.
Format	string	The container format. Default value: mp4. Video formats include FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4). Audio formats include MP3, MP4, Ogg, FLAC, and M4A. Image formats include GIF and WebP. If the container format is GIF, the video codec must be GIF. If the container format is WebP, the video codec must be WebP. If the container format is FLV, the video codec cannot be H.265.	flv
Clip	object	The information about the clip.
TimeSpan	object	The time span of the clip.
Seek	string	The point in time when the clip starts. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`. Examples: 01:59:59.999 and 32000.23.	01:00:59.999
Duration	string	The duration of the clip. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`. Examples: 01:00:59.999 and 32000.23.	01:00:59.999
MergeConfigUrl	string	The URL of the merging configuration file. You can specify either MergeList or MergeConfigUrl when you submit the transcoding job. The configuration file specified by MergeConfigUrl can contain up to 50 clips. MergeConfigUrl indicates the URL of the configuration file for merging clips. Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details of merging parameters. Example of the content of the merging configuration file: `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`.	{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}
OpeningList	array<object>	The opening parts.
Opening	object
openUrl	string	The OSS URL of the opening part.	http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
Start	string	The amount of time after which the opening part is played. The value starts from 0. Unit: seconds. Default value: 0.	0
Width	string	The width of the opening part. Valid values: values in the range of (0, 4096), -1, and full. Default value: -1. A value of -1 indicates that the width of the source of the opening part is retained. A value of full indicates that the width of the opening part equals the width of the main part.	-1
Height	string	The height of the opening part. Valid values: values in the range of (0, 4096), -1, and full. Default value: -1. 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 opening part equals the height of the main part.	-1
MuxConfig	object	The transmuxing configurations.
Webp	object	The transmuxing configurations for WebP.
Loop	string	The loop count.	0
Gif	object	The transmuxing configurations for GIF.
FinalDelay	string	The duration for which the final frame is paused. Unit: centisecond.	0
DitherMode	string	The color dithering algorithm of the palette. Valid values: sierra and bayer.	bayer
Loop	string	The loop count.	0
IsCustomPalette	string	Indicates whether a custom palette is used. Valid values: true false	true
Segment	object	The segment configurations. The value is a JSON object.
Duration	string	The length of the segment. The value must be an integer. Unit: seconds. Valid values: [1,10]. Default value: 10.	10
TailSlateList	array<object>	The ending parts.
TailSlate	object
Start	string	The start time.	1
BgColor	string	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.	White
IsMergeAudio	boolean	Indicates whether the audio content of the ending part is merged. Valid values: true false	true
Width	string	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 width of the ending part equals the width of the main part. Default value: -1.	-1
Height	string	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 ending part equals the height of the main part. Default value: -1.	-1
BlendDuration	string	The duration of the transition between the main part and the ending part. A fade transition is used: The last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0.	0
TailUrl	string	The OSS URL of the ending part.	http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
TemplateId	string	The template ID.	S00000000-000010
SubtitleConfig	object	The subtitle configurations.
ExtSubtitleList	array<object>	The external subtitles. The value is a JSON array.
ExtSubtitle	object
CharEnc	string	The character set used by the external subtitle. Valid values: UTF-8, GBK, BIG5, and auto. Default value: auto. Note If this parameter is set to auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.	auto
FontName	string	The font of the hardcoded subtitles converted from external subtitles.	"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"
Input	object	The input subtitle file. Files in the SRT or ASS format are supported. For more information, see Parameter details. Example: `{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"}`.
Object	string	The name of the OSS object that is used as the input file.	example-output.flv
Location	string	The ID of the OSS region in which the input file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket-****
SubtitleList	array<object>	The subtitles.
Subtitle	object
Map	string	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.	0
Properties	object	The media properties.
Width	string	The width of the video.	720
Height	string	The height of the video.	1280
Duration	string	The duration of the video.	17
Fps	string	The frame rate of the video.	30
Bitrate	string	The bitrate of the video.	490
FileFormat	string	The format of the video.	mp4
Streams	object	The stream information.
VideoStreamList	array<object>	The video streams.
VideoStream	object
Index	string	The sequence number of the video stream. The value indicates the position of the video stream in all video streams.	0
Timebase	string	The time base of the video stream.	1/15360
AvgFPS	string	The average frame rate of the video stream.	30.0
PixFmt	string	The pixel format of the video stream.	yuv420p
Sar	string	The sample aspect ratio (SAR) of the video stream.	1:1
Lang	string	The language of the video stream. For more information, see FFmpeg documentation and ISO 639.	und
CodecLongName	string	The full name of the codec.	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Height	string	The height of the video stream in pixels.	1280
NumFrames	string	The total frame rate.	30
Bitrate	string	The bitrate of the video stream.	421.117
CodecTagString	string	The tag string of the codec.	avc1
HasBFrames	string	Indicates whether the video stream contains B-frames.	2
Profile	string	The codec profile.	high
StartTime	string	The start time.	0.000000
NetworkCost	object	The network bandwidth that was consumed.
PreloadTime	string	The amount of time consumed to preload the video stream.	8
AvgBitrate	string	The average bitrate of the video stream.	300
CostBandwidth	string	The maximum bandwidth that was consumed.	10
Dar	string	The display aspect ratio (DAR).	9:16
CodecName	string	The short name of the codec.	h264
Width	string	The width of the video stream in pixels.	720
Duration	string	The duration of the video stream.	17.233333
Fps	string	The frame rate of the video stream.	30.0
CodecTag	string	The tag of the codec.	0x31637661
CodecTimeBase	string	The codec time base.	1/60
Level	string	The codec level.	31
AudioStreamList	array<object>	The audio streams.
AudioStream	object
Timebase	string	The time base of the audio stream.	1/32000
Index	string	The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.	1
SampleFmt	string	The sampling format.	fltp
ChannelLayout	string	The output layout of the sound channels.	mono
Lang	string	The language of the audio stream. For more information, see FFmpeg documentation and ISO 639.	und
Samplerate	string	The sampling rate of the audio stream.	32000
CodecLongName	string	The full name of the codec.	AAC (Advanced Audio Coding)
Channels	string	The number of sound channels.	1
NumFrames	string	The total number of frames.	30
Bitrate	string	The bitrate of the audio stream.	64.136
CodecTagString	string	The tag string of the codec.	mp4a
StartTime	string	The start time.	0.000000
CodecName	string	The short name of the codec.	aac
Duration	string	The duration of the audio stream.	17.223562
CodecTag	string	The tag of the codec.	0x6134706d
CodecTimeBase	string	The codec time base.	1/32000
SubtitleStreamList	array<object>	The subtitle streams.
SubtitleStream	object
Index	string	The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.	1
Lang	string	The language of the subtitle stream.	und
Format	object	The format information.
StartTime	string	The start time.	0.064000
NumPrograms	string	The total number of program streams.	0
Size	string	The size of the file.	1057273
NumStreams	string	The total number of media streams.	2
FormatLongName	string	The full name of the container 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 format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov
FileSize	string	The size of the file.	1057273
PipelineId	string	The ID of the MPS queue.	88c6ca184c0e47b665e2a1267971****
Input	object	The information about the job input.
Object	string	The name of the OSS object that is used as the job input.	example.flv
Location	string	The ID of the OSS region in which the job input is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the job input is stored.	example-bucket
MNSMessageResult	object	The message sent by Message Service (MNS) to notify users of the job result.
MessageId	string	The ID of the message returned if the job was successful.	123
ErrorMessage	string	The error message returned if the job failed. This parameter is not returned if the job was successful.	The resource operated “%s” cannot be found.
ErrorCode	string	The error code returned if the job failed. This parameter is not returned if the job was successful.	InvalidParameter.ResourceNotFound

Examples

Sample success responses

JSONformat

{
  "RequestId": "BC860F04-778A-472F-AB39-E1BF329C1EA8",
  "NextPageToken": "16f01ad6175e4230ac42bb5182cd****",
  "JobList": {
    "Job": [
      {
        "CreationTime": "2014-01-10T12:00:00Z",
        "Percent": 100,
        "FinishTime": "2014-01-10T12:20:25Z",
        "State": "TranscodeSuccess",
        "JobId": "31fa3c9ca8134fb4b0b0f7878301****",
        "Code": "InternalError",
        "Message": "The operation has failed due to some unknown error, exception or failure.",
        "Output": {
          "Video": {
            "Bufsize": "6000",
            "Degrain": "5",
            "BitrateBnd": {
              "Max": "1000",
              "Min": "200"
            },
            "PixFmt": "yuv420p",
            "Pad": "1280:800:0:140",
            "Codec": "H.264",
            "Height": "720",
            "Qscale": "15",
            "Crop": "border",
            "Bitrate": "428",
            "Maxrate": "1000",
            "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": "",
                "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": "test-001",
          "OutSubtitleList": {
            "OutSubtitle": [
              {
                "Map": "0:v:0",
                "OutSubtitleFile": {
                  "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                  "Object": "example-output.flv",
                  "Location": "oss-cn-hangzhou",
                  "Bucket": "example-bucket-****"
                },
                "Success": true,
                "Message": "The specified parameter “%s” cannot be null."
              }
            ]
          },
          "VideoStreamMap": "0:a: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": "flv"
          },
          "Clip": {
            "TimeSpan": {
              "Seek": "01:00:59.999",
              "Duration": "01:00:59.999"
            }
          },
          "MergeConfigUrl": "{\"MergeList\":[{\"MergeURL\":\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\"}]}",
          "OpeningList": {
            "Opening": [
              {
                "openUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv",
                "Start": "0",
                "Width": "-1",
                "Height": "-1"
              }
            ]
          },
          "MuxConfig": {
            "Webp": {
              "Loop": "0"
            },
            "Gif": {
              "FinalDelay": "0",
              "DitherMode": "bayer",
              "Loop": "0",
              "IsCustomPalette": "true"
            },
            "Segment": {
              "Duration": "10"
            }
          },
          "TailSlateList": {
            "TailSlate": [
              {
                "Start": "1",
                "BgColor": "White",
                "IsMergeAudio": true,
                "Width": "-1",
                "Height": "-1",
                "BlendDuration": "0",
                "TailUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv"
              }
            ]
          },
          "TemplateId": "S00000000-000010",
          "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"
                }
              ]
            }
          },
          "Properties": {
            "Width": "720",
            "Height": "1280",
            "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": "und",
                    "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"
                  }
                ]
              },
              "AudioStreamList": {
                "AudioStream": [
                  {
                    "Timebase": "1/32000",
                    "Index": "1",
                    "SampleFmt": "fltp",
                    "ChannelLayout": "mono",
                    "Lang": "und",
                    "Samplerate": "32000",
                    "CodecLongName": "AAC (Advanced Audio Coding)",
                    "Channels": "1",
                    "NumFrames": "30",
                    "Bitrate": "64.136",
                    "CodecTagString": "mp4a",
                    "StartTime": "0.000000",
                    "CodecName": "aac",
                    "Duration": "17.223562",
                    "CodecTag": "0x6134706d",
                    "CodecTimeBase": "1/32000"
                  }
                ]
              },
              "SubtitleStreamList": {
                "SubtitleStream": [
                  {
                    "Index": "1",
                    "Lang": "und"
                  }
                ]
              }
            },
            "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": "example.flv",
          "Location": "oss-cn-hangzhou",
          "Bucket": "example-bucket"
        },
        "MNSMessageResult": {
          "MessageId": "123",
          "ErrorMessage": "The resource operated “%s” cannot be found.",
          "ErrorCode": "InvalidParameter.ResourceNotFound"
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history