ListMediaBasicInfos-阿里云帮助中心

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

Operation description

If the includeFileBasicInfo field is set to true, the response also includes basic source file information, such as its duration and file size.
Returns a maximum of 100 matching media assets.
The query returns only media assets that exactly match all specified non-empty fields. The fields that support exact matching are media type, source, business type, category, and resource status.
If the result set is too large for a single response, use the returned nextToken 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 time of the query range, based on the creation time (`utcCreated`). The query returns results created after this time (exclusive). The time must be in UTC and comply with the ISO 8601 standard. The format is `YYYY-MM-DD'T'HH:mm:ss'Z'`. 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 time of the query range, based on the creation time (`utcCreated`). The query returns results created at or before this time (inclusive). The time must be in UTC and comply with the ISO 8601 standard. The format is `YYYY-MM-DD'T'HH:mm:ss'Z'`. 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 media type. Valid values: `image`: image `video`: video `audio`: audio `text`: text	video
BusinessType	string	No	The business type. Valid values: `subtitles`: subtitles `watermark`: watermark `opening`: opening `ending`: ending `general`: General	opening
Source	string	No	The source. Valid values: `oss`: OSS `vod`: video on demand `live`: live streaming `general`: Other sources (default).	oss
Status	string	No	The media status. Valid values: `Init`: The source file is not ready. `Preparing`: The source file is being prepared. For example, it is being uploaded or composited. `PrepareFail`: The source file failed to prepare. This may occur, for example, if the system fails to retrieve information about the source file. `Normal`: The source file is ready.	Normal
NextToken	string	No	The pagination token used to retrieve the next page of results. An empty value indicates that all results have been returned.	pSa1SQ0wCe5pzVrQ6mWZEw==
MaxResults	integer	No	The maximum number of results to return per page. Maximum value: 100. Default value: 10.	5
SortBy	string	No	The sort order for results based on the creation time (`utcCreated`). The default is descending. Valid values: `desc`: Descending order `asc`: Ascending order	desc
IncludeFileBasicInfo	boolean	No	Set to `true` to include basic file information in the response.	true
MediaId	string	No	The media ID.	**019b82e24b37a1c2958dec38**
AuthTimeout	integer	No	The authentication expiration time, in seconds. Minimum value: 1. Maximum value: 86400. Default value: 3600.	30

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 matching entries.	4
MediaInfos	array<object>	The list of matching media assets.
	array<object>	The information about the media asset.
MediaId	string	The media asset ID.	**019b82e24b37a1c2958dec38**
MediaBasicInfo	object	The basic information about the media asset.
MediaId	string	The media asset ID.	**019b82e24b37a1c2958dec38**
InputURL	string	The source URL of the media asset.	https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
MediaType	string	The media type.	video
BusinessType	string	The business type.	opening
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.	desc 描述
Category	string	The category of the media asset.	分类 category
MediaTags	string	Tags associated with the media asset.	tags,tags2
CoverURL	string	The cover URL.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=
UserData	string	The user data.	userData
Snapshots	string	Information about the snapshots.	[{"bucket":"example-bucket","count":"3","iceJobId":"****f48f0e4154976b2b8c45**","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"**e6a6440b29eb60bd7c****"}]
Status	string	The status of the media asset.	Normal
TranscodeStatus	string	The transcoding status.	Init
CreateTime	string	The time the media asset was created.	2021-01-08T16:52:04Z
ModifiedTime	string	The time the media asset was last modified.	2021-01-08T16:52:07Z
DeletedTime	string	The time the media asset was deleted.	2021-01-08T16:52:07Z
SpriteImages	string	Information about the image sprites.	[{"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.	3049
Biz	string	The associated business.	ICE
UploadSource	string	The upload source of the media asset.	general
ReferenceId	string	A user-defined ID that must be unique within your account. The ID must be 6 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (_).	123-123
FileInfoList	array<object>	A list of file information objects.
	array<object>	The file information.
FileBasicInfo	object	Basic information about the file, such as its 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, in bytes.	14340962
FileUrl	string	The Object Storage Service (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 of the file, in seconds.	60.00000
Bitrate	string	The bitrate of the file, in Kbit/s.	1912.13
Width	string	The width of the video, in pixels.	1280
Height	string	The height of the video, in pixels.	720
CreateTime	string	The time the file was created.	2021-01-08T16:52:04Z
ModifiedTime	string	The time the file was last modified.	2021-01-08T16:52:07Z
NextToken	string	The token for retrieving the next page of results. If this parameter is not returned, all results have been retrieved.	8EqYpQbZ6Eh7+Zz8DxVYoQ==
MaxResults	integer	The maximum number of entries returned per 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": "title标题",
        "Description": "desc 描述",
        "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.