Query media asset basic information using ListMediaBasicInfos - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Returns basic information for media assets that match the specified parameters.

Operation description

If the includeFileBasicInfo field is set to true, the response also includes basic information about the source file, such as its duration and file size.
Returns up to 100 matching media assets.
Results must exactly match all specified non-empty filter fields. The following fields support exact matching: media asset type, source, media asset business type, category, and resource status.
If a result set is too large to be returned in a single response, the API provides a nextToken. You can use this token to retrieve the next page of results.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start of the time range to query. The query is performed based on the time when the media asset was created (`utcCreated`). This is an open interval. The query returns media assets created after this point in time. The time must be in UTC and formatted in ISO 8601 standard. The format is `YYYY-MM-DDThh:mm:ssZ`. For example, `2017-01-11T12:00:00Z` corresponds to 20:00:00 on January 11, 2017 (UTC+8).	2020-12-20T12:00:00Z
EndTime	string	No	The end of the time range to query. The query is performed based on the time when the media asset was created (`utcCreated`). This is a closed interval. The query returns media assets created at or before this point in time. The time must be in UTC and formatted in ISO 8601 standard. The format is `YYYY-MM-DDThh:mm:ssZ`. For example, `2017-01-11T12:00:00Z` corresponds to 20:00:00 on January 11, 2017 (UTC+8).	2020-12-20T13:00:00Z
MediaType	string	No	The type of the media asset. Valid values: `image`: an image `video`: a video `audio`: an audio file `text`: a text file	video
BusinessType	string	No	The business type of the media asset. Valid values: `subtitles` `watermark` `opening` `ending` `general`	opening
Source	string	No	The source of the media asset. Valid values: `oss`: Object Storage Service (OSS) `vod`: ApsaraVideo VOD `live`: ApsaraVideo Live `general`: other sources (default)	oss
Status	string	No	The status of the media asset. Valid values: `Init`: The media asset is being initialized and the source file is not ready. `Preparing`: The source file is being prepared. For example, the file is being uploaded or edited. `PrepareFail`: The source file failed to be prepared. For example, the source file information failed to be obtained. `Normal`: The source file is ready.	Normal
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If this parameter is empty, all results are returned.	pSa1SQ0wCe5pzVrQ6mWZEw==
MaxResults	integer	No	The maximum number of entries to return on each page. Maximum value: 100. Default value: 10.	5
SortBy	string	No	The sorting order of the results based on `utcCreated`. Default value: desc. `desc`: descending order `asc`: ascending order	desc
IncludeFileBasicInfo	boolean	No	Specifies whether to include the basic information about the file in the response. A value of `true` indicates that the basic information is included.	true
MediaId	string	No	The ID of the media asset.	**019b82e24b37a1c2958dec38**
AuthTimeout	integer	No

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	****B7-7F87-4792-BFE9-63CD21****
TotalCount	integer	The total number of entries returned.	4
MediaInfos	array<object>	The collection of media assets that meet the requirements.
	array<object>
MediaId	string	The ID of the media asset.	**019b82e24b37a1c2958dec38**
MediaBasicInfo	object	The basic information about the media asset.
MediaId	string	The ID of the media asset.	**019b82e24b37a1c2958dec38**
InputURL	string	The address of the media asset to be registered in the corresponding system.	https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
MediaType	string	The type of the media asset.	video
BusinessType	string	The business type of the media asset.	opening
Source	string	The source of the media asset.	oss
Title	string	The title of the media asset.	titleTitle
Description	string	The description of the media asset.	desc Description
Category	string	The category of the media asset.	Category category
MediaTags	string	The tags of the media asset.	tags,tags2
CoverURL	string	The URL of the cover.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=
UserData	string	The user data.	userData
Snapshots	string	The snapshots.	[{"bucket":"example-bucket","count":"3","iceJobId":"****f48f0e4154976b2b8c45**","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"**e6a6440b29eb60bd7c****"}]
Status	string	The status of the resource.	Normal
TranscodeStatus	string	The transcoding status.	Init
CreateTime	string	The time when the media asset was created.	2021-01-08T16:52:04Z
ModifiedTime	string	The time when the media asset was modified.	2021-01-08T16:52:07Z
DeletedTime	string	The time when the media asset was deleted.	2021-01-08T16:52:07Z
SpriteImages	string	The 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 ID of the category.	3049
Biz	string	The business to which the media asset belongs.	ICE
UploadSource	string	The source from which the media asset is uploaded.	general
ReferenceId	string	A custom ID that is unique to each user. The value can contain letters, digits, hyphens (-), and underscores (_), and must be 6 to 64 characters in length.	123-123
FileInfoList	array<object>	The file information.
	array<object>
FileBasicInfo	object	The basic information about the file, including 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 size of the file. Unit: bytes.	14340962
FileUrl	string	The OSS URL of the file.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.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 duration.	60.00000
Bitrate	string	The bitrate.	1912.13
Width	string	The width.	1280
Height	string	The height.	720
CreateTime	string	The time when the file was created.	2021-01-08T16:52:04Z
ModifiedTime	string	The time when the file was modified.	2021-01-08T16:52:07Z
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is not specified, all results are returned.	8EqYpQbZ6Eh7+Zz8DxVYoQ==
MaxResults	integer	The maximum number of entries returned on the current page.	2

Examples

Success response

JSON format

{
  "RequestId": "******B7-7F87-4792-BFE9-63CD21******",
  "TotalCount": 4,
  "MediaInfos": [
    {
      "MediaId": "****019b82e24b37a1c2958dec38****",
      "MediaBasicInfo": {
        "MediaId": "****019b82e24b37a1c2958dec38****",
        "InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
        "MediaType": "video",
        "BusinessType": "opening",
        "Source": "oss",
        "Title": "titleTitle",
        "Description": "desc Description",
        "Category": "Category category",
        "MediaTags": "tags,tags2",
        "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",
        "UserData": "userData",
        "Snapshots": "[{\"bucket\":\"example-bucket\",\"count\":\"3\",\"iceJobId\":\"******f48f0e4154976b2b8c45******\",\"location\":\"oss-cn-beijing\",\"snapshotRegular\":\"example.jpg\",\"templateId\":\"******e6a6440b29eb60bd7c******\"}]",
        "Status": "Normal",
        "TranscodeStatus": "Init",
        "CreateTime": "2021-01-08T16:52:04Z",
        "ModifiedTime": "2021-01-08T16:52:07Z",
        "DeletedTime": "2021-01-08T16:52:07Z",
        "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": 3049,
        "Biz": "ICE",
        "UploadSource": "general",
        "ReferenceId": "123-123"
      },
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileName": "example.mp4",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "14340962",
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=",
            "Region": "cn-shanghai",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Duration": "60.00000",
            "Bitrate": "1912.13",
            "Width": "1280",
            "Height": "720",
            "CreateTime": "2021-01-08T16:52:04Z",
            "ModifiedTime": "2021-01-08T16:52:07Z"
          }
        }
      ]
    }
  ],
  "NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "MaxResults": 2
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.