Update Media Metadata via UpdateMedia API - ApsaraVideo MPS - Alibaba Cloud - ApsaraVideo Media Processing

Updates the basic information about a media file, such as the title, description, and category.

Operation description

This operation performs a full update. You must set all parameters. Any parameter that you do not set is overwritten with a NULL value.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

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

mts:UpdateMedia

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The ID of the media file to update. To obtain the media file ID, log on to the ApsaraVideo Media Processing (MPS) console and choose Media Management > Media List in the left-side navigation pane.	3e1cd21131a94525be55acf65888****
Title	string	No	The title of the media file. The value supports multiple character types, such as letters and digits. If you do not specify this parameter, the value is NULL. The value is encoded in UTF-8 and can be up to 128 bytes in length.	hello
Description	string	No	The description of the media file. The value supports multiple character types, such as letters and digits. If you do not specify this parameter, the value is NULL. The value is encoded in UTF-8 and can be up to 1,024 bytes in length.	example description
CoverURL	string	No	The URL of the thumbnail, which specifies the storage location. To obtain the URL, log on to the MPS console and choose Workflows > Media Buckets in the left-side navigation pane. Alternatively, log on to the OSS console and click Buckets in the left-side navigation pane. The value can be up to 3,200 bytes in length. The URL complies with RFC 2396 and is encoded in UTF-8, with reserved characters being percent-encoded. For more information, see URL encoding.	http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com/test**.jpg
CateId	integer	No	The category ID of the media file. The value must be a non-negative integer. If you do not specify this parameter, the value is NULL.	1
Tags	string	No	The tags to add to the media file. You can specify up to 16 tags for a media file. Separate multiple tags with commas (,). Each tag can be up to 32 bytes in length. The value is encoded in UTF-8.	tag1,tag2

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	6A88246F-C91F-42BD-BABE-DB0DF993F960
Media	object	The information about the media file.
CreationTime	string	The time when the media file was created.	2016-09-14T08:30:33Z
CateId	integer	The ID of the category to which the media file belongs.	1
Height	string	The height of the media file.	1080
CensorState	string	The review state of the media file. Valid values: Initiated: The media file is uploaded but not reviewed. Pass: The media file is uploaded and passes the review.	Initiated
Tags	object
Tag	array	The information about the tags.
	string	The tags of the media file.	tag1,tag2
Bitrate	string	The bitrate of the media file.	2659.326
MediaId	string	The ID of the media file.	3e1cd21131a94525be55acf65888****
File	object	The information about the input file.
State	string	The state of the input file. Valid values: Normal: The input file is normal. Deleted: The input file is deleted.	Normal
URL	string	The name of the OSS bucket in which the input media file is stored.	http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com//example-**.mp4
PublishState	string	The publishing state of the media file. Valid values: Initiated: The media file is in the initial state. UnPublish: The media file has not been published, and the playback permission on the OSS object is Private. Published: The media file has been published, and the playback permission on the OSS object is Default. Deleted: The media file is deleted.	Published
Description	string	The description of the media file.	example description
Width	string	The width of the media file.	1920
Size	string	The size of the media file.	2647692
CoverURL	string	The URL of the thumbnail.	http://example-bucket-**.oss-cn-shanghai.aliyuncs.com/example-**.jpg
RunIdList	object
RunId	array	The IDs of the media workflow execution instances.
	string	The IDs of the media workflow execution instances.	{"RunId":["47b42486019c4f688bf144c1a6ba****"]}
Duration	string	The duration of the media file.	7.965000
Fps	string	The frame rate of the media file.	25.0
Title	string	The title of the media file.	hello
Format	string	The format of the media file. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov

Examples

Success response

JSON format

{
  "RequestId": "6A88246F-C91F-42BD-BABE-DB0DF993F960",
  "Media": {
    "CreationTime": "2016-09-14T08:30:33Z",
    "CateId": 1,
    "Height": "1080",
    "CensorState": "Initiated",
    "Tags": {
      "Tag": [
        "tag1,tag2"
      ]
    },
    "Bitrate": "2659.326",
    "MediaId": "3e1cd21131a94525be55acf65888****",
    "File": {
      "State": "Normal",
      "URL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
    },
    "PublishState": "Published",
    "Description": "example description",
    "Width": "1920",
    "Size": "2647692",
    "CoverURL": "http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg",
    "RunIdList": {
      "RunId": [
        "{\"RunId\":[\"47b42486019c4f688bf144c1a6ba****\"]}"
      ]
    },
    "Duration": "7.965000",
    "Fps": "25.0",
    "Title": "hello",
    "Format": "mov"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.