DeleteImages

Last updated: 2020-06-15 09:58:17

    1. API Description

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

    This API is used to delete images.

    • If the ImageState of an image is Creating or In Use, it cannot be deleted. Use DescribeImages to query the image state.
    • You can only create up to 10 custom images in each region. If you have used up the quota, you can delete images to create new ones.
    • A shared image cannot be deleted.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: DeleteImages.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. 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.

    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 an image whose image ID is 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"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help