All Products
Search
Document Center

Simple Application Server:DeleteCustomImage

Last Updated:Nov 04, 2024

Deletes a custom image.

Operation description

You can delete a custom image that you no longer need. After the custom image is deleted, you cannot use the custom image to reset the simple application servers that were created based on the custom image.

Note To delete a shared image, 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 API. 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 shared image of a simple application server in the ECS console.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
swas-open:DeleteCustomImagedelete
  • CustomImage
    acs:swas-open:{#regionId}:{#accountId}:customimage/{#ImageId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the custom image. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used 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 value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
ImageIdstringYes

The custom image ID.

m-2zehv38jjmwva1ee****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

30637AD6-D977-4833-A54C-CC89483E****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400CustomImageInShareThe custom image is being shared. Please disable sharing first and then delete it.The custom image is being shared. To delete this custom image, disable its sharing first.
404InvalidImageId.NotFoundThe specified ImageId does not exist.-
500InternalErrorAn error occurred while processing your request.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history