All Products
Search
Document Center

ApsaraVideo Media Processing:QueryAnalysisJobList

Last Updated:Mar 03, 2024

The IDs of the template analysis jobs.

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AnalysisJobIdsstringYes

The transcoding progress.

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
AnalysisJobListobject []

The job configuration.

CreationTimestring

The quality control on the job output.

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

The playback mode. Valid values:

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

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

Success
AnalysisConfigobject

The control on the attributes of the job output.

QualityControlobject

Indicates 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.
MethodStreamingstring

The cropping configuration of video images.

network
RateQualitystring

The top margin that was cropped out.

Note This parameter is invalid if the Mode parameter is set to Auto or None.
25
PropertiesControlobject

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.
Deinterlacestring

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.
Auto
Cropobject

The left margin that was cropped out.

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

The cropping mode. Valid values: 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 object.
8
Widthstring

The error message returned when the job fails.

8
Heightstring

The priority of the job in the MPS queue to which the job is added.

  • Valid values: 1 to 10. A value of 10 indicates the highest priority.
  • Default value: 10.
8
Leftstring

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

8
Modestring

The ID of the success message. This parameter is not returned if the job fails.

Auto
Messagestring

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

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

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

8
MNSMessageResultobject

The list of matched preset templates.

MessageIdstring

The video codec configuration.

3ca84a39a9024f19853b21be9cf9****
ErrorMessagestring

The size of the buffer.

  • Unit: KB.
  • Default value: 6000.
The resource operated \"PipelineId\" cannot be found
ErrorCodestring

The level of the independent denoising algorithm.

InvalidParameter.ResourceNotFound
TemplateListobject []

The average bit rate range of the video.

Videoobject

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

Bufsizestring

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

6000
Degrainstring

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

5
BitrateBndobject

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

Maxstring

The height of the video.

  • Unit: pixel.
  • Default value: the original height of the video.
1500
Minstring

The level of quality control on the video.

800
PixFmtstring

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

yuv420p
Codecstring

The maximum video bitrate.

  • Valid values: 10 to 50000.
  • Unit: Kbit/s.
H.264
Heightstring

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.
720
Qscalestring

The constant rate factor, which is the default quality control setting.

  • Default value when the Codec parameter is set to H.264: 23. Default value when the Codec parameter is set to H.265: 26.
  • If this parameter is returned, the setting of the Bitrate parameter is invalid.
15
Bitratestring

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

1000
Maxratestring

The width of the video.

  • Unit: pixel.
  • Default value: the original width of the video.
2000
Profilestring

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.
high
Crfstring

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

26
Gopstring

The scan mode. Valid values:

  • interlaced: An interlaced scan was performed.
  • progressive: A progressive scan was performed.
250
Widthstring

The general transcoding configuration.

1280
Fpsstring

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

  • onepass
  • twopass
  • CBR
25
Presetstring

The status of the template. Valid values:

  • Normal: The template is in the normal state.
  • Deleted: The template is deleted.
medium
ScanModestring

The transmuxing configuration.

interlaced
TransConfigobject

The GIF format.

TransModestring

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

onepass
Statestring

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

Normal
MuxConfigobject

The segment configuration.

Gifobject

The length of the segment. Unit: seconds.

FinalDelaystring

The name of the template.

0
Loopstring

The audio codec configuration.

0
Segmentobject

The codec profile of the audio file. Valid values when the Codec parameter is set to aac:

  • aac_low
  • aac_he
  • aac_he_v2
  • aac_ld
  • aac_eld
Durationstring

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

  • aac
  • mp3
  • vorbis
  • flac
10
Namestring

The sampling rate.

  • Unit: Hz.
  • Default value: 44100.
FLV-UD
Audioobject

The level of quality control on the audio.

Profilestring

The number of sound channels. Default value: 2.

aac_low
Codecstring

The audio bitrate of the output file.

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

The ID of the transcoding template.

44100
Qscalestring

The container configuration.

15
Channelsstring

The container format.

2
Bitratestring

The custom data.

128
Idstring

The error code returned when the job fails.

S00000000-00****
Containerobject

The information about the job input.

Formatstring

The name of the input file uploaded to the Object Storage Service (OSS) bucket.

flv
UserDatastring

The ID of the OSS region.

testid-001
Codestring

The name of the OSS bucket to which the input file is uploaded.

InvalidParameter.ResourceNotFound
InputFileobject

The ID of the ApsaraVideo Media Processing (MPS) queue to which the job is added.

Objectstring

The ID of the template analysis job.

example.flv
Locationstring

The IDs of the template analysis jobs that do not exist. If all queried job IDs exist, the response does not contain this parameter.

oss-cn-hangzhou
Bucketstring

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.

example-bucket
PipelineIdstring

The level of quality control on the video.

bb558c1cc25b45309aab5be44d19****
Idstring

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.
57f6aa3f84824309bcba67231b406****
NonExistAnalysisJobIdsarray

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

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