tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteImages

Last updated: 2024-10-22 19:33:29

    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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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

    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.InvalidAppIdFormat Invalid AppID
    InvalidParameterValue.InvalidImageId The image does not support this operation.
    InvalidParameterValue.InvalidImageIdIsShared
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    MutexOperation.TaskRunning An identical job is running.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy