tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ApplyDiskBackup

最后更新时间：2023-06-21 15:01:18

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API is used to roll back a backup point to the original cloud disk.

  • Only rollback to the original cloud disk is supported. For a data disk backup point, if you want to copy the backup point data to another cloud disk, use the CreateSnapshot API to convert the backup point into a snapshot, use the CreateDisks API to create an elastic cloud disk, and then copy the snapshot data to it.
  • Only backup points in NORMAL status can be rolled back. To query the status of a backup point, call the DescribeDiskBackups API and see the BackupState field in the response.
  • For an elastic cloud disk, it must be in unattached status. To query the status of the cloud disk, call the DescribeDisks API and see the Attached field in the response. For a non-elastic cloud disk purchased together with an instance, the instance must be in shutdown status, which can be queried through the DescribeInstancesStatus API.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 No String Common Params. This parameter is not required for this API.
DiskBackupId Yes String ID of the cloud disk backup point, which can be queried through the DescribeDiskBackups API.
DiskId Yes String ID of the original cloud disk of the backup point, which can be queried through the DescribeDisks API.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Rolling back a backup point to the original cloud disk

This example shows you how to roll back a backup point to the original cloud disk.

Input Example

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyDiskBackup
<Common request parameters>

{
    "DiskId": "disk-xxxxxxxx",
    "DiskBackupId": "dbp-xxxxxxxx"
}

Output Example

{
    "Response": {
        "RequestId": "5d41fd68-372a-4c90-81c6-a6f982328058"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款