QueryMediaInfoJobList - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Queries media information analysis jobs.

Operation description

In asynchronous mode, media information can be queried only after a successful Message Service (MNS) callback is received for the SubmitMediaInfoJob operation. If the media information cannot be queried after a long period, the media information analysis job may have failed.
You can query a maximum of 10 media information analysis jobs at a time.
By default, the returned results are sorted by CreationTime in descending order.

QPS limits

The queries per second (QPS) limit for this API operation is 100 per user. API calls that exceed this limit are subject to rate limiting, which may affect your business. Plan your API calls accordingly. For more information, see QPS limits.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaInfoJobIds	string	Yes	The ID of the media information analysis job. You can query up to 10 jobs at a time. Separate multiple job IDs with commas (,). You can obtain the job ID from the response parameters of the SubmitMediaInfoJob operation. Note If you do not specify this parameter, the InvalidParameter error code is returned.	23ca1d184c0e4341e5b665e2a12****

Response elements

Element	Type	Description	Example
	object
NonExistMediaInfoJobIds	object
String	array	The media information analysis jobs that do not exist.
	string	A list of IDs of the media information analysis jobs that do not exist. This parameter is not returned if no data is available.	11ce1d184c0e4341e5b665e2a12****
RequestId	string	The request ID.	46A04AA5-B119-41BB-B750-7C5327AC3E7A
MediaInfoJobList	object
MediaInfoJob	array<object>	The list of media information analysis jobs.
	array<object>
CreationTime	string	The time when the job was created.	2014-01-10T12:00:00Z
State	string	The status of the job. Analyzing: The job is being analyzed. Success: The analysis is successful. Fail: The analysis failed.	Success
JobId	string	The ID of the media information analysis job.	23ca1d184c0e4341e5b665e2a12****
UserData	string	The custom user data.	testid-001
Code	string	The error code returned when the media information analysis fails.	InvalidParameter.JsonObjectFormatInvalid
Message	string	The error message returned when the media information analysis fails.	The parameter ”*” does not conform to the JSON Object specification
PipelineId	string	The ID of the MPS queue.	88c6ca184c0e432bbf5b665e2a15****
Async	boolean	Indicates whether the job is asynchronous.	true
Input	object	The job input.
Object	string	The OSS object.	example.mp4
Location	string	The OSS region.	oss-cn-hangzhou
Bucket	string	The OSS bucket where the input file is stored.	example-bucket
MNSMessageResult	object	The result of the MNS message that is sent to notify the user that the job is complete.
MessageId	string	The message ID. This parameter is returned if the operation is successful. It is not returned if the operation fails.	123
ErrorMessage	string	The error message. This parameter is returned if the operation fails. It is not returned if the operation is successful.	The parameter \"Input\" does not conform to the JSON Object specification
ErrorCode	string	The error code. This parameter is returned if the operation fails. It is not returned if the operation is successful.	InvalidParameter.JsonObjectFormatInvalid
Properties	object	The detailed properties of the media. For more information, see AliyunProperties data type.
Width	string	The width of the video in pixels.	1280
Height	string	The height of the video in pixels.	720
Duration	string	The duration.	17.226000
Fps	string	The frame rate.	25
Bitrate	string	The bitrate.	1630.045
FileFormat	string	The file format.	QuickTime/MOV
Streams	object	The stream information.
VideoStreamList	object
VideoStream	array<object>	The list of video stream information.
	array<object>
