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 the "Copy custom images" topic.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| swas-open:DeleteCustomImages | delete |
|
| 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 parameters
Examples
Sample success responses
JSONformat
{
"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. |
| 404 | InvalidImageId.NotFound | The specified ImageId does not exist. | - |
| 500 | InternalError | An error occurred while processing your request. | - |
For a list of error codes, visit the Service error codes.