Modifies the information about multiple images at a time. After you upload images to ApsaraVideo VOD, you can call this operation to update their titles, descriptions, tags, and categories at a time based on the IDs of the images.
Operation description
- You can call this operation to modify information such as the title, tags, description, and category about images based on image IDs. You must pass in the parameters that you want to modify. Otherwise, parameter configurations are not overwritten.
- You can modify the information about up to 20 images at a time.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vod:UpdateImageInfos | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| UpdateContent | string | Yes | The new information about the one or more images. You can modify the information about up to 20 images at a time. For more information about the parameter structure, see the UpdateContent section. Note
The values of the nested parameters Title, Description, and Tags under the UpdateContent parameter cannot contain emoticons.
| [{"ImageId":"ff8fe57e3461416c6a267a4e09****","Title":"test title","Description":"test description","Tags":"tag1,tag2"}] |
UpdateContent
Note You must convert the UpdateContent parameter to a string before you pass it in.
| Parameter | Type | Required | Description |
|---|---|---|---|
| ImageId | String | Yes | The ID of the image. You can obtain the ID by using one of the following methods:Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Image to view the image ID.Obtain the image ID from the response to the CreateUploadImage operation that you call to obtain the upload URL and credential.Obtain the image ID from the response to the SearchMedia operation that you call to query images. |
| Title | String | No | The title of the image. The title cannot exceed 128 bytes. The title must be encoded in UTF-8. |
| Description | String | No | The description of the image. The description can be up to 1,024 bytes in length. The description must be encoded in UTF-8. |
| Tags | String | No | The tags of the image. 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. |
| CateId | Long | No | The ID of the category. To obtain the category ID, perform the following steps:Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > Media Management > Categories.Obtain the category ID from the response to the AddCategory operation that you call to create a category.Obtain the category ID from the response to the GetCategories operation that you call to query categories. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****",
"NonExistImageIds": {
"ImageId": [
"f45cf4eba5c80233389558c39****"
]
}
}Error codes
For a list of error codes, visit the Service error codes.