Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to roll back a backup to the original cloud disk.
This API only supports rolling back to the original cloud disk. For data disk backup points, if you need to copy backup point data to other CBS, use first CreateSnapshot to convert the backup point to a snapshot, and use CreateDisks to create a new elastic cloud disk, then copy snapshot data to the newly purchased cloud disk.
The backup point used for rollback must be in NORMAL status. The backup point status can be checked through the DescribeDiskBackups API, see BackupState field explanation in the output parameter.
If it is an elastic cloud disk, the CBS must be in an unmounted state. The CBS mount status can be queried through the DescribeDisks API. See Attached field explanation. If it is a non-elastic cloud hard disk purchased together with the instance, the instance must be in a powered off state. The instance status can be queried through the DescribeInstancesStatus API.
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: ApplyDiskBackup. |
| 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. |
| DiskBackupId | Yes | String | Cloud disk backup point ID. can be queried through the DescribeDiskBackups api. |
| DiskId | Yes | String | Original cloud disk ID of the backup point. can be queried through the DescribeDisks api. |
| AutoStopInstance | No | Boolean | Specifies whether to enable automatic shutdown before rolling back the CBS backup point. defaults to FALSE, which means no automatic shutdown. |
| AutoStartInstance | No | Boolean | Whether to automatically start after rolling back the cloud disk backup point, default to FALSE, means do not auto boot. the AutoStartInstance parameter can only be set to true when AutoStopInstance is true. |
| 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 roll back a backup point to the original cloud disk.
POST / HTTP/1.1
Host: cbs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyDiskBackup
<Common request parameters>
{
"DiskId": "disk-xxxxxxxx",
"DiskBackupId": "dbp-xxxxxxxx"
}
{
"Response": {
"RequestId": "5d41fd68-372a-4c90-81c6-a6f982328058"
}
}
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 |
|---|---|
| InvalidDisk.Busy | The cloud disk is busy. Try again later. |
| InvalidDisk.NotSupported | Indicates that the operation is not supported for the cloud disk. |
| InvalidDiskId.NotFound | The ‘DiskId’ entered does not exist. |
| InvalidInstance.NotSupported | Cloud Virtual Machine does not support mounting cloud disk. |
| ResourceBusy | The resource is busy. Try again later. |
| ResourceInUse.DiskRollbacking | The cloud disk is being rolled back. Please try again later. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.NotFound | The resource is not found. |
| ResourceUnavailable | The resource is unavailable. |
| ResourceUnavailable.NotSupported | The resource does not support this operation. |
フィードバック