最后更新时间:2021-05-10 15:23:56

1. API Description

Domain name for API request:

This API (DeleteSnapshots) is used to delete snapshots.

  • The snapshot must be in NORMAL status. The snapshot status can be queried in the SnapshotState field in the output parameters through the API DescribeSnapshots.
  • Batch operations are supported. If one of the snapshots in a batch cannot be deleted, the operation is not performed and a specific error code is returned.

A maximum of 20 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:

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 parameter. The value used for this API: DeleteSnapshots.
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.
SnapshotIds.N Yes Array of String List of IDs of snapshots to be deleted, which can be queried via DescribeSnapshots.

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 a snapshot

Input Example
&<Common request parameters>

Output Example

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

5. Developer Resources


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.
UnauthorizedOperation.MFAExpired Multi-factor authentication (MFA) has expired. Please try again.
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.