1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to roll back the snapshot group.
- You can roll back all or part of the disks in the snapshot group.
- If the disks to be rolled back contain mounted disks, these disks must be mounted to the same instance, and the instance must be shut down before rollback can proceed.
- Rollback is an asynchronous operation. A successful API return does not mean the rollback is successful. You can query the result of the asynchronous rollback task through the DescribeSnapshotGroups API.
Default interface request rate limit: 20 times per second.
Interface update time: 2021-12-04 04:04:15.
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: ApplySnapshotGroup |
| 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 | ID of Snapshot Group Rolled Back Example: csnap-csoplz7u |
| ApplyDisks | Yes | No | Array of ApplyDisk | ID of Snapshot Rolled Back, Cloud Disk ID List Example:View |
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 |
|---|---|
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| UnsupportedOperation.SnapshotGroupDiskAttachMultiInstance | The original disk of the snapshot in the snapshot group is not mounted to the same instance. |