QueryMediaList - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

You can call this operation to query media files by media ID.

Operation description

You can query a maximum of 10 media files at a time.

QPS limits

The queries per second (QPS) limit for this operation is 100 for each user. If the limit is exceeded, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate. 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:QueryMediaList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaIds	string	Yes	The IDs of the media files to query. To obtain the media IDs, log on to the MPS console and go to Media Management > Media List. Separate multiple IDs with a comma (,). You can query a maximum of 10 media files at a time.	3e1cd21131a94525be55acf65888**,e26cfa29e784402388463f61dbec**
IncludePlayList	boolean	No	Specifies whether to include the playback information in the response. Valid values: true and false. Default value: false.	true
IncludeSnapshotList	boolean	No	Specifies whether to include the snapshot information in the response. Valid values: true and false. Default value: false.	true
IncludeMediaInfo	boolean	No	Specifies whether to include the media information in the response. Valid values: true and false. Default value: false.	true
IncludeSummaryList	boolean	No	Specifies whether to include the summary in the response. Valid values: true and false. Default value: false.	true

Response elements

Element	Type	Description	Example
	object	The returned parameters.
NonExistMediaIds	object
MediaId	array	The list of non-existent media IDs.
	string	The non-existent media ID. This parameter is not returned if no data exists.	{"MediaId":[e26cfa29e784402388463f61dbec****]}
MediaList	object
Media	array<object>	The list of media files.
	array<object>	The details of the media file.
CreationTime	string	The time when the media file was created.	2016-09-14T08:30:33Z
CateId	integer	The category ID.	1
Height	string	The height of the media file.	1080
CensorState	string	The review state of the video. Valid values: Initiated: The video has been uploaded, but the review is not complete. Pass: The video has been uploaded and approved.	Initiated
Tags	object
Tag	array	The tag information.
	string	The list of tags.	tag1,tag2
PlayList	object
Play	array<object>	The playlist.
	array<object>	The details of the playback file.
Encryption	string	The encryption status. Valid values: 0: The file is not encrypted. 1: The file is encrypted.	0
Height	string	The height.	1080
Bitrate	string	The bitrate.	2659.326
File	object	The playback file.
State	string	The state of the file. Valid values: Normal: The file is normal. Deleted: The file is deleted.	Normal
URL	string	The OSS bucket of the output file.	http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com//example-**.mp4
MediaWorkflowId	string	The ID of the workflow that generates the playback file.	93ab850b4f6f44eab54b6e91d24d****
Width	string	The width of the media file.	760
Size	string	The file size.	2647692
Fps	string	The frame rate.	25.0
Duration	string	The duration.	7.965000
ActivityName	string	The name of the media workflow activity.	example-activity-****
Format	string	The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mp4
MediaWorkflowName	string	The workflow that generates the playback file.	example-mediaworkflow-****
Bitrate	string	The bitrate.	2659.326
MediaId	string	The media ID.	3e1cd21131a94525be55acf65888****
File	object	The details of the input file.
State	string	The state. Valid values: Normal: The file is normal. Deleted: The file is deleted.	Normal
URL	string	The OSS bucket of the input file.	http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com//example-**.mp4
SummaryList	object
Summary	array<object>	The list of video synopses.
	array<object>	The video synopsis data.
Type	string	The summary type. Valid values: Video: video. Gif: GIF.	Video
MediaWorkflowId	string	The ID of the workflow that generates the summary.	93ab850b4f6f44eab54b6e91d24d****
ActivityName	string	The name of the media workflow activity.	example-activity-****
MediaWorkflowName	string	The name of the workflow that generates the summary.	example-mediaworkflow-****
File	object	The information about the input file.
State	string	The state of the file. Valid values: Normal: The file is normal. Deleted: The file is deleted.	Normal
URL	string	The OSS bucket of the input file.	http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com//example-**.mp4
PublishState	string	The publishing state of the media file. This indicates whether the media file is published. Valid values: Initiated: initial state. UnPublish: The media file is not published. The permission on the OSS playback file is Private. Published: The media file is published. The permission on the OSS playback file is Default. Deleted: The media file is deleted.	Published
MediaInfo	object	The media information.
Streams	object	The stream information.
VideoStreamList	object
VideoStream	array<object>	The list of video streams.
	array<object>	The video stream data.
Sar	string	The sample aspect ratio (SAR).	1:1
Height	string	The height of the video.	1080
CodecTagString	string	The tag of the encoding format.	avc1
NetworkCost	object	The network bandwidth consumption.
PreloadTime	string	The preload time.	0.01
AvgBitrate	string	The average bitrate.	2659.326
CostBandwidth	string	The maximum bandwidth consumed.	100
Width	string	The width of the video.	100
Index	string	The sequence number of the video stream. This indicates the position of the video stream in the media stream.	5
Timebase	string	The time base.	1/30000
AvgFPS	string	The average frame rate.	29.97003
PixFmt	string	The pixel format.	yuv420p
Lang	string	The language. For more information, see FFmpeg language definitions.	und
CodecLongName	string	The long name of the encoding format.	QuickTime/MOV
NumFrames	string	The total number of frames.	12
Rotate	string	The rotation angle of the video.	90
Bitrate	string	The bitrate.	2659.326
HasBFrames	string	Indicates whether B-frames exist. 1: yes. 2: no.	2
Profile	string	The codec profile.	High
StartTime	string	The start time.	0.000000
Dar	string	The display aspect ratio (DAR).	16:9
CodecName	string	The short name of the encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov
Duration	string	The duration.	182.683000
Fps	string	The frame rate.	29.97003
CodecTag	string	The tag of the encoding format.	0x31637661
CodecTimeBase	string	The codec time base.	1001/60000
Level	string	The encoding level.	40
AudioStreamList	object
AudioStream	array<object>	The list of audio streams.
	object	The audio stream data.
Timebase	string	The time base.	1/44100
Index	string	The sequence number of the audio stream. This indicates the position of the audio stream in the media stream.	1
SampleFmt	string	The sampling format.	fltp
ChannelLayout	string	The layout of the sound channels.	stereo
Lang	string	The language. For more information, see FFmpeg language definitions.	und
Samplerate	string	The sample rate.	44100
CodecLongName	string	The long name of the encoding format.	AAC(Advanced Audio Coding)
Channels	string	The number of sound channels.	2
NumFrames	string	The total number of frames.	100
Bitrate	string	The bitrate.	160.008
CodecTagString	string	The tag of the encoding format.	mp4a
StartTime	string	The start time.	0.000000
CodecName	string	The short name of the encoding format. Valid values: H264, mov, aac, avc, and mpeg.	mov
Duration	string	The duration.	182.591995
CodecTag	string	The tag of the encoding format.	0x6134706d
CodecTimeBase	string	The codec time base.	1/44100
SubtitleStreamList	object
SubtitleStream	array<object>	The list of subtitle streams.
	object	The subtitle stream data.
Index	string	The sequence number of the subtitle stream. This indicates the position of the subtitle stream in the media stream.	3
Lang	string	The language. For more information, see FFmpeg language definitions.	und
Format	object	The format information.
StartTime	string	The start time.	0.000000
NumPrograms	string	The total number of program streams.	2
Size	string	The file size.	2647692
NumStreams	string	The total number of media streams.	2
FormatLongName	string	The long name of the container format.	QuickTime/MOV
Duration	string	The total duration.	7.965000
Bitrate	string	The bitrate.	2659.326
FormatName	string	The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov
Description	string	The description.	This is description ****
Size	string	The file size.	2647692
Width	string	The width.	1920
CoverURL	string	The OSS bucket of the thumbnail.	http://example-bucket1-**.oss-cn-hangzhou.aliyuncs.com//example-**.png
SnapshotList	object
Snapshot	array<object>	The list of snapshots.
	array<object>	The snapshot file data.
Type	string	The snapshot type. Valid values: Single: a single snapshot. Sequence: a sequence of snapshots.	Sequence
MediaWorkflowId	string	The ID of the workflow that generates the snapshot file.	6cc3aa66d1cb4bb2adf14e726c0a****
ActivityName	string	The name of the workflow activity that generates the snapshot file.	example-activity1-****
Count	string	The number of snapshots. This parameter is valid only when Type is set to Sequence.	5
MediaWorkflowName	string	The workflow that generates the snapshot file.	example-workflow-****
File	object	The snapshot file.
State	string	The state of the file. Valid values: Normal: The file is normal. Deleted: The file is deleted.	Normal
URL	string	The OSS bucket of the snapshot file.	http://example1-bucket1-**.oss-cn-hangzhou.aliyuncs.com//example111-**.png
RunIdList	object
RunId	array	The list of instances.
	string	The instance ID.	{"RunId":["47b42486019c4f688bf144c1a6ba****"]}
Duration	string	The duration.	7.965000
Fps	string	The frame rate.	25.0
Title	string	The title.	example-title-****
Format	string	The encoding format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov
RequestId	string	The request ID.	283DC68C-146F-4489-A2A1-2F88F1472A56

Examples

Success response

JSON format

