Domain name for API request: cvm.tencentcloudapi.com.
This API is used to delete one or more images.
CREATING
or USING
, the image cannot be deleted. Call the DescribeImages API to query the image status.A maximum of 10 requests can be initiated per second for this API.
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 |
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. |
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.
GET https://cvm.tencentcloudapi.com/?Action=DeleteImages
&ImageIds.0=img-34vaef8fe
&<Common request parameters>
{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}
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.
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"
}
{
"Response": {
"RequestId": "f24aca43-5135-4c9b-81fb-734969ce4c78"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?