Query template analysis jobs using QueryAnalysisJobList - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries template analysis jobs and returns available preset templates after analysis completes.

Operation description

The time when the job was created.

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:QueryAnalysisJobList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AnalysisJobIds	string	Yes	The IDs of template analysis jobs.	bb558c1cc25b45309aab5be44d19****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The status of the job. Valid values: Submitted: The job has been submitted. Analyzing: The job is being run. Success: The job is successful. Fail: The job fails.	5CA6E020-4102-4FFF-AA56-5ED7ECD811A1
AnalysisJobList	object
AnalysisJob	array<object>	The IDs of template analysis jobs.
	array<object>
CreationTime	string	The time when the job was created.	2014-01-10T12:00:00Z
Percent	integer	The transcoding progress.	86
State	string	The job status. Submitted: The job was submitted. Analyzing: The job is in progress. Success: The job was successful. Fail: The job failed.	Success
AnalysisConfig	object	The job configurations.
QualityControl	object	The output quality control settings.
MethodStreaming	string	The playback mode. Valid values: network: online playback. local: playback on on-premises devices. Default value: network.	network
RateQuality	string	The quality level of the job output. Default value: 25.	25
PropertiesControl	object	The output attribute control settings.
Deinterlace	string	The deinterlacing mode. Valid values: Auto: Deinterlacing was automatically run. Force: Deinterlacing was forced to run. None: Deinterlacing was forced not to run.	Auto
Crop	object	The cropping configuration of the video image.
Top	string	The top margin to be cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.	8
Width	string	The width of the video image after the margins are cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.	8
Height	string	The height of the video image after the margins are cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.	8
Left	string	The left margin to be cropped out. Note This parameter is invalid if the Mode parameter is set to Auto or None.	8
Mode	string	The cropping mode. Valid values: Auto: Cropping was automatically run. Force: Cropping was forced to run. None: Cropping was forced not to run. This parameter is required if the value of the Crop parameter is not an empty JSON {}.	Auto
Message	string	The error message returned if the job failed.	The resource operated \"PipelineId\" cannot be found
Priority	string	The job priority in the MPS queue. Valid values: 1 to 10. The value 10 indicates the highest priority. Default value: 10.	8
MNSMessageResult	object	The MNS notification message for the job result.
MessageId	string	The message ID. Returned only if the job succeeded.	3ca84a39a9024f19853b21be9cf9****
ErrorMessage	string	The error message. Returned only if the job failed.	The resource operated \"PipelineId\" cannot be found
ErrorCode	string	The error code. Returned only if the job failed.	InvalidParameter.ResourceNotFound
TemplateList	object
Template	array<object>	The matched preset templates.
	array<object>
Video	object	The video codec configurations.
Bufsize	string	The buffer size. Unit: KB. Default value: 6000.	6000
Degrain	string	The strength of the independent noise reduction algorithm.	5
BitrateBnd	object	The average bitrate range of the video.
Max	string	The upper limit of the total bitrate. Unit: Kbit/s.	1500
Min	string	The lower limit of the total bitrate. Unit: Kbit/s.	800
PixFmt	string	The video pixel format, such as yuv420p and yuvj420p.	yuv420p
Codec	string	The codec. Valid values: H.264 and H.265. Default value: H.264.	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
Bitrate	string	The average bitrate of the video. Unit: Kbit/s.	1000
Maxrate	string	The maximum bitrate of the video. Valid values: 10 to 50000. Unit: Kbit/s.	2000
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. Default value: 23 (H.264) or 26 (H.265). If specified, the Bitrate parameter is ignored.	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 of the video. The value is 60 if the frame rate of the input file exceeds 60. Default value: the frame rate of the input video.	25
Preset	string	The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.	medium
ScanMode	string	The scan mode. Valid values: interlaced progressive	interlaced
TransConfig	object	The general transcoding configurations.
TransMode	string	The transcoding mode. Default value: onepass. Valid values: onepass twopass CBR	onepass
State	string	The state of the template. Valid values: Normal Deleted	Normal
MuxConfig	object	The transmuxing configurations.
Gif	object	The transmuxing configurations for the GIF format.
FinalDelay	string	The delay between loop iterations for GIF. Unit: 0.01 seconds (for example, 500 = 5 seconds).	0
Loop	string	The loop count for GIF or WebP. Default value: 0.	0
Segment	object	The segment configurations.
Duration	string	The segment length. Unit: seconds.	10
Name	string	The name of the template.	FLV-UD
Audio	object	The audio codec configurations.
Profile	string	The codec profile of the audio. Valid values when the Codec parameter is set to aac: aac_low aac_he aac_he_v2 aac_ld aac_eld	aac_low
Codec	string	The audio codec. Default value: aac. Valid values: aac mp3 vorbis flac	aac
Samplerate	string	The sampling rate. Unit: Hz. Default value: 44100.	44100
Qscale	string	The level of quality control on the audio.	15
Channels	string	The number of sound channels. Default value: 2.	2
Bitrate	string	The audio bitrate of the output file. Valid values: 8 to 1000. Unit: Kbit/s. Default value: 128.	128
Id	string	The transcoding template ID.	S00000000-00****
Container	object	The container format configurations.
Format	string	The container format.	flv
UserData	string	The custom data.	testid-001
Code	string	The error code returned if the job fails.	InvalidParameter.ResourceNotFound
InputFile	object	The information about the job input.
Object	string	The OSS object used as the input file.	example.flv
Location	string	The region in which OSS resides.	oss-cn-hangzhou
Bucket	string	The OSS bucket that stores the input file.	example-bucket
PipelineId	string	The MPS queue ID.	bb558c1cc25b45309aab5be44d19****
Id	string	The ID of the template analysis job.	57f6aa3f84824309bcba67231b406****
NonExistAnalysisJobIds	object
String	array	The message sent by Message Service (MNS) to notify the user of the job result.
	string	The operation that you want to perform. Set the value to QueryAnalysisJobList.	null

Examples

Success response

JSON format

{
  "RequestId": "5CA6E020-4102-4FFF-AA56-5ED7ECD811A1",
  "AnalysisJobList": {
    "AnalysisJob": [
      {
        "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****",
          "ErrorMessage": "The resource operated \\\"PipelineId\\\" cannot be found",
          "ErrorCode": "InvalidParameter.ResourceNotFound"
        },
        "TemplateList": {
          "Template": [
            {
              "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",
        "Code": "InvalidParameter.ResourceNotFound",
        "InputFile": {
          "Object": "example.flv",
          "Location": "oss-cn-hangzhou",
          "Bucket": "example-bucket"
        },
        "PipelineId": "bb558c1cc25b45309aab5be44d19****",
        "Id": "57f6aa3f84824309bcba67231b406****"
      }
    ]
  },
  "NonExistAnalysisJobIds": {
    "String": [
      "null"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.