All Products
Search
Document Center

ApsaraVideo Media Processing:ListJob

Last Updated:Mar 03, 2024

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 actual configuration time.
  • You can filter query results by configuring request parameters such as job status, creation time interval, and MPS queue for transcoding.

QPS limit

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

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NextPageTokenstringNo

The token that is used to retrieve the next page of the query results. You do not need to specify this parameter in the first request. The response to the first request contains this parameter, which you add to the next request.

16f01ad6175e4230ac42bb5182cd****
MaximumPageSizelongNo

The maximum number of media workflow execution instances to return on each page.

  • Default value: 10.
  • Valid values: 1 to 100.
10
StatestringNo

The status of the transcoding job. Default value: All. Valid values:

  • All: All statuses.
  • Submitted: The job is submitted.
  • Transcoding: The job is being transcoded.
  • TranscodeSuccess: Transcoding is successful.
  • TranscodeFail: Transcoding failed.
  • TranscodeCancelled: Transcoding is canceled.
All
StartOfJobCreatedTimeRangestringNo

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 is displayed in UTC.

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

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 is displayed in UTC.

2014-01-11T12:00:00Z
PipelineIdstringNo

The ID of the MPS queue. To view the ID of the MPS queue, log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane.

88c6ca184c0e424d5w5b665e2a12****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

BC860F04-778A-472F-AB39-E1BF329C1EA8
NextPageTokenstring

The token that is used to retrieve the next page of the query results. You must record the token and specify it in the next request.

16f01ad6175e4230ac42bb5182cd****
JobListobject []

The list of transcoding jobs.

CreationTimestring

The time when the job was created.

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

The transcoding progress.

100
FinishTimestring

The time when the transcoding job was complete.

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

The status of the job. Valid values:

  • Submitted: The job is submitted.
  • Transcoding: The job is being transcoded.
  • TranscodeSuccess: Transcoding is successful.
  • TranscodeFail: Transcoding failed.
  • TranscodeCancelled: Transcoding is canceled.
TranscodeSuccess
JobIdstring

The ID of the job.

31fa3c9ca8134fb4b0b0f7878301****
Codestring

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

InternalError
Messagestring

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

The operation has failed due to some unknown error, exception or failure.
Outputobject

The output of the job.

Videoobject

The video configuration.

Bufsizestring

The size of the buffer.

6000
Degrainstring

The level of the independent denoising algorithm.

5
BitrateBndobject

The bitrate range of the video.

Maxstring

The maximum bitrate. Unit: Kbit/s.

1000
Minstring

The minimum bitrate. Unit: Kbit/s.

200
PixFmtstring

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

yuv420p
Padstring

The black borders to be added to the video. Unit: pixels.

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

The codec. Valid values: H.264, H.265, GIF, and WEBP.

H.264
Heightstring

The height.

  • Unit: pixels.
  • Default value: the original height of the video.
720
Qscalestring

The level of quality control on the video.

15
Cropstring

The video cropping mode. The following modes are supported:

  • border: automatically detects and removes borders.
  • Custom cropping. Specify a value in the format of width:height:left:top to crop the video based on the custom settings. Example: 1280:800:0:140.
border
Bitratestring

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

428
Maxratestring

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

1000
MaxFpsstring

The maximum frame rate.

60
Profilestring

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
Crfstring

The constant rate factor. If this parameter is specified, the setting of the Bitrate parameter becomes invalid. Default value: 26.

26
Gopstring

The maximum number of frames between two keyframes. Default value: 250.

250
Widthstring

The width.

  • Unit: pixels.
  • Default value: the original width of the video.
1280
Fpsstring

The frame rate.

  • The value is 60 if the frame rate of the input file exceeds 60.
  • Default value: the frame rate of the input file.
25
Presetstring

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

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

The scan mode. Valid values:

  • interlaced: An interlaced scan was performed.
  • progressive: A progressive scan was performed.
  • auto: A scan was performed based on the video source.
interlaced
ResoPrioritystring

The priority of the resource.

1
TransConfigobject

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

IsCheckAudioBitratestring

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

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

The transcoding mode.

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

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

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

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

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

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

none
IsCheckVideoBitratestring

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

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

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

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

Indicates whether the audio bitrate is checked. If the output audio bitrate is higher than the audio bitrate of the media source, a transcoding failure is returned without transcoding the media. This parameter takes precedence over the IsCheckAudioBitrate parameter.

  • true: The audio bitrate is checked.
  • false: The audio bitrate is not checked.
false
Encryptionobject

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

Typestring

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

hls-aes-128
Keystring

The key that is used to encrypt the video.

encryptionkey128
KeyTypestring

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

Note For example, if the key is "encryptionkey128”, you can encrypt the key in the Base64 format or use Key Management Service (KMS) to encrypt the key.````
Base64
Idstring

The encryption ID.

31fa3c9ca8134f9cec2b4b0b0f78****
KeyUristring

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

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

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

3
WaterMarkListobject []

The list of watermarks.

Typestring

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

  • Image: an image watermark.
  • Text: a text watermark.