Sar	string	The sample aspect ratio.	1:1
Height	string	The height of the video.	1080
CodecTagString	string	The text of the encoding format tag.	[0][0][0][0]
NetworkCost	object	The network bandwidth consumption.
PreloadTime	string	The preload time.	8
AvgBitrate	string	The average bitrate.	300.34
CostBandwidth	string	The maximum bandwidth consumed.	10
Width	string	The width of the video.	1920
Index	string	The sequence number of the video stream. It indicates the position of the video stream in the entire media stream.	1
Timebase	string	The time base.	1/1000
AvgFPS	string	The average frame rate.	23.976025
PixFmt	string	The pixel format.	yuv420p
Lang	string	The language.	eng
CodecLongName	string	The long name of the encoding format.	H.264/AVC/MPEG-4 AVC/MPEG-4 part 10
NumFrames	string	The total number of frames.	100
Rotate	string	The rotation angle of the video.	180
Bitrate	string	The bitrate.	30541090
HasBFrames	string	Indicates whether B-frames exist. A value of 0 means no B-frames. A value of 1 means B-frames exist.	0
Profile	string	The codec profile.	High
StartTime	string	The start time.	0.042000
Dar	string	The display aspect ratio.	16:9
CodecName	string	The short name of the encoding format. Valid values: h264 h265 gif webp	h264
Duration	string	The duration.	100
Fps	string	The frame rate.	25
CodecTag	string	The encoding format tag.	0x0000
CodecTimeBase	string	The codec time base.	1001/48000
Level	string	The encoding level.	41
ColorRange	string	The color range.	700
ColorTransfer	string	The color transfer characteristic.	R255 G83 B170
ColorPrimaries	string	The color primaries.	700
DurationInaccurate	string
DolbyVision	object
Profile	string
Level	string
AudioStreamList	object
AudioStream	array<object>	The list of audio stream information.
	object
Timebase	string	The time base.	1/1000
Index	string	The sequence number of the audio stream. It indicates the position of the audio stream in the entire media stream.	1
SampleFmt	string	The sampling format.	fltp
ChannelLayout	string	The number of sound channels.	5.1(side)
Lang	string	The language. For more information, see FFmpeg language definitions.	eng
Samplerate	string	The sample rate.	48000
CodecLongName	string	The long name of the encoding format.	DCA (DTS Coherent Acoustics)
Channels	string	The sound channel output style.	2
NumFrames	string	The total number of frames.	123
Bitrate	string	The bitrate.	1536000
CodecTagString	string	The text of the encoding format tag.	[0][0][0][0]
StartTime	string	The start time.	0.042000
CodecName	string	The short name of the encoding format. Valid values: acc mp3 mp4 ogg flac	acc
Duration	string	The duration.	123
CodecTag	string	The encoding format tag.	0x0000
CodecTimeBase	string	The codec time base.	1/48000
DurationInaccurate	string
SubtitleStreamList	object
SubtitleStream	array<object>	The list of caption stream information.
	object
Timebase	string	The time base.	1/1000
Index	string	The sequence number of the caption stream. It indicates the position of the caption stream in the entire media stream.	3
StartTime	string	The start time.	0.000000
CodecName	string	The short name of the encoding format. Valid values: srt ass	ass
Lang	string	The language.	eng
CodecLongName	string	The long name of the encoding format.	ASS (Advanced SSA) subtitle
Duration	string	The duration in seconds (s).	1370.116000
CodecTag	string	The encoding format tag.	0x0000
CodecTimeBase	string	The codec time base.	0/1
CodecTagString	string	The text of the encoding format tag.	[0][0][0][0]
Format	object	The format information.
StartTime	string	The start time.	0.042000
NumPrograms	string	The total number of program streams.	2
Size	string	The file size.	3509895
NumStreams	string	The total number of media streams.	1
FormatLongName	string	The long name of the container format.	QuickTime/MOV
Duration	string	The total duration.	17.226000
Bitrate	string	The total bitrate.	1630.045
FormatName	string	The short name of the container format.	mov
Tags	object
FileSize	string	The file size.	3509895
FileMd5	string

Callback message format

When the execution status of a media information analysis job changes, ApsaraVideo Media Processing (MPS) sends a message to the queue that you specify. For information about how to specify a callback queue, see the UpdatePipeline API operation. The message body is a JSON string that contains the following fields:

{
  "Type": "MediaInfo",
  "State": "Success",
  "JobId": "bb558c1cc25b45309aab5be44d19****",
  "UserData": "{\"key\":\"value\"}",
  "RequestId": "B52658D4-07AB-43CD-82B0-210958A6****"
}

Name	Type	Description
Type	String	The fixed string "MediaInfo", which indicates a media information analysis job.
JobId	String	The unique ID of the job.
State	String	The current status of the job. It is the same as the State parameter in QueryMediaInfoJobList.
UserData	String	The UserData that you pass in SubmitMediaInfoJob.

Examples

Success response

JSON format

