Description
This operation allows you to modify the name and description of a custom image.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Action | String | Yes | Value: ModifyImageAttribute. |
| RegionId | String | Yes | Indicates the RegionId of the custom image. |
| ImageId | String | Yes | Indicates the ID of the custom image. |
| ImageName | String | No | This parameter indicates the name of the custom image. The image name can be 2 to 128 characters in length and: |
| Description | String | No | This parameter indicates the description of a custom image. The description can be 0 to 256 characters in length and cannot begin with http:// or https://. The default value is null. If the perimeter is left blank, the default value will be used |
Return parameters
All parameters are public return parameters. For details, refer to Public Return Parameters.
Error code
| Error code | Description | Http status code | Meaning |
|---|---|---|---|
| MissingParameter | An input parameter RegionId that is mandatory for processing the request is not supplied. | 400 | RegionId value is missing. |
| MissingParameter | An input parameter ImageId that is mandatory for processing the request is not supplied. | 400 | ImageId value is missing. |
| InvalidImageId.NotFound | The specified ImageId does not exist. | 403 | The specified image ID does not exist. |
| InvalidImageName.Malformed | The specified destination Image name is wrongly formed. | 400 | The specified image name is invalid. |
| InvalidDescription.Malformed | The specified destination image description is wrongly formed. | 400 | The specified image description is invalid. |
| InvalidImageName.Duplicated | The destination image is exist. | 400 | The image name is already in use. |
Examples
Request example
https://ecs.aliyuncs.com/?Action=ModifyImageAttribute&ImageId=m-281234567&RegionId=cn-qingdao&ImageName=testImage123&<Public Request Parameters>
Return example
XML format
<ModifyImageAttributeResponse><RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId></ModifyImageAttributeResponse>
JSON format
{"RequestId": "C8B26B44-0189-443E-9816-D951F59623A9"}