DeleteSnapshots

Last Updated At: 2026-08-03 00:04:14

1. Interface Description

Interface request domain name: cbs.api3.convergecloud.com.

This API is used to delete a snapshot.

  • The snapshot must be in the NORMAL state. The snapshot status can be queried through the DescribeSnapshots API. For details, see the explanation of the SnapshotState field in the output parameters.
  • Batch operations are supported. If any one in multiple snapshots cannot be deleted, the operation will not be executed and a specific error code will be returned.

Default interface request rate limit: 20 times per second.

Interface update time: 2025-03-29 00:42:26.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DeleteSnapshots
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
SnapshotIds Yes No Array of String ID list of snapshots to be deleted. It can be queried through the DescribeSnapshots API.
Example: ["snap-gybrif0z"]
DeleteBindImages No No Bool It indicates whether to delete the image associated with the snapshot at the same time. The value false indicates deleting the image bound to the snapshot. In this case, if the snapshot has bound images, the deletion will fail. The value true indicates deleting the image bound to the snapshot at the same time. The default value is false.
Example: true

3. Output Parameters

Parameter name Type Description
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
MissingParameter Missing parameter. The request does not include the mandatory parameter.
UnsupportedOperation.SnapshotHasBindedImage The snapshot is already associated with an image.
InvalidSnapshot.NotSupported The snapshot does not support this operation.
InvalidSnapshotId.NotFound The input SnapshotId does not exist.
InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported.
ResourceUnavailable.SnapshotCreating The snapshot is being created.