tencent cloud

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to delete one or more images.

• If the ImageState of an image is CREATING or USING, the image cannot be deleted. Call the DescribeImages API to query the image status.
• Up to 10 custom images are allowed in each region. If you have run out of the quota, delete unused images to create new ones.
• A shared image cannot be deleted.

A maximum of 10 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Deleting an image

This example shows you how to delete the image img-34vaef8fe. If the image is in use or the image ID does not exist, no operation will be performed, and an error code will be returned.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DeleteImages
&ImageIds.0=img-34vaef8fe
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
    }
}

Example2 Checking whether the specified image can be deleted

This example shows you how to delete the image img-34vaef8fe. If the image is in use or the image ID does not exist, no operation will be performed and an error code will be returned.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteImages
<Common request parameters>

{
    "ImageIds": [
        "img-mfih409y"
    ],
    "DryRun": "True",
    "DeleteBindedSnap": "True"
}

Output Example

{
    "Response": {
        "RequestId": "f24aca43-5135-4c9b-81fb-734969ce4c78"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.