Call the ModifyImageAttribute operation to modify the name, description, boot mode, and other information of a custom image.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: ModifyImageAttribute

The action that you want to perform. Value: ModifyImageAttribute.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

BootMode string Optional Sample value: UEFI

The image boot mode. If this parameter is left blank, the original configuration is retained. Value:

tip

For ARM images, the default value is UEFI, and this parameter can only be set to UEFI.

Description string Optional Sample value: This is my first image

The image description.

It can contain only Chinese characters, letters, digits, underscores (_), hyphens (-), equal signs (=), English commas (,), English periods (.), Chinese commas (，), Chinese periods (。), and spaces.

tip

When an empty string is passed in, the existing description information is cleared.

ImageId string required Sample value: image-ebgy1og99tfct0gw****

You can call the DescribeImages operation and configure the Visibility=private parameter to query and obtain the ID of the custom image.

ImageName string Optional Sample value: image-1

The name of the image.

It can contain only Chinese characters, letters, digits, underscores (_), hyphens (-), and English periods (.).

Response parameters

This operation has no specific response parameters. For more information, refer to Response structure.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	InvalidBootMode.Malformed	The specified BootMode is malformed.	The specified boot mode is invalid.
400	InvalidDescription.Malformed	The specified Description is malformed.	The specified description is invalid.
400	InvalidImageName.Malformed	The specified ImageName is malformed.	The specified image name is invalid.
400	InvalidImageStatus	The specified image is not in the correct status for the request.	The current status of the image does not support this operation.
400	MissingParameter.ImageId	The required parameter ImageId is not supplied.	The image ID cannot be empty.
404	InvalidImage.NotFound	The specified image does not exist.	The specified image does not exist.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.