Call the DeleteImage API to delete a custom image - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

For information about scenarios in which custom images cannot be deleted and precautions after an image is deleted, refer to Delete a custom image.

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

ecs:DeleteImage

delete

*Image

acs:ecs:{#regionId}:{#accountId}:image/{#imageId}

None

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 image ID. If the specified custom image does not exist, the request is ignored.	m-bp67acfmxazb4p****
Force	boolean	No	Specifies whether to execute a force delete. Valid values: true: Executes a force delete of the custom image, regardless of whether the image is in use by other instances. false: Deletes the custom image normally. The system checks whether the image is in use by other instances before the deletion. Default value: false.	false
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run and does not delete the image. If the request passes the dry run, the `DryRunOperation` error code is returned. false: Performs a normal request and deletes the image if the request passes the check. Default value: false.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

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. You can use the DescribeInstances API to query these instances, or you can use the force parameter to proceed.	The specified image has already been used to create the instance. You can query these instances using the DescribeInstances API or continue with the 'force' parameter.
403	ImageUseShared	The specified image has been shared to others. You can use the DescribeImageSharePermission API to query the users who have been shared.	The specified image has been shared with other users. You can use the DescribeImageSharePermission API to query shared users.
403	OperationDenied.ImageCopying	The image is being copied. Please use the CancelCopyImage API.	The image is being copied, please use the CancelCopyImage API.
403	ImageIsImporting	The specified Image is importing.
403	ImageIsExporting	The specified image is currently being exported. You can use the DescribeTasks API to check the status of related tasks and cancel them if needed.	The specified image is being exported. You can use the DescribeTasks API to check the task status and cancel the task if necessary.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.