All Products
Search
Document Center

ApsaraVideo Media Processing:QueryAnalysisJobList

Last Updated:Sep 27, 2024

Queries the template analysis job and returns a list of available preset templates when the template analysis job is complete.

Operation description

The time when the job was created.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
mts:QueryAnalysisJobListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AnalysisJobIdsstringYes

The template analysis job ID list.

bb558c1cc25b45309aab5be44d19****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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
AnalysisJobListarray<object>

The IDs of template analysis jobs.

AnalysisJobobject
CreationTimestring

The time when the job was created.

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

The transcoding progress.

86
Statestring

The job status.

  • Submitted: The job was submitted.
  • Analyzing: The job is in progress.
  • Success: The job was successful.
  • Fail: The job failed.
Success
AnalysisConfigobject

The job configurations.

QualityControlobject

The quality control on the job output.

MethodStreamingstring

The playback mode. Valid values:

  • network: online playback.
  • local: playback on on-premises devices.
  • Default value: network.
network
RateQualitystring

The quality level of the job output. Default value: 25.

25
PropertiesControlobject

The control on the attributes of the job output.

Deinterlacestring

Specifies whether deinterlacing was forced to run. Valid values:

  • Auto: Deinterlacing was automatically run.
  • Force: Deinterlacing was forced to run.
  • None: Deinterlacing was forced not to run.
Auto
Cropobject

The cropping configuration of the video image.

Topstring

The top margin to be cropped out.

Note This parameter is invalid if the Mode parameter is set to Auto or None.
8
Widthstring

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
Heightstring

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
Leftstring

The left margin to be cropped out.

Note This parameter is invalid if the Mode parameter is set to Auto or None.
8
Modestring

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
Messagestring

The error message returned if the job failed.

The resource operated \"PipelineId\" cannot be found
Prioritystring

The priority of the job in the ApsaraVideo Media Processing (MPS) queue to which the job was submitted.

  • Valid values: 1 to 10. The value 10 indicates the highest priority.
  • Default value: 10.
8
MNSMessageResultobject

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

MessageIdstring

The ID of the message returned if the job was successful. This parameter is not returned if the job failed.

3ca84a39a9024f19853b21be9cf9****
ErrorMessagestring

The error message returned if the job failed. This parameter is not returned if the job was successful.

The resource operated \"PipelineId\" cannot be found
ErrorCodestring

The error code returned if the job failed. This parameter is not returned if the job was successful.

InvalidParameter.ResourceNotFound
TemplateListarray<object>

The matched preset templates.

Templateobject
Videoobject

The video codec configurations.

Bufsizestring

The buffer size.

  • Unit: KB.
  • Default value: 6000.
6000
Degrainstring

The strength of the independent noise reduction algorithm.

5
BitrateBndobject

The average bitrate range of the video.

Maxstring

The upper limit of the total bitrate. Unit: Kbit/s.

1500
Minstring

The lower limit of the total bitrate. Unit: Kbit/s.

800
PixFmtstring

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

yuv420p
Codecstring

The codec. Valid values: H.264 and H.265. Default value: H.264.

H.264
Heightstring

The height of the video.

  • Unit: pixel.
  • Default value: the height of the input video.
720
Qscalestring

The level of quality control on the video.

15
Bitratestring

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

1000
Maxratestring

The maximum bitrate of the video.

  • Valid values: 10 to 50000.
  • Unit: Kbit/s.
2000
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.

  • Default value when the the Codec parameter is set to H.264: 23, default value when the the Codec parameter is set to H.265: 26.
  • If this parameter is specified, the value of the Bitrate parameter becomes invalid.
26
Gopstring

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

250
Widthstring

The width of the video.

  • Unit: pixel.
  • Default value: the width of the input video.
1280
Fpsstring

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
Presetstring

The preset video algorithm. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.

medium
ScanModestring

The scan mode. Valid values:

  • interlaced
  • progressive
interlaced
TransConfigobject

The general transcoding configurations.

TransModestring

The transcoding mode. Default value: onepass. Valid values:

  • onepass
  • twopass
  • CBR
onepass
Statestring

The state of the template. Valid values:

  • Normal
  • Deleted
Normal
MuxConfigobject

The transmuxing configurations.

Gifobject

The transmuxing configurations for the GIF format.

FinalDelaystring

The interval between two consecutive loops for the GIF format. Unit: 0.01 second. For example, a value of 500 indicates 5 seconds.

0
Loopstring

The number of loops for the GIF or WebP format. Default value: 0.

0
Segmentobject

The segment configurations.

Durationstring

The segment length. Unit: seconds.

10
Namestring

The name of the template.

FLV-UD
Audioobject

The audio codec configurations.

Profilestring

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
Codecstring

The audio codec. Default value: aac. Valid values:

  • aac
  • mp3
  • vorbis
  • flac
aac
Sampleratestring

The sampling rate.

  • Unit: Hz.
  • Default value: 44100.
44100
Qscalestring

The level of quality control on the audio.

15
Channelsstring

The number of sound channels. Default value: 2.

2
Bitratestring

The audio bitrate of the output file.

  • Valid values: 8 to 1000.
  • Unit: Kbit/s.
  • Default value: 128.
128
Idstring

The transcoding template ID.

S00000000-00****
Containerobject

The container format configurations.

Formatstring

The container format.

flv
UserDatastring

The custom data.

testid-001
Codestring

The error code returned if the job fails.

InvalidParameter.ResourceNotFound
InputFileobject

The information about the job input.

Objectstring

The name of the Object Storage Service (OSS) object that is used as the input file.

example.flv
Locationstring

The region in which OSS resides.

oss-cn-hangzhou
Bucketstring

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

example-bucket
PipelineIdstring

The ID of the MPS queue to which the job was submitted.

bb558c1cc25b45309aab5be44d19****
Idstring

The ID of the template analysis job.

57f6aa3f84824309bcba67231b406****
NonExistAnalysisJobIdsarray

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

Stringstring

The operation that you want to perform. Set the value to QueryAnalysisJobList.

null

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history