{
  "NonExistMediaInfoJobIds": {
    "String": [
      "11ce1d184c0e4341e5b665e2a12****"
    ]
  },
  "RequestId": "46A04AA5-B119-41BB-B750-7C5327AC3E7A",
  "MediaInfoJobList": {
    "MediaInfoJob": [
      {
        "CreationTime": "2014-01-10T12:00:00Z",
        "State": "Success",
        "JobId": "23ca1d184c0e4341e5b665e2a12****",
        "UserData": "testid-001",
        "Code": "InvalidParameter.JsonObjectFormatInvalid",
        "Message": "The parameter ”*” does not conform to the JSON Object specification",
        "PipelineId": "88c6ca184c0e432bbf5b665e2a15****",
        "Async": true,
        "Input": {
          "Object": "example.mp4",
          "Location": "oss-cn-hangzhou",
          "Bucket": "example-bucket"
        },
        "MNSMessageResult": {
          "MessageId": "123",
          "ErrorMessage": "The parameter \\\"Input\\\" does not conform to the JSON Object specification",
          "ErrorCode": "InvalidParameter.JsonObjectFormatInvalid"
        },
        "Properties": {
          "Width": "1280",
          "Height": "720",
          "Duration": "17.226000",
          "Fps": "25",
          "Bitrate": "1630.045",
          "FileFormat": "QuickTime/MOV",
          "Streams": {
            "VideoStreamList": {
              "VideoStream": [
                {
                  "Sar": "1:1",
                  "Height": "1080",
                  "CodecTagString": "[0][0][0][0]",
                  "NetworkCost": {
                    "PreloadTime": "8",
                    "AvgBitrate": "300.34",
                    "CostBandwidth": "10"
                  },
                  "Width": "1920",
                  "Index": "1",
                  "Timebase": "1/1000",
                  "AvgFPS": "23.976025",
                  "PixFmt": "yuv420p",
                  "Lang": "eng",
                  "CodecLongName": "H.264/AVC/MPEG-4 AVC/MPEG-4 part 10",
                  "NumFrames": "100",
                  "Rotate": "180",
                  "Bitrate": "30541090",
                  "HasBFrames": "0",
                  "Profile": "High",
                  "StartTime": "0.042000",
                  "Dar": "16:9",
                  "CodecName": "h264",
                  "Duration": "100",
                  "Fps": "25",
                  "CodecTag": "0x0000",
                  "CodecTimeBase": "1001/48000",
                  "Level": "41",
                  "ColorRange": "700",
                  "ColorTransfer": "R255 G83 B170",
                  "ColorPrimaries": "700",
                  "DurationInaccurate": "",
                  "DolbyVision": {
                    "Profile": "",
                    "Level": ""
                  }
                }
              ]
            },
            "AudioStreamList": {
              "AudioStream": [
                {
                  "Timebase": "1/1000",
                  "Index": "1",
                  "SampleFmt": "fltp",
                  "ChannelLayout": "5.1(side)",
                  "Lang": "eng",
                  "Samplerate": "48000",
                  "CodecLongName": "DCA (DTS Coherent Acoustics)",
                  "Channels": "2",
                  "NumFrames": "123",
                  "Bitrate": "1536000",
                  "CodecTagString": "[0][0][0][0]",
                  "StartTime": "0.042000",
                  "CodecName": "acc",
                  "Duration": "123",
                  "CodecTag": "0x0000",
                  "CodecTimeBase": "1/48000",
                  "DurationInaccurate": ""
                }
              ]
            },
            "SubtitleStreamList": {
              "SubtitleStream": [
                {
                  "Timebase": "1/1000",
                  "Index": "3",
                  "StartTime": "0.000000",
                  "CodecName": "ass",
                  "Lang": "eng",
                  "CodecLongName": "ASS (Advanced SSA) subtitle",
                  "Duration": "1370.116000",
                  "CodecTag": "0x0000",
                  "CodecTimeBase": "0/1",
                  "CodecTagString": "[0][0][0][0]"
                }
              ]
            }
          },
          "Format": {
            "StartTime": "0.042000",
            "NumPrograms": "2",
            "Size": "3509895",
            "NumStreams": "1",
            "FormatLongName": "QuickTime/MOV",
            "Duration": "17.226000",
            "Bitrate": "1630.045",
            "FormatName": "mov",
            "Tags": {
              "test": "test",
              "test2": 1
            }
          },
          "FileSize": "3509895",
          "FileMd5": ""
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.