SearchPublicMediaInfo - Intelligent Media Services - Alibaba Cloud Documentation Center

Searches for media assets that match the specified conditions.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaIds	string	No	The IMS media asset IDs. Separate multiple IDs with commas (,).	**20b48fb04483915d4f2cd8ac,15d4a4b0448391508f2cb486**
DynamicMetaDataMatchFields	string	No	The dynamic metadata search matching conditions.	"ApprovalStatus='Available'&MaterialBags='boutiquemusic'&Mood='Nervous'"
Favorite	boolean	No	Specifies whether the user has added the media asset to favorites.	true
Authorized	boolean	No	Specifies whether the user has purchased a resource plan that includes this media asset.	true
SortBy	string	No	The sorting method for results in the format of :. Valid values: field: "UsageCount": usage count "UnitPrice": unit price order: "Desc": descending order "Asc": ascending order	UsageCount:Desc,UnitPrice:Asc
PageNo	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
EntityId	string	No	The entity ID that identifies different types of public copyright media assets. Valid values: Copyright_Music: public copyright music	Copyright_Music

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	**3CFB-2767-54FD-B311-BD15A4C1**
TotalCount	integer	The total number of entries that match the request conditions.	100
PublicMediaInfos	array<object>	The public copyright media asset information.
	array<object>
Authorized	boolean	Indicates whether a resource plan that includes this media asset has been purchased.	true
Favorite	boolean	Indicates whether the media asset has been added to favorites.	true
RemainingAuthTime	string	The remaining validity period of the resource plan, in days.	100
MediaInfo	object	The media asset information.
MediaId	string	Media asset ID	icepublic-**87b921bb4a55908a72a0537e**
MediaBasicInfo	object	BasicInfo
MediaId	string	MediaId	icepublic-**87b921bb4a55908a72a0537e**
MediaType	string	Media asset media type	audio
BusinessType	string	Media Asset Business Type	general
Source	string	Source	oss
Title	string	title	title
Description	string	Content description	description
Category	string	Categorization	category
MediaTags	string	Label	tag1
CoverURL	string	Thumbnail URL	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=
UserData	string	User Data	userDataTest
Status	string	Resource status	Normal
CreateTime	string	Media Asset Creation Time	2020-12-26T06:04:49Z
ModifiedTime	string	Updated At	2020-12-26T06:04:50Z
DeletedTime	string	Media Asset Deletion Time	2020-12-29T06:04:49Z
SpriteImages	string	sprite	[{"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"}]
DynamicMetaData	object	Dynamic metadata
Data	string	Metadata JSON string	"{\"AuditionUrl\": \"http://xxx\", \"AuditionCount\": 3...}"
Type	string	Type. Valid values: "ai": AI data processed and normalized from original AI results "user-defined": User-defined metadata "system": System-provided	system

Examples

Success response

JSON format

{
  "RequestId": "****3CFB-2767-54FD-B311-BD15A4C1****",
  "TotalCount": 100,
  "PublicMediaInfos": [
    {
      "Authorized": true,
      "Favorite": true,
      "RemainingAuthTime": "100",
      "MediaInfo": {
        "MediaId": "icepublic-****87b921bb4a55908a72a0537e****",
        "MediaBasicInfo": {
          "MediaId": "icepublic-****87b921bb4a55908a72a0537e****",
          "MediaType": "audio",
          "BusinessType": "general",
          "Source": "oss",
          "Title": "title",
          "Description": "description",
          "Category": "category",
          "MediaTags": "tag1",
          "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",
          "UserData": "userDataTest",
          "Status": "Normal",
          "CreateTime": "2020-12-26T06:04:49Z",
          "ModifiedTime": "2020-12-26T06:04:50Z",
          "DeletedTime": "2020-12-29T06:04:49Z",
          "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\"}]"
        },
        "DynamicMetaData": {
          "Data": "\"{\\\"AuditionUrl\\\": \\\"http://xxx\\\", \\\"AuditionCount\\\": 3...}\"",
          "Type": "system"
        }
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.