Use UpdateVideoInfos to update information for multiple audio or video files - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Usage notes

Audio and video files are identified by their IDs. You can modify the title, tags, and description of audio and video files. If a parameter is specified, the corresponding field is updated. Otherwise, the field is not overwritten or updated.
You can modify the information about up to 20 audio and video files at a time.

QPS limit

The single-user QPS limit for this operation is 30 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation properly. 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

vod:UpdateVideoInfos

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UpdateContent	string	Yes	The update content. You can modify the information about up to 20 audio and video files at a time. Separate multiple audio and video object information entries with commas (,). If you specify more than 20 objects, the update is failed and the `CountExceededMax` error is returned. The value is a JSON character string. For more details 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

The value of UpdateContent must be converted to a string before being passed as a parameter.

Name	Type	Required	Description
VideoId	String	Yes	The ID of the audio or video file. You can obtain the ID by using the following methods: For audio and video files uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the ID. When you call the CreateUploadVideo operation to obtain the upload URL and credential, the audio or video ID is the value of the VideoId response parameter. After the audio or video file is uploaded, you can call the SearchMedia operation to query the audio or video ID, which is the value of the VideoId response parameter.
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. Each tag can be up to 32 bytes in length. You can specify up to 16 tags. Separate multiple tags with commas (,). The value must be encoded in UTF-8.
CoverURL	String	No	The URL of the audio or video thumbnail.
CateId	Long	No	The category ID. You can obtain the ID by using the following methods: Log on to the ApsaraVideo VOD console and choose Configuration Management > Media Management > Categories to view the category ID. When you call the AddCategory operation to create a category, the category ID is the value of the CateId response parameter. When you call the GetCategories operation to query categories, the category ID is the value of the CateId response parameter.
ReferenceId	String	No	The custom ID. The value can contain only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_), and must be 6 to 64 characters in length. The value must be unique within a user.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
ForbiddenVideoIds	array	The IDs of the audio and video files that cannot be operated on. This is typically caused by insufficient permissions.
	string	The IDs of the audio and video files that cannot be operated on. This is typically caused by insufficient permissions.	f45cf4eba5c84233389558c36****
NonExistVideoIds	array	The IDs of the audio and video files that do not exist.
	string	The IDs of the audio and video files that do not exist.	f45cf4eba5cb90233389558c39****
NonExistReferenceIds	array	The list of custom IDs that do not exist.
	string	The 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.