Image
ReferPosstring

The position of the watermark.

  • TopRight: the upper-right corner.
  • TopLeft: the upper-left corner.
  • BottomRight: the lower-right corner.
  • BottomLeft: the lower-left corner.
TopRight
Dxstring

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

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

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

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

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

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

    • Valid values: [8,4096].
    • Unit: pixels.
  • 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. Excessive digits are automatically deleted.
50
Heightstring

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

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

    • Valid values: [8,4096].
    • Unit: pixels.
  • 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. Excessive digits are automatically deleted.
50
InputFileobject

The watermark input file.

Objectstring

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

example-logo-****.png
Locationstring

The OSS region where the input file resides.

oss-cn-hangzhou
Bucketstring

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

example-bucket
WaterMarkTemplateIdstring

The ID of the watermark template.

88c6ca184c0e47098a5b665e2a12****
Dystring

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

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

    • Valid values: [8,4096].
    • Unit: pixels.
  • 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. Excessive digits are automatically deleted.
100
WaterMarkConfigUrlstring

The URL of the watermark configuration file.

http://example.com/configure
DeWatermarkstring

The configuration of watermark blurring. The value must be 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}]}
M3U8NonStandardSupportobject

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

TSobject

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

SizeSupportboolean

Indicates whether to support the output of the size of the TS file in the M3U8 video.

  • true: supported.
  • false: not supported.
true
Md5Supportboolean

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

  • true: supported.
  • false: not supported.
true
Prioritystring

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
Audioobject

The audio configuration.

Profilestring

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

aaclow
Codecstring

The audio codec.

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

The sampling rate.

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

The level of quality control on the audio.

15
Channelsstring

The number of sound channels.

  • If the Codec parameter is set to mp3, this parameter can be set only to 1 or 2.
  • If the Codec parameter is set to aac, this parameter can be set only to 1, 2, 4, 5, 6, or 8.
  • Default value: 2.
2
Volumeobject

The volume configuration.

Methodstring

The volume adjustment method. Valid values:

  • auto: The volume is automatically adjusted.
  • dynamic: The volume is dynamically adjusted.
  • linear: The volume is linearly adjusted.
auto
Levelstring

The volume adjustment range.

  • Unit: dB.
  • Default: -20db.
-20
Bitratestring

The audio bitrate of the output file.

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

The sequence number of the audio stream.

  • Format: 0:a:{sequence number}.
  • The sequence number is the index of the audio stream in the list and starts from 0. If you do not set the corresponding parameter in the request, the default audio stream is selected.
0:a:0
MergeListobject []

The clip merging configuration.

Startstring

The start point in time of the clip.

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

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

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

The OSS URL of the clip.

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

The start point in time of the clip.

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

Indicates that the resolution of the source video is used.

IsHalfSamplestring

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

  • true: The parameters are obtained.
  • false: The parameters are not obtained.
true
UserDatastring

The custom data.

test-001
OutSubtitleListobject []

The output subtitle list.

Mapstring

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

0:v:0
OutSubtitleFileobject

The details of the output file.

RoleArnstring

The ARN of the role used for proxy authorization.

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

The name of the OSS object of the output file.

example-output.flv
Locationstring

The OSS region where the output file resides.

oss-cn-hangzhou
Bucketstring

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

example-bucket-****
Successboolean

Indicates whether the job was successful. Valid values:

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

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

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

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

The information about the output file.

RoleArnstring

The ARN of the role used for proxy authorization.

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

The name of the OSS object of the output file.

example-output.flv
Locationstring

The OSS region where the output file resides.

oss-cn-hangzhou
Bucketstring

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

example-bucket
Rotatestring

The video rotation angle.

90
Containerobject

The information about the container.

Formatstring

The format of the container.

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

The information about the clip.

TimeSpanobject

The time span of the clip.

Seekstring

The 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
Durationstring

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
MergeConfigUrlstring

The URL of the merging configuration file. You can specify either the MergeList or MergeConfigUrl parameter.

  • The configuration file that you specify by using the MergeConfigUrl parameter can contain up to 50 merged clips.
  • The MergeConfigUrl parameter specifies the URL of the configuration file for clip merging.
  • Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details about merging parameters.
  • Example of the content of mergeConfigfile: {"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}.
{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}
OpeningListobject []

The list of opening parts.

openUrlstring

The OSS URL of the opening part of the video.

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

The amount of time after which the opening part is played. The value starts from 0.

  • Unit: seconds.
  • Default value: 0.
0
Widthstring

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

  • 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 main part is used for the opening part.
-1
Heightstring

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 main part is used for the opening part.
-1
MuxConfigobject

The transmuxing configuration.

Webpobject

The transmuxing configuration for WebP.

Loopstring

The loop count.

0
Gifobject

The transmuxing configuration for GIF.

FinalDelaystring

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

0
DitherModestring

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

bayer
Loopstring

The loop count.

0
IsCustomPalettestring

Indicates whether the custom palette was used. Valid values:

  • true: custom.
  • false: non-custom.
true
Segmentobject

The segment configuration. The value is a JSON object.

Durationstring

The length of the segment. The value must be an integer. Unit: seconds.

  • Valid values: [1,10].
  • Default value: 10.
10
TailSlateListobject []

The list of ending parts.

Startstring

The start time.

1
BgColorstring

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

White
IsMergeAudioboolean

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

  • true: The audio content of the ending part is merged.
  • false: The audio content of the ending part is not merged.
true
Widthstring

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

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

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

  • A value of -1 indicates that the height of the source of the ending part is retained.
  • A value of full indicates that the height of the main part is used for the ending part.
  • Default value: -1.
-1
BlendDurationstring

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

0
TailUrlstring

The OSS URL of the ending part.

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

The ID of the template.

S00000000-000010
SubtitleConfigobject

The subtitle configuration.

ExtSubtitleListobject []

The list of external subtitles. The value is a JSON array.

CharEncstring

The character set used by the external subtitle.

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

The font of the hard subtitles converted from external subtitles.

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

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”}.
Objectstring

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

