UpdateVideoInfo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Operation description

Usage notes

This operation updates the information of an audio or video file based on its video ID, such as the title, tags, and description. If you include a parameter in the request, the corresponding field is updated. Fields for omitted parameters remain unchanged.

QPS limits

The queries per second (QPS) limit for this API operation is 100 for each user. If you exceed the limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate. 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:UpdateVideoInfo

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	No	The ID of the audio or video file. Obtain the ID in one of the following ways: Log on to the VOD console. Choose Media Library > Audio/Video to view the ID of a video that was uploaded in the console. The response to a CreateUploadVideo call contains the audio or video ID in the `VideoId` parameter. After you upload a video, the response to a SearchMedia call contains the audio or video ID in the `VideoId` parameter.	2deda93265312baf9b0ed810d****
Title	string	No	The title of the audio or video file. The title can be up to 128 bytes in length. The title must be UTF-8 encoded.	Alibaba Cloud VOD Video Title
Tags	string	No	The tags of the 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.	tag1,tag2
Description	string	No	The description of the audio or video file. The description can be up to 1,024 bytes in length. The description must be UTF-8 encoded.	Alibaba Cloud VOD video description
CoverURL	string	No	The URL of the cover for the audio or video file.	https://example.aliyundoc.com/****.jpg
CateId	integer	No	The ID of the category. Obtain the ID in one of the following ways: Log on to the VOD console. Choose Configuration Management > Media Asset Management > Category Management to view the category ID. The response to an AddCategory call contains the category ID in the `CateId` parameter. The response to a GetCategories call contains the category ID in the `CateId` parameter.	384761111
UserData	string	No	Custom settings in a JSON string. These settings can include message callbacks and upload acceleration. For more information, see UserData.	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
ReferenceId	string	No	A custom ID. The ID can contain lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be 6 to 64 characters in length and unique for each user.	123-123

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	25818875-5F78-4AF6-D7393642CA58****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.