{
  "NonExistMediaIds": {
    "MediaId": [
      "{\"MediaId\":[e26cfa29e784402388463f61dbec****]}"
    ]
  },
  "MediaList": {
    "Media": [
      {
        "CreationTime": "2016-09-14T08:30:33Z",
        "CateId": 1,
        "Height": "1080",
        "CensorState": "Initiated",
        "Tags": {
          "Tag": [
            "tag1,tag2"
          ]
        },
        "PlayList": {
          "Play": [
            {
              "Encryption": "0",
              "Height": "1080",
              "Bitrate": "2659.326",
              "File": {
                "State": "Normal",
                "URL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
              },
              "MediaWorkflowId": "93ab850b4f6f44eab54b6e91d24d****",
              "Width": "760",
              "Size": "2647692",
              "Fps": "25.0",
              "Duration": "7.965000",
              "ActivityName": "example-activity-****",
              "Format": "mp4",
              "MediaWorkflowName": "example-mediaworkflow-****"
            }
          ]
        },
        "Bitrate": "2659.326",
        "MediaId": "3e1cd21131a94525be55acf65888****",
        "File": {
          "State": "Normal",
          "URL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
        },
        "SummaryList": {
          "Summary": [
            {
              "Type": "Video",
              "MediaWorkflowId": "93ab850b4f6f44eab54b6e91d24d****",
              "ActivityName": "example-activity-****",
              "MediaWorkflowName": "example-mediaworkflow-****",
              "File": {
                "State": "Normal",
                "URL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
              }
            }
          ]
        },
        "PublishState": "Published",
        "MediaInfo": {
          "Streams": {
            "VideoStreamList": {
              "VideoStream": [
                {
                  "Sar": "1:1",
                  "Height": "1080",
                  "CodecTagString": "avc1",
                  "NetworkCost": {
                    "PreloadTime": "0.01",
                    "AvgBitrate": "2659.326",
                    "CostBandwidth": "100"
                  },
                  "Width": "100",
                  "Index": "5",
                  "Timebase": "1/30000",
                  "AvgFPS": "29.97003",
                  "PixFmt": "yuv420p",
                  "Lang": "und",
                  "CodecLongName": "QuickTime/MOV",
                  "NumFrames": "12",
                  "Rotate": "90",
                  "Bitrate": "2659.326",
                  "HasBFrames": "2",
                  "Profile": "High",
                  "StartTime": "0.000000",
                  "Dar": "16:9",
                  "CodecName": "mov",
                  "Duration": "182.683000",
                  "Fps": "29.97003",
                  "CodecTag": "0x31637661",
                  "CodecTimeBase": "1001/60000",
                  "Level": "40"
                }
              ]
            },
            "AudioStreamList": {
              "AudioStream": [
                {
                  "Timebase": "1/44100",
                  "Index": "1",
                  "SampleFmt": "fltp",
                  "ChannelLayout": "stereo",
                  "Lang": "und",
                  "Samplerate": "44100",
                  "CodecLongName": "AAC(Advanced Audio Coding)",
                  "Channels": "2",
                  "NumFrames": "100",
                  "Bitrate": "160.008",
                  "CodecTagString": "mp4a",
                  "StartTime": "0.000000",
                  "CodecName": "mov",
                  "Duration": "182.591995",
                  "CodecTag": "0x6134706d",
                  "CodecTimeBase": "1/44100"
                }
              ]
            },
            "SubtitleStreamList": {
              "SubtitleStream": [
                {
                  "Index": "3",
                  "Lang": "und"
                }
              ]
            }
          },
          "Format": {
            "StartTime": "0.000000",
            "NumPrograms": "2",
            "Size": "2647692",
            "NumStreams": "2",
            "FormatLongName": "QuickTime/MOV",
            "Duration": "7.965000",
            "Bitrate": "2659.326",
            "FormatName": "mov"
          }
        },
        "Description": "This is description ****",
        "Size": "2647692",
        "Width": "1920",
        "CoverURL": "http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png",
        "SnapshotList": {
          "Snapshot": [
            {
              "Type": "Sequence",
              "MediaWorkflowId": "6cc3aa66d1cb4bb2adf14e726c0a****",
              "ActivityName": "example-activity1-****",
              "Count": "5",
              "MediaWorkflowName": "example-workflow-****",
              "File": {
                "State": "Normal",
                "URL": "http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png"
              }
            }
          ]
        },
        "RunIdList": {
          "RunId": [
            "{\"RunId\":[\"47b42486019c4f688bf144c1a6ba****\"]}"
          ]
        },
        "Duration": "7.965000",
        "Fps": "25.0",
        "Title": "example-title-****",
        "Format": "mov"
      }
    ]
  },
  "RequestId": "283DC68C-146F-4489-A2A1-2F88F1472A56"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.