example-output.flv
Locationstring

The OSS region where the input file resides.

oss-cn-hangzhou
Bucketstring

The OSS bucket in which the input file is stored.

example-bucket-****
SubtitleListobject []

The list of subtitles.

Mapstring

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
Propertiesobject

The media properties.

Widthstring

The width of the video.

720
Heightstring

The length of the video.

1280
Durationstring

The duration.

17
Fpsstring

The frame rate.

30
Bitratestring

The bitrate.

490
FileFormatstring

The format of the video file.

mp4
Streamsobject

The stream information.

VideoStreamListobject []

The list of video streams.

Indexstring

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

0
Timebasestring

The time base.

1/15360
AvgFPSstring

The average frame rate.

30.0
PixFmtstring

The pixel format.

yuv420p
Sarstring

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

1:1
Langstring

The language. For more information, see FFmeg language definition and ISO-639.

und
CodecLongNamestring

The full name of the encoding format.

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

The height of the video in pixels.

1280
NumFramesstring

The total frame rate.

30
Bitratestring

The bitrate.

421.117
CodecTagStringstring

The tag string of the encoding format.

avc1
HasBFramesstring

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

2
Profilestring

The codec profile.

high
StartTimestring

The start time.

0.000000
NetworkCostobject

The network bandwidth consumption.

PreloadTimestring

The amount of preload time.

8
AvgBitratestring

The average bitrate.

300
CostBandwidthstring

The maximum bandwidth that was consumed.

10
Darstring

The display aspect ratio (DAR).

9:16
CodecNamestring

The short name of the encoding format.

h264
Widthstring

The width of the video in pixels.

720
Durationstring

The duration.

17.233333
Fpsstring

The frame rate.

30.0
CodecTagstring

The tag of the encoding format.

0x31637661
CodecTimeBasestring

The codec time base.

1/60
Levelstring

The codec level.

31
AudioStreamListobject []

The list of audio streams.

Timebasestring

The time base.

1/32000
Indexstring

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

1
SampleFmtstring

The sampling format.

fltp
ChannelLayoutstring

The output layout of the sound channels.

mono
Langstring

The language. For more information, see FFmeg language definition and ISO-639.

und
Sampleratestring

The sampling rate.

32000
CodecLongNamestring

The full name of the encoding format.

AAC (Advanced Audio Coding)
Channelsstring

The number of sound channels.

1
NumFramesstring

The total number of frames.

30
Bitratestring

The bitrate.

64.136
CodecTagStringstring

The tag string of the encoding format.

mp4a
StartTimestring

The start time.

0.000000
CodecNamestring

The short name of the encoding format.

aac
Durationstring

The duration.

17.223562
CodecTagstring

The tag of the encoding format.

0x6134706d
CodecTimeBasestring

The codec time base.

1/32000
SubtitleStreamListobject []

The list of subtitle streams.

Indexstring

The sequence number of the subtitle stream.

The value specifies the position of the subtitle stream in all subtitle streams.

1
Langstring

The language.

und
Formatobject

The format information.

StartTimestring

The start time.

0.064000
NumProgramsstring

The total number of program streams.

0
Sizestring

The size of the file.

1057273
NumStreamsstring

The total number of media streams.

2
FormatLongNamestring

The full name of the container format.

QuickTime / MOV
Durationstring

The total duration.

17.234000
Bitratestring

The total bitrate.

490.784
FormatNamestring

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

mov
FileSizestring

The size of the file.

1057273
PipelineIdstring

The ID of the MPS queue.

88c6ca184c0e47b665e2a1267971****
Inputobject

The information about the job input.

Objectstring

The name of the OSS object of the job input.

example.flv
Locationstring

The OSS region where the job input resides.

oss-cn-hangzhou
Bucketstring

The OSS bucket in which the job input is stored.

example-bucket
MNSMessageResultobject

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

MessageIdstring

The ID of the success message.

123
ErrorMessagestring

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

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

The error code that is returned when the job fails. This parameter is not returned if the job is created.

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 timeSummary of changesOperation
No change history