tencent cloud

文档反馈

DeleteImages

最后更新时间:2022-04-27 11:23:24

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DeleteImages.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ImageIds.N Yes Array of String List of the IDs of the instances to be deleted.
DeleteBindedSnap No Boolean Whether to delete the snapshot associated with the image
DryRun No Boolean Check whether deleting an image is supported

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

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

GET 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.

Command Line Interface

6. Error Code

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

Error Code Description
InvalidImageId.InShared The image is being shared.
InvalidImageId.IncorrectState Invalid image status.
InvalidImageId.Malformed Invalid image ID format.
InvalidImageId.NotFound The image cannot be found.
InvalidParameterValue.InvalidImageId The image does not support this operation.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
MutexOperation.TaskRunning An identical job is running.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持