UpdateMedia - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Updates the basic information about a media file.

Operation description

The basic information that you can update by calling this operation includes the title, description, and category of a media file. This operation applies to a full update. You must set all the parameters unless you want to replace the value of a specific parameter 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 will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The ID of the media file whose basic information you want to update. To obtain the ID of the media file, you can 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. Multiple character types, such as letters and digits, are supported. 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. Multiple character types, such as letters and digits, are supported. 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. This parameter is used to specify the storage location of the thumbnail. To obtain the URL, you can log on to the MPS console and choose Workflows > Media Buckets in the left-side navigation pane. Alternatively, you can 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	long	No	The ID of the category to which the media file belongs. The value must be an integer. If you do not specify this parameter, the value is NULL. The value cannot be negative.	1
Tags	string	No	The tags that you want 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 parameters

Parameter	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	long	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	array	The information about the tags.
	string	The tags that you want to add to 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	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history