GetMediaInfo API Overview & Media Asset Metadata - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Retrieves media asset information using an Intelligent Media Services (IMS) mediaId or an InputURL.

Operation description

MediaId takes precedence. If MediaId is empty, InputURL must not be null.

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

ice:GetMediaInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	No	The ID of the media asset in Intelligent Media Services (IMS). If you omit this parameter, you must specify `InputURL`.	**20b48fb04483915d4f2cd8ac**
InputURL	string	No	The address of the media asset to query. You must first register the media asset in the IMS media library and bind it to a `mediaId`. Object Storage Service (OSS) URL. Two formats are supported: `http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4` `oss://example-bucket/example.mp4`. When you use this format, the OSS region defaults to the service endpoint region.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
OutputType	string	No	The type of URL to return for the media asset file. `oss`: Returns the OSS URL. This is the default value. `cdn`: Returns the Content Delivery Network (CDN) URL. A CDN URL is returned only if the media asset was imported from Video on Demand (VOD) and has a CDN domain name configured in VOD.	cdn
ReturnDetailedInfo	string	No	Whether to return detailed information for specific media asset fields. The only supported field is `AiRoughData.StandardSmartTagJob`, which specifies how the result of a tag analysis task is returned. `false`: The task result is returned as a URL. This is the default value. `true`: The task result is returned as a string.	{"AiRoughData.StandardSmartTagJob": false}
AuthTimeout	integer	No	The validity period of the signed URL, in seconds.

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	2FDE2411-DB8D-4A9A-875B-275798F14A5E
MediaInfo	object	Information about the media asset.
MediaId	string	The media asset ID.	**20b48fb04483915d4f2cd8ac**
MediaBasicInfo	object	Basic information about the media asset.
MediaId	string	The media asset ID.	**20b48fb04483915d4f2cd8ac**
InputURL	string	The media asset URL.	https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
MediaType	string	The media asset type.	video
BusinessType	string	The business type of the media asset.	general
Source	string	The source of the media asset.	oss
Title	string	The title of the media asset.	Title
Description	string	The description of the media asset.	Description
Category	string	The category of the media asset.	Category
MediaTags	string	A comma-separated list of tags for the media asset.	Tag,tag1
CoverURL	string	The cover image URL.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=
UserData	string	Custom user data.	userDataTest
Snapshots	string	A list of snapshot URLs.	[ "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=&OSSAccessKeyId=&Signature=&security-token=", "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=", "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=" ]
Status	string	The status of the media asset.	Normal
CreateTime	string	The time when the media asset was created. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.	2020-12-26T04:11:08Z
ModifiedTime	string	The time when the media asset was last modified. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.	2020-12-26T04:11:10Z
DeletedTime	string	The time when the media asset was deleted. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.	2020-12-26T04:11:15Z
SpriteImages	string	The details of the generated sprite images.	[{"bucket":"example-bucket","count":"32","iceJobId":"****83ec44d58b2069def2e**","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"**e438b14ff39293eaec25****","tileCount":"1"}]
CateId	integer	The category ID.	3048
Biz	string	The business associated with the media asset.	ICE
UploadSource	string	The upload source of the media asset.	general
CateName	string	The name of the category.	cateName
ReferenceId	string	A custom, user-unique ID. It must be 6 to 64 characters long and can only contain letters, digits, hyphens (-), and underscores (_).	123-1234
FileInfoList	array<object>	A list of file information objects.
	array<object>
FileBasicInfo	object	The basic information about the file, such as the duration and size.
FileName	string	The name of the file.	example.mp4
FileStatus	string	The status of the file.	Normal
FileType	string	The type of the file.	source_file
FileSize	string	The file size in bytes.	30611502
FileUrl	string	The file's OSS URL.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=
Region	string	The Region where the file is stored.	cn-shanghai
FormatName	string	The container format.	mov,mp4,m4a,3gp,3g2,mj2
Duration	string	The file duration in seconds.	216.206667
Bitrate	string	The file bitrate in kbit/s.	1132.68
Width	string	The video width in pixels.	960
Height	string	The video height in pixels.	540
CreateTime	string	The time when the file was created. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.	2020-12-26T04:11:08Z
ModifiedTime	string	The time when the file was last modified. The time is in UTC and follows the `YYYY-MM-DDTHH:MM:SSZ` format.	2020-12-26T04:11:10Z
AudioStreamInfoList	array<object>	A list of audio stream information. A media asset may contain multiple audio streams.
	object
Index	string	The index of the audio stream.	1
CodecName	string	The short name of the codec.	aac
CodecLongName	string	The full name of the codec.	AAC (Advanced Audio Coding)
CodecTimeBase	string	The time base of the codec.	1/24000
CodecTagString	string	The tag string of the codec.	mp4a
CodecTag	string	The tag of the codec.	0x6134706d
Profile	string	The encoding profile.	High
SampleFmt	string	The sample format.	fltp
SampleRate	string	The sample rate, in Hz.	44100
Channels	string	The number of audio channels.	2
ChannelLayout	string	The channel layout.	stereo
Timebase	string	The time base.	1/44100
StartTime	string	The start time, in seconds.	0.000000
Duration	string	The duration, in seconds.	16.200998
Bitrate	string	The bitrate, in kbit/s.	127.794
Fps	string	The audio frame rate.	8
NumFrames	string	The total number of audio frames.	10
Lang	string	The language.	und
VideoStreamInfoList	array<object>	A list of video stream information. A media asset may contain multiple video streams.
	object
Index	string	The index of the video stream.	0
CodecName	string	The short name of the codec.	h264
CodecLongName	string	The full name of the codec.	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Profile	string	The encoding profile.	High
CodecTimeBase	string	The time base of the codec.	1/48
CodecTagString	string	The tag string of the codec.	[0][0][0][0]
CodecTag	string	The tag of the codec.	0x0000
Width	string	The video width in pixels.	960
Height	string	The video height in pixels.	540
HasBFrames	string	Specifies whether B-frames exist.	2
Sar	string	The sample aspect ratio (SAR).	0:1
Dar	string	The display aspect ratio (DAR).	0:1
PixFmt	string	The pixel format.	yuv420p
Level	string	The encoding level.	30
Fps	string	The video frame rate.	24.0
AvgFPS	string	The average frame rate.	24.0
Timebase	string	The time base.	1/12288
StartTime	string	The start time, in seconds.	0.081706
Duration	string	The duration, in seconds.	216.206706
Bitrate	string	The bitrate, in kbit/s.	1001.594
NumFrames	string	The total number of frames.	5184
Lang	string	The language.	und
Rotate	string	The rotation angle of the video.	0
Nb_frames	string	The total number of video frames.	5184
SubtitleStreamInfoList	array<object>	A list of subtitle stream information. A media asset may contain multiple subtitle streams.
	object
Index	string	The index of the subtitle stream.	1
CodecName	string	The short name of the codec.	srt
CodecLongName	string	The full name of the codec.	SubRip Text
CodecTimeBase	string	The time base of the codec.	29.97
CodecTagString	string	The tag string of the codec.	unicode
CodecTag	string	The tag of the codec.	unicode
Timebase	string	The time base.	30
StartTime	string	The start time, in seconds.	0
Duration	string	The duration.	1
Lang	string	The language.	und
AiRoughData	object	The raw data from the AI analysis.
Result	string	The raw AI analysis result.	https://sample-bucket.cn-shanghai.aliyuncs.com/result.json
Status	string	The status of the AI analysis: Analyzing: The analysis is in progress. AnalyzeSuccess: The analysis is successful. AnalyzeFailed: The analysis failed. Saving: The data is being saved. SaveSuccess: The data is saved. SaveFailed: The data failed to save. Deleting: The data is being deleted. DeleteSuccess: The data is deleted. DeleteFailed: The data failed to delete.	Analyzing
SaveType	string	The save type. Specifies whether to save the results to the search index after the AI analysis is complete. Valid values: TEXT: The text index.	TEXT
AiCategory	string	The AI category. Valid values: Lifestyle Appearance Pets News Advertisement Environment Automobile	Lifestyle
AiJobId	string	The AI job ID.	**483915d4f2cd8ac20b48fb04**
StandardSmartTagJob	object	The tag job.
AiJobId	string	The AI job ID.	**483915d4f2cd8ac20b48fb04**
Status	string	The AI analysis status: Analyzing: The analysis is in progress. AnalyzeSuccess: The analysis is successful. AnalyzeFailed: The analysis failed.	Analyzing
ResultUrl	string	The tag result URL.	http://xx.oss-cn-shanghai.aliyuncs.com/result2.txt
Results	array<object>	A list of tag recognition results.
	object	Tag recognition result
Data	string	The detailed analysis result is a JSON string. For the data structure of each Type, see Result parameter description.	{"autoChapters": [...]}
Type	string	The tag identification type. Valid values: NLP: The result from Natural Language Processing (NLP). TextLabel: A text tag. VideoLabel: A video tag. ASR: The raw result from Automatic Speech Recognition (ASR). OCR: The raw result from Optical Character Recognition (OCR).	NLP

Examples

Success response

JSON format

{
  "RequestId": "2FDE2411-DB8D-4A9A-875B-275798F14A5E",
  "MediaInfo": {
    "MediaId": "****20b48fb04483915d4f2cd8ac****",
    "MediaBasicInfo": {
      "MediaId": "****20b48fb04483915d4f2cd8ac****",
      "InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
      "MediaType": "video",
      "BusinessType": "general",
      "Source": "oss",
      "Title": "Title",
      "Description": "Description",
      "Category": "Category",
      "MediaTags": "Tag,tag1",
      "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",
      "UserData": "userDataTest",
      "Snapshots": "[\n    \"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=&OSSAccessKeyId=&Signature=&security-token=\",\n    \"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=\",\n    \"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=&OSSAccessKeyId=&Signature=&security-token=\"\n]",
      "Status": "Normal",
      "CreateTime": "2020-12-26T04:11:08Z",
      "ModifiedTime": "2020-12-26T04:11:10Z",
      "DeletedTime": "2020-12-26T04:11:15Z",
      "SpriteImages": "[{\"bucket\":\"example-bucket\",\"count\":\"32\",\"iceJobId\":\"******83ec44d58b2069def2e******\",\"location\":\"oss-cn-shanghai\",\"snapshotRegular\":\"example/example-{Count}.jpg\",\"spriteRegular\":\"example/example-{TileCount}.jpg\",\"templateId\":\"******e438b14ff39293eaec25******\",\"tileCount\":\"1\"}]",
      "CateId": 3048,
      "Biz": "ICE",
      "UploadSource": "general",
      "CateName": "cateName",
      "ReferenceId": "123-1234"
    },
    "FileInfoList": [
      {
        "FileBasicInfo": {
          "FileName": "example.mp4",
          "FileStatus": "Normal",
          "FileType": "source_file",
          "FileSize": "30611502",
          "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=",
          "Region": "cn-shanghai",
          "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
          "Duration": "216.206667",
          "Bitrate": "1132.68",
          "Width": "960",
          "Height": "540",
          "CreateTime": "2020-12-26T04:11:08Z",
          "ModifiedTime": "2020-12-26T04:11:10Z"
        },
        "AudioStreamInfoList": [
          {
            "Index": "1",
            "CodecName": "aac",
            "CodecLongName": "AAC (Advanced Audio Coding)",
            "CodecTimeBase": "1/24000",
            "CodecTagString": "mp4a",
            "CodecTag": "0x6134706d",
            "Profile": "High",
            "SampleFmt": "fltp",
            "SampleRate": "44100",
            "Channels": "2",
            "ChannelLayout": "stereo",
            "Timebase": "1/44100",
            "StartTime": "0.000000",
            "Duration": "16.200998",
            "Bitrate": "127.794",
            "Fps": "8",
            "NumFrames": "10",
            "Lang": "und"
          }
        ],
        "VideoStreamInfoList": [
          {
            "Index": "0",
            "CodecName": "h264",
            "CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
            "Profile": "High",
            "CodecTimeBase": "1/48",
            "CodecTagString": "[0][0][0][0]",
            "CodecTag": "0x0000",
            "Width": "960",
            "Height": "540",
            "HasBFrames": "2",
            "Sar": "0:1",
            "Dar": "0:1",
            "PixFmt": "yuv420p",
            "Level": "30",
            "Fps": "24.0",
            "AvgFPS": "24.0",
            "Timebase": "1/12288",
            "StartTime": "0.081706",
            "Duration": "216.206706",
            "Bitrate": "1001.594",
            "NumFrames": "5184",
            "Lang": "und",
            "Rotate": "0",
            "Nb_frames": "5184"
          }
        ],
        "SubtitleStreamInfoList": [
          {
            "Index": "1",
            "CodecName": "srt",
            "CodecLongName": "SubRip Text",
            "CodecTimeBase": "29.97",
            "CodecTagString": "unicode",
            "CodecTag": "unicode",
            "Timebase": "30",
            "StartTime": "0",
            "Duration": "1",
            "Lang": "und"
          }
        ]
      }
    ],
    "AiRoughData": {
      "Result": "https://sample-bucket.cn-shanghai.aliyuncs.com/result.json",
      "Status": "Analyzing",
      "SaveType": "TEXT",
      "AiCategory": "Life",
      "AiJobId": "****483915d4f2cd8ac20b48fb04****",
      "StandardSmartTagJob": {
        "AiJobId": "****483915d4f2cd8ac20b48fb04****",
        "Status": "Analyzing",
        "ResultUrl": "http://xx.oss-cn-shanghai.aliyuncs.com/result2.txt",
        "Results": [
          {
            "Data": "{\"autoChapters\": [...]}",
            "Type": "NLP"
          }
        ]
      }
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.