BatchGetYikeAssetMediaInfos-阿里云帮助中心

Retrieves media asset information in batches.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaIds	string	No	The IDs of the media assets to query, separated by commas.	****b48fb04483915d4f2cd8**,**c48fb37407365d4f2cd8****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
MediaInfos	array<object>	The collection of media assets that meet the specified criteria.
	array<object>	The collection of media assets that meet the specified criteria.
MediaId	string	The media asset ID.	****c48fb37407365d4f2cd8****
MediaBasicInfo	object	The basic information of the media asset.
MediaId	string	The media asset ID.	***64623a94eca8516569c8f***
InputURL	string	The URL of the media asset to be registered in the corresponding system.	https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
MediaType	string	The media type of the media asset.	video
BusinessType	string	The business type of the media asset.	general
Source	string	The source.	oss
Title	string	The title.	title
Description	string	The description.	sample_description
Category	string	The category.	category
MediaTags	string	The tags.	tag1，tag2
CoverURL	string	The cover URL.	https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg
UserData	string	The user data.	UserData
Snapshots	string	The snapshots.	[]
Status	string	The resource status.	Normal
TranscodeStatus	string	The transcoding status.	Init
CreateTime	string	The time when the media asset was created.	2020-12-26T04:11:08Z
ModifiedTime	string	The time when the media asset was modified.	2021-01-08T16:52:04Z
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"}]
Biz	string	The business to which the media asset belongs.	ICE
FileInfoList	array<object>	The file list information.
	array<object>	The file information.
FileBasicInfo	object	The basic file information, including the duration and size.
FileName	string	The file name.	example.mp4
FileStatus	string	The file status.	Normal
FileType	string	The file type.	source_file
FileSize	string	The file size in bytes.	191
FileUrl	string	The OSS URL of the file.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=
Region	string	The storage region of the file.	cn-shanghai
FormatName	string	The container format.	jpg
Duration	string	The duration.	200
Bitrate	string	The bitrate.	30
Width	string	The width.	640
Height	string	The height.	416
BizData	object	The business information.
FolderId	string	The folder ID.	pd_0617169475
ProductionId	string	The project ID.	pd_0617169475
AuditBlockedLabel	string	The moderation label.	Label
AuditStatus	string	The moderation status.	pass
MediaAssetType	string	The media asset type.	HistoricalUpload
MediaAssetSubType	string	The media asset subtype.	Image
SourceType	string	The source type.	MainBody
SourceId	string	The source ID.	f4a26390f02371f0a1f4e6e7c7586706
SourceName	string	The source name.	name
IsFavorite	string	Specifies whether the media asset is favorited.	1
IsLogicalDeleted	string	Indicates whether the item is logically deleted.	1
CreationJobId	string	The ID of the creation job.	ID
IgnoredList	array	The list of IDs that failed to be retrieved.
	string	The ID that failed to be retrieved.	**fb2101bf24bf41cb318787dc**

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "MediaInfos": [
    {
      "MediaId": "******c48fb37407365d4f2cd8******",
      "MediaBasicInfo": {
        "MediaId": "*****64623a94eca8516569c8f*****",
        "InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
        "MediaType": "video",
        "BusinessType": "general",
        "Source": "oss",
        "Title": "title",
        "Description": "sample_description",
        "Category": "category",
        "MediaTags": "tag1，tag2",
        "CoverURL": "https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/01e1271d-ff4f-4689-9c20-e1df81486859_open_live_cover.jpg",
        "UserData": "UserData",
        "Snapshots": "[]",
        "Status": "Normal",
        "TranscodeStatus": "Init",
        "CreateTime": "2020-12-26T04:11:08Z",
        "ModifiedTime": "2021-01-08T16:52:04Z",
        "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\"}]",
        "Biz": "ICE"
      },
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileName": "example.mp4",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "191",
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=",
            "Region": "cn-shanghai",
            "FormatName": "jpg",
            "Duration": "200",
            "Bitrate": "30",
            "Width": "640",
            "Height": "416"
          }
        }
      ],
      "BizData": {
        "FolderId": "pd_0617169475",
        "ProductionId": "pd_0617169475",
        "AuditBlockedLabel": "Label",
        "AuditStatus": "pass",
        "MediaAssetType": "HistoricalUpload",
        "MediaAssetSubType": "Image",
        "SourceType": "MainBody",
        "SourceId": "f4a26390f02371f0a1f4e6e7c7586706",
        "SourceName": "name",
        "IsFavorite": "1",
        "IsLogicalDeleted": "1",
        "CreationJobId": "ID"
      }
    }
  ],
  "IgnoredList": [
    "****fb2101bf24bf41cb318787dc****"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.