UpdateVideoInfos - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Operation description

Usage notes

This operation locates audio or video files by their IDs. You can modify information such as the title, tags, and description. If a parameter is passed, the corresponding field is updated. If a parameter is not passed, the corresponding field is not updated.
You can update information for a maximum of 20 audio or video files per request.

QPS limits

The queries per second (QPS) limit for this operation is 30 calls per user. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this operation within this limit. For more information, see QPS limits.

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

vod:UpdateVideoInfos

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UpdateContent	string	Yes	The content to update. You can modify the information of a maximum of 20 audio or video files in a single request. Separate the information of multiple audio or video objects with commas (,). If you attempt to update more than 20 files, the operation fails and a `CountExceededMax` error is returned. The value must be a JSON string. For more information about the parameters, see the UpdateContent table below.	[{"VideoId":"f45cf4eba5cb90233389558c39**","Title":"Alibaba Cloud VOD Video Title1"},{"VideoId":"f45cf4eba5c84233389558c36**","Title":"Alibaba Cloud VOD Video Title2"}]

UpdateContent

Note

You must convert the value of UpdateContent to a string before you pass it as a request parameter.

Name	Type	Required	Description
VideoId	String	Yes	The ID of the audio or video file. You can obtain the ID in the following ways: For audio or video files uploaded in the console, log on to the VOD console and choose Media Assets > Audio/Video to view the ID. When you call the CreateUploadVideo operation to obtain an upload URL and credential, the audio or video ID is the value of the VideoId parameter in the response. After the audio or video file is uploaded, you can call the SearchMedia operation to query the audio or video ID. The ID is the value of the VideoId parameter in the response.
Title	String	No	The title of the audio or video file.
Description	String	No	The description of the audio or video file.
Tags	String	No	The tags of the audio or video file. A single tag can be up to 32 bytes in length. A maximum of 16 tags are supported. Separate multiple tags with commas (,). The tags must be UTF-8 encoded.
CoverURL	String	No	The URL of the cover image for the audio or video file.
CateId	Long	No	The ID of the category. You can obtain the ID in the following ways: Log on to the VOD console and choose Configuration Management > Media Asset Management > Category Management to view the category ID. When you call the AddCategory operation to create a category, the category ID is the value of the CateId parameter in the response. When you call the GetCategories operation to query categories, the category ID is the value of the CateId parameter in the response.
ReferenceId	String	No	The custom ID. It can contain only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The length must be 6 to 64 characters. The ID must be unique for each user.

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
ForbiddenVideoIds	array	A list of audio or video IDs for which the operation is forbidden. This is usually due to a lack of permissions.
	string	A list of audio or video IDs for which the operation is forbidden. This is usually due to a lack of permissions.	f45cf4eba5c84233389558c36****
NonExistVideoIds	array	A list of audio or video IDs that do not exist.
	string	A list of audio or video IDs that do not exist.	f45cf4eba5cb90233389558c39****
NonExistReferenceIds	array	A list of custom IDs that do not exist.
	string	A list of custom IDs that do not exist.	123-123

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "ForbiddenVideoIds": [
    "f45cf4eba5c84233389558c36****"
  ],
  "NonExistVideoIds": [
    "f45cf4eba5cb90233389558c39****"
  ],
  "NonExistReferenceIds": [
    "123-123"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.