tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteSnapshots

Last updated: 2023-06-21 15:01:14

1. API Description

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

This API is used to delete snapshots.

  • Only snapshots in the NORMAL state can be deleted. To query the state of a snapshot, you can call the DescribeSnapshots API and check the SnapshotState field in the response.
  • Batch operations are supported. If there is any snapshot that cannot be deleted, the operation will not be performed and a specific error code will be returned.

A maximum of 20 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: DeleteSnapshots.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
SnapshotIds.N Yes Array of String List of IDs of snapshots to be deleted, which can be queried via DescribeSnapshots.
DeleteBindImages No Boolean Whether to forcibly delete the image associated with the snapshot

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 snapshot

This example shows you how to delete a specified snapshot.

Input Example

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

{
    "SnapshotIds": [
        "snap-cgrmci8t"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "b4770576-d9eb-4689-0866-5a1f8200a722"
    }
}

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
InvalidParameterValue Invalid parameter value.
InvalidSnapshot.NotSupported Indicates that the operation is not supported for the snapshot.
InvalidSnapshotId.NotFound The ‘SnapshotId’ entered does not exist.
MissingParameter Missing parameter.
ResourceBusy The resource is busy. Try again later.
ResourceUnavailable.SnapshotCreating Unable to use: the snapshot is being created
UnauthorizedOperation.MFAExpired Multi-factor authentication (MFA) has expired. Please try again.
UnsupportedOperation Unsupported operation
UnsupportedOperation.SnapHasShared The snapshot is shared with others. Please cancel the sharing first.
UnsupportedOperation.SnapshotHasBindedImage A custom snapshot was created for this snapshot. First delete the corresponding image.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy