Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to delete snapshot groups. One snapshot group can be deleted per call.
This API is used to delete all snapshots in the snapshot group by default.
This API is used to delete a snapshot group. If a snapshot in the snapshot group has an associated image, deletion will fail and no snapshot will be deleted. Parameters can be input to enable simultaneous deletion of images bound to the snapshot by setting DeleteBindImages equal to true.
A maximum of 20 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: DeleteSnapshotGroup. |
| 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. |
| SnapshotGroupId | No | String | Specifies the snapshot group ID. |
| SnapshotGroupIds.N | No | Array of String | List of snapshot group ids. this parameter and the snapshot group ID must provide at least one. if both are provided, they will be merged with the snapshot group ID. |
| DeleteBindImages | No | Boolean | Specifies whether to delete the image associated with the snapshot group at the same time. valid values: set to false (not delete the image bound to the snapshot group; at this point, if the snapshot group has bound images, deletion will fail) or set to true (delete the image bound to the snapshot group simultaneously). default value is false. |
| 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 a snapshot group and the bound mirror at the same time.
https://cbs.intl.tencentcloudapi.com/?Action=DeleteSnapshotGroup
&SnapshotGroupId=csnap-gv9naz6b
&DeleteBindImages=true
&<Common request parameters>
{
"Response": {
"RequestId": "d7c2dd0f-59b1-4243-af5f-8443a1527daa"
}
}
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 |
|---|---|
| InvalidParameter | Incorrect parameter. |
| InvalidSnapshotId.NotFound | The ‘SnapshotId’ entered does not exist. |
| MissingParameter | Missing parameter. |
| UnsupportedOperation.SnapshotHasBindedImage | A custom snapshot was created for this snapshot. First delete the corresponding image. |
| UnsupportedOperation.StateError | The resource does not support this operation in this status. |
피드백