Use UpdateImageInfos to update information for multiple images - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

This operation only supports modifying uploaded images. Modifying images generated from video snapshots is not supported.
You can modify the information of up to 20 images at a time.

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:UpdateImageInfos

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UpdateContent	string	Yes	The update content. You can modify the information of up to 20 images at a time. For the parameter structure, see the UpdateContent table below. Note The Title, Description, and Tags fields cannot contain emoticons. If a parameter is specified, the corresponding field is updated. Otherwise, the corresponding field is not overwritten or updated.	[{"ImageId":"ff8fe57e3461416c6a267a4e09****","Title":" title","Description":" description","Tags":" tag1, tag2"}]

UpdateContent

Note

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

Name	Type	Required	Description
ImageId	String	Yes	The image ID. You can obtain the image ID by using the following methods: Log on to the ApsaraVideo VOD console and choose Media Files > Image to view the ID. Obtain the ID from the response when you call the CreateUploadImage operation to obtain the upload URL and credential. Obtain the ID from the response when you call the SearchMedia operation to query images.
Title	String	No	The image title. The title can be up to 128 bytes in length. UTF-8 encoding.
Description	String	No	The image description. The description can be up to 1024 bytes in length. UTF-8 encoding.
Tags	String	No	The image tags. Each tag can be up to 32 bytes in length. You can specify up to 16 tags. Separate multiple tags with commas (,). UTF-8 encoding.
CateId	Long	No	The category ID. You can obtain the category 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. Obtain the ID from the response when you call the AddCategory operation to create a category. Obtain the ID from the response when you call the GetCategories operation to query categories.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
NonExistImageIds	object
ImageId	array	The list of image IDs that do not exist.
	string	The list of image IDs that do not exist.	f45cf4eba5c80233389558c39****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "NonExistImageIds": {
    "ImageId": [
      "f45cf4eba5c80233389558c39****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.