1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to delete a snapshot group. Only one snapshot group can be deleted per call.
- By default, all snapshots in the snapshot group will be deleted.
- If a snapshot in the snapshot group has an associated image, the deletion will fail and no snapshot will be deleted. If simultaneous deletion of images bound to the snapshot is required, the parameter DeleteBindImages=true can be specified.
Default interface request rate limit: 20 times per second.
Interface update time: 2021-12-04 03:48:05.
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: DeleteSnapshotGroup |
| 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 |
| SnapshotGroupId | Yes | No | String | Snapshot Group ID Example: csnap-gv9naz6b |
| DeleteBindImages | No | No | Bool | It indicates whether to delete the image associated with the snapshot group at the same time. The value false indicates not deleting the image bound to the snapshot group. In this case, if the snapshot group has bound images, the deletion will fail. The value true indicates deleting the image bound to the snapshot group at the same time. The default value is false. Example: true |
| OnlyDismiss | No | No | Bool | Dissolve the snapshot group.The value true indicates only dissolving the snapshot group without deleting the snapshots associated with the group. The value false indicates deleting the snapshots associated with the group as well. 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 |
|---|---|
| UnsupportedOperation.SnapshotHasBindedImage | The snapshot is already associated with an image. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InvalidParameter | Parameter error |