tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateDiskBackup

最后更新时间：2023-03-16 16:17:31

1. API Description

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

This API is used to create a backup point for a cloud disk.

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: CreateDiskBackup.
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.
DiskId Yes String Name of the cloud disk for which to create a backup point.
DiskBackupName No String Name of the cloud disk backup point, which can contain up to 100 characters.

3. Output Parameters

Parameter Name Type Description
DiskBackupId String ID of the cloud disk backup point.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a backup point for a cloud disk

This example shows you how to manually create a backup point for a cloud disk with a backup point quota.

Input Example

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

{
    "DiskId": "disk-xxxxxxxx"
}

Output Example

{
    "Response": {
        "DiskBackupId": "dbp-xxxxxxxx",
        "RequestId": "a79a4333-ac8e-426c-8cfe-2923c4010d64"
    }
}

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.
InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
InvalidParameter Incorrect parameter.
ResourceInUse The resource is in use.
ResourceInsufficient.OverQuota Quota insufficient.
ResourceNotFound.NotFound The resource is not found.
ResourceUnavailable.NotSupported The resource does not support this operation.
ResourceUnavailable.SnapshotCreating Unable to use: the snapshot is being created
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款