DeleteImages

Last Updated At: 2026-08-02 00:05:20

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (DeleteImages) is used to delete one or more images.

When the Image Status is CREATING and USING, deletion is not allowed. The image status can be obtained through DescribeImages.
Each region supports creating a maximum of 10 custom images. Deleting images can free up the quota of your account.
When an image is being shared with other accounts, it cannot be deleted.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-10-28 03:49:19.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name	Required	Allow NULL	Type	Description
Action	Yes	No	String	Public parameter, The value of this interface: DeleteImages
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
ImageIds	Yes	No	Array of String	List of Image IDs to Be Deleted Example: ["img-34vaef8fe"]

3. Output Parameters

Parameter name	Type	Description
TaskId	String	Task ID Example: 543r242
flowId	Int64	Task Flow ID Example: 2
RequestId	String	Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code	Description
InvalidImageId.InShared	The image is being shared.
InvalidImageId.IncorrectState	The image status is illegal.
InvalidImageId.NotFound	Image not found
InvalidImageId.Malformed	Invalid image ID