DeleteCustomImages - Simple Application Server - Alibaba Cloud Documentation Center

Deletes custom images. If you no longer require a custom image, you can call this operation to delete the custom image. You can also call this operation to delete multiple custom images at the same time. After a custom image is deleted, you cannot use the custom image to reset the simple application servers that were created based on the custom image.

Operation description

If a custom image is shared, you must unshare the image before you can delete it. After a custom image is unshared, you cannot query the custom image by using the Elastic Compute Service (ECS) console or by calling an ECS API operation. If you want to use a custom image to create ECS instances, we recommend that you copy the custom image before you delete it. For more information, see Copy 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

swas-open:DeleteCustomImages

delete

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageIds}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
ImageIds	string	Yes	The ID of the custom image. The value can be a JSON array that consists of up to 15 image IDs. Separate multiple image IDs with commas (,).	["m-2zehv38jjmwva1ee**", "m-bp1hj0zhmheyq2kz**"]
ClientToken	string	No	The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****

Examples

Success response

JSON format

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	CustomImageInShare	The custom image is in sharing,please unshare first then to retry.	The custom image is being shared, please unshare.
500	InternalError	An error occurred while processing your request.
404	InvalidImageId.NotFound	The specified ImageId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.