1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to roll back a snapshot to the original cloud disk.
- It only supports rollback to the original cloud disk. For data disk snapshots, if you need to copy snapshot data to another cloud disk, use the [CreateDisks](../CBS APIs/CreateDisks) API to create an elastic cloud disk and then copy the snapshot data to the purchased cloud disk.
- Snapshots used for rollback 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.
- For an elastic cloud disk, it must be in the unmounted state. The cloud disk mounting status can be queried through the [DescribeDisks](../CBS APIs/DescribeDisks) API. For details, see the explanation of the Attached field. For a non-elastic cloud disk purchased along with CVM, the CVM must be in the shutdown state. The CVM status can be queried through the [DescribeInstancesStatus](/tcloud/api/Compute/CVM/APIs/CVM (cvm)/Version (2017-03-12)/Instance APIs/DescribeInstancesStatus) API.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-14 01:35:19.
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: ApplySnapshot |
| 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 |
| SnapshotId | Yes | No | String | Snapshot ID. It can be queried through the DescribeSnapshots API. Example: snap-4zgc8cnk |
| DiskId | Yes | No | String | ID of the original cloud disk for the snapshot. It can be queried through the DescribeDisks API. Example: disk-7q2iy7gp |
| AutoStartInstance | No | No | Bool | Whether to start the instance after rollback is completed. Example: true |
| AutoStopInstance | No | No | Bool | Whether rollback with instance shut down is supported. 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 |
|---|---|
| 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. |
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| InvalidDiskId.NotFound | The input DiskId does not exist. |
| InvalidInstanceId.NotFound | The input InstanceId does not exist. |
| InvalidDisk.Busy | The cloud disk is busy. Try again later. |
| InvalidDisk.SnapshotCreating | The cloud disk is creating a snapshot. Try again later. |
| InvalidSnapshotId.NotFound | The input SnapshotId does not exist. |
| InvalidSnapshot.NotSupported | The snapshot does not support this operation. |
| InvalidParameter.DiskSizeNotMatch | The cloud disk size does not match the snapshot size. |
| ResourceBusy | The resource is busy. Try again later. |
| InvalidInstance.NotSupported | The Cloud Virtual Machine does not support mounting a cloud disk. |