Deletes a custom image. When you call this operation, you can specify ImageId and Force in the request.
Operation description
For information about scenarios in which you cannot delete a custom image and the considerations related to custom image deletion, see Delete a custom image.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the custom image. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
ImageId | string | Yes | The ID of the image. If the specified custom image does not exist, the request is ignored. | m-bp67acfmxazb4p**** |
Force | boolean | No | Specifies whether to forcefully delete the custom image. Valid values:
Default value: false. | false |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | ImageUsingByInstance | The specified image has been used to create instances. | The specified image has been used to create instances and cannot be deleted. |
403 | ImageUseShared | The specified image has been shared to others. | The specified image is already shared with other accounts. |
403 | OperationDenied.ImageCopying | The Image is coping. | The image is being copied. Try again later. |
403 | ImageIsImporting | The specified Image is importing. | The specified image is being imported and cannot be managed. |
403 | ImageIsExporting | The specified Image is exporting. Please cancel task first. | - |
403 | ImageIsPublic | You can not delete public image, please modify it to private. | The specified image is a community image and cannot be deleted. You must call the ModifyImageSharePermission operation to unpublish the image before you can delete the image. |
404 | InvalidImageId.NotFound | The specified ImageId does not exist. | The specified image does not exist in this account. Check whether the image ID is correct. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
No change history