Queries one or more template analysis jobs.
Usage notes
You can call this operation to query up to 10 template analysis jobs at a time.
QPS limit
You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | QueryAnalysisJobList |
The operation that you want to perform. Set the value to QueryAnalysisJobList. |
| AnalysisJobIds | String | Yes | bb558c1cc25b45309aab5be44d19**** |
The IDs of the template analysis jobs.
|
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | 5CA6E020-4102-4FFF-AA56-5ED7ECD811A1 |
The ID of the request. |
| AnalysisJobList | Array of AnalysisJob |
The IDs of the template analysis jobs. |
|
| AnalysisJob | |||
| CreationTime | String | 2014-01-10T12:00:00Z |
The time when the job was created. |
| Percent | Long | 86 |
The transcoding progress. |
| State | String | Success |
The status of the job. Valid values:
|
| AnalysisConfig | Object |
The job configuration. |
|
| QualityControl | Object |
The quality control on the job output. |
|
| MethodStreaming | String | network |
The playback mode. Valid values:
|
| RateQuality | String | 25 |
The quality level of the job output. Default value: 25. |
| PropertiesControl | Object |
The control on the attributes of the job output. |
|
| Deinterlace | String | Auto |
Indicates whether deinterlacing was forced to run. Valid values:
|
| Crop | Object |
The cropping configuration of video images. |
|
| Top | String | 8 |
The top margin that was cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.
|
| Width | String | 8 |
The width of the video after the margins were cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.
|
| Height | String | 8 |
The height of the video after the margins were cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.
|
| Left | String | 8 |
The left margin that was cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.
|
| Mode | String | Auto |
The cropping mode. Valid values: Valid values:
|
| Message | String | The resource operated \"PipelineId\" cannot be found |
The error message returned when the job fails. |
| Priority | String | 8 |
The priority of the job in the MPS queue to which the job is added.
|
| MNSMessageResult | Object |
The message sent by Message Service (MNS) to notify the user of the job result. |
|
| MessageId | String | 3ca84a39a9024f19853b21be9cf9**** |
The ID of the success message. This parameter is not returned if the job fails. |
| ErrorMessage | String | The resource operated \"PipelineId\" cannot be found |
The error message returned when the job fails. This parameter is not returned if the job is successful. |
| ErrorCode | String | InvalidParameter.ResourceNotFound |
The error code returned when the job fails. This parameter is not returned if the job is successful. |
| TemplateList | Array of Template |
The list of matched preset templates. |
|
| Template | |||
| Video | Object |
The video codec configuration. |
|
| Bufsize | String | 6000 |
The size of the buffer.
|
| Degrain | String | 5 |
The level of the independent denoising algorithm. |
| BitrateBnd | Object |
The average bit rate range of the video. |
|
| Max | String | 1500 |
The upper limit of the total bitrate. Unit: Kbit/s. |
| Min | String | 800 |
The lower limit of the total bitrate. Unit: Kbit/s. |
| PixFmt | String | yuv420p |
The pixel format for video color encoding. Valid values: standard pixel formats such as yuv420p and yuvj420p. |
| Codec | String | H.264 |
The video codec format. Valid values: H.264 and H.265. Default value: H.264. |
| Height | String | 720 |
The height of the video.
|
| Qscale | String | 15 |
The level of quality control on the video. |
| Bitrate | String | 1000 |
The average bitrate of the video. Unit: Kbit/s. |
| Maxrate | String | 2000 |
The maximum video bitrate.
|
| Profile | String | high |
The codec profile. Valid values:
|
| Crf | String | 26 |
The constant rate factor, which is the default quality control setting.
|
| Gop | String | 250 |
The maximum number of frames between two keyframes. Default value: 250. |
| Width | String | 1280 |
The width of the video.
|
| Fps | String | 25 |
The frame rate.
|
| Preset | String | medium |
The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium. |
| ScanMode | String | interlaced |
The scan mode. Valid values:
|
| TransConfig | Object |
The general transcoding configuration. |
|
| TransMode | String | onepass |
The transcoding mode. Default value: onepass. Valid values:
|
| State | String | Normal |
The status of the template. Valid values:
|
| MuxConfig | Object |
The transmuxing configuration. |
|
| Gif | Object |
The GIF format. |
|
| FinalDelay | String | 0 |
The interval between two consecutive loops for the GIF format. Unit: 0.01s. For example, a value of 500 indicates 5 seconds. |
| Loop | String | 0 |
The number of loops for the GIF or WebP format. Default value: 0. |
| Segment | Object |
The segment configuration. |
|
| Duration | String | 10 |
The length of the segment. Unit: seconds. |
| Name | String | FLV-UD |
The name of the template. |
| Audio | Object |
The audio codec configuration. |
|
| Profile | String | aac_low |
The codec profile of the audio file. Valid values when the Codec parameter is set to aac:
|
| Codec | String | aac |
The audio codec format. Default value: aac. Valid values:
|
| Samplerate | String | 44100 |
The sampling rate.
|
| Qscale | String | 15 |
The level of quality control on the audio. |
| Channels | String | 2 |
The number of sound channels. Default value: 2. |
| Bitrate | String | 128 |
The audio bitrate of the output file.
|
| Id | String | S00000000-00**** |
The ID of the transcoding template. |
| Container | Object |
The container configuration. |
|
| Format | String | flv |
The container format. |
| UserData | String | testid-001 |
The custom data. |
| Code | String | InvalidParameter.ResourceNotFound |
The error code returned when the job fails. |
| InputFile | Object |
The information about the job input. |
|
| Object | String | example.flv |
The name of the input file uploaded to the Object Storage Service (OSS) bucket. |
| Location | String | oss-cn-hangzhou |
The ID of the OSS region. |
| Bucket | String | example-bucket |
The name of the OSS bucket to which the input file is uploaded. |
| PipelineId | String | bb558c1cc25b45309aab5be44d19**** |
The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is added. |
| Id | String | 57f6aa3f84824309bcba67231b406**** |
The ID of the template analysis job. |
| NonExistAnalysisJobIds | Array of String | null |
The IDs of the template analysis jobs that do not exist. If all queried job IDs exist, the response does not contain this parameter. |
Examples
Sample requests
http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QueryAnalysisJobList
&AnalysisJobIds=bb558c1cc25b45309aab5be44d19****
&<Common request parameters>
Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<QueryAnalysisJobListResponse>
<RequestId>5CA6E020-4102-4FFF-AA56-5ED7ECD811A1</RequestId>
<AnalysisJobList>
<CreationTime>2014-01-10T12:00:00Z</CreationTime>
<Percent>86</Percent>
<State>Success</State>
<AnalysisConfig>
<QualityControl>
<MethodStreaming>network</MethodStreaming>
<RateQuality>25</RateQuality>
</QualityControl>
<PropertiesControl>
<Deinterlace>Auto</Deinterlace>
<Crop>
<Top>8</Top>
<Width>8</Width>
<Height>8</Height>
<Left>8</Left>
<Mode>Auto</Mode>
</Crop>
</PropertiesControl>
</AnalysisConfig>
<Message>The resource operated \"PipelineId\" cannot be found</Message>
<Priority>8</Priority>
<MNSMessageResult>
<MessageId>3ca84a39a9024f19853b21be9cf9****</MessageId>
</MNSMessageResult>
<TemplateList>
<Video>
<Bufsize>6000</Bufsize>
<Degrain>5</Degrain>
<BitrateBnd>
<Max>1500</Max>
<Min>800</Min>
</BitrateBnd>
<PixFmt>yuv420p</PixFmt>
<Codec>H.264</Codec>
<Height>720</Height>
<Qscale>15</Qscale>
<Bitrate>1000</Bitrate>
<Maxrate>2000</Maxrate>
<Profile>high</Profile>
<Crf>26</Crf>
<Gop>250</Gop>
<Width>1280</Width>
<Fps>25</Fps>
<Preset>medium</Preset>
<ScanMode>interlaced</ScanMode>
</Video>
<TransConfig>
<TransMode>onepass</TransMode>
</TransConfig>
<State>Normal</State>
<MuxConfig>
<Gif>
<FinalDelay>0</FinalDelay>
<Loop>0</Loop>
</Gif>
<Segment>
<Duration>10</Duration>
</Segment>
</MuxConfig>
<Name>FLV-UD</Name>
<Audio>
<Profile>aac_low</Profile>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Qscale>15</Qscale>
<Channels>2</Channels>
<Bitrate>128</Bitrate>
</Audio>
<Id>S00000000-00****</Id>
<Container>
<Format>flv</Format>
</Container>
</TemplateList>
<UserData>testid-001</UserData>
<InputFile>
<Object>example.flv</Object>
<Location>oss-cn-hangzhou</Location>
<Bucket>example-bucket</Bucket>
</InputFile>
<PipelineId>bb558c1cc25b45309aab5be44d19****</PipelineId>
<Id>57f6aa3f84824309bcba67231b406****</Id>
</AnalysisJobList>
<NonExistAnalysisJobIds>null</NonExistAnalysisJobIds>
</QueryAnalysisJobListResponse>
JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "5CA6E020-4102-4FFF-AA56-5ED7ECD811A1",
"AnalysisJobList": [
{
"CreationTime": "2014-01-10T12:00:00Z",
"Percent": 86,
"State": "Success",
"AnalysisConfig": {
"QualityControl": {
"MethodStreaming": "network",
"RateQuality": "25"
},
"PropertiesControl": {
"Deinterlace": "Auto",
"Crop": {
"Top": "8",
"Width": "8",
"Height": "8",
"Left": "8",
"Mode": "Auto"
}
}
},
"Message": "The resource operated \\\"PipelineId\\\" cannot be found",
"Priority": "8",
"MNSMessageResult": {
"MessageId": "3ca84a39a9024f19853b21be9cf9****",
},
"TemplateList": [
{
"Video": {
"Bufsize": "6000",
"Degrain": "5",
"BitrateBnd": {
"Max": "1500",
"Min": "800"
},
"PixFmt": "yuv420p",
"Codec": "H.264",
"Height": "720",
"Qscale": "15",
"Bitrate": "1000",
"Maxrate": "2000",
"Profile": "high",
"Crf": "26",
"Gop": "250",
"Width": "1280",
"Fps": "25",
"Preset": "medium",
"ScanMode": "interlaced"
},
"TransConfig": {
"TransMode": "onepass"
},
"State": "Normal",
"MuxConfig": {
"Gif": {
"FinalDelay": "0",
"Loop": "0"
},
"Segment": {
"Duration": "10"
}
},
"Name": "FLV-UD",
"Audio": {
"Profile": "aac_low",
"Codec": "aac",
"Samplerate": "44100",
"Qscale": "15",
"Channels": "2",
"Bitrate": "128"
},
"Id": "S00000000-00****",
"Container": {
"Format": "flv"
}
}
],
"UserData": "testid-001",
"InputFile": {
"Object": "example.flv",
"Location": "oss-cn-hangzhou",
"Bucket": "example-bucket"
},
"PipelineId": "bb558c1cc25b45309aab5be44d19****",
"Id": "57f6aa3f84824309bcba67231b406****"
}
],
"NonExistAnalysisJobIds": [
"null"
]
}
Error codes
For a list of error codes, visit the API Error Center.