tencent cloud

1. API Description

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

This API is used to create cloud disks.

• This API supports creating a cloud disk with a data disk snapshot so that the snapshot data can be copied to the purchased cloud disk.
• This API is async. A cloud disk ID list will be returned when a request is made successfully, but it does not mean that the creation has been completed. You can call the DescribeDisks API to query cloud disks by DiskId. If a new cloud disk can be found and its status is UNATTACHED or ATTACHED, the cloud disk has been created successfully.

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

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.

3. Output Parameters

4. Example

Example1 Purchasing a cloud disk with basic parameters

This example shows you how to purchase a prepaid 50 GB HDD cloud disk in Guangzhou Zone 2 for one month, assign it to project 0, get a notification upon expiration, and enable automatic renewal for it.

Input Example

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

{
    "Placement": {
        "ProjectId": "0",
        "Zone": "ap-guangzhou-2"
    },
    "DiskChargeType": "PREPAID",
    "DiskCount": "1",
    "DiskType": "CLOUD_HSSD",
    "ThroughputPerformance": "100",
    "DiskSize": "500",
    "DiskChargePrepaid": {
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
        "Period": "1"
    }
}

Output Example

{
    "Response": {
        "DiskIdSet": [
            "disk-lzrg2pwi"
        ],
        "RequestId": "6a57da9a-2049-7182-2de3-5a1f8014ccfd"
    }
}

Example2 Creating an hourly pay-as-you-go cloud disk

This example shows you how to create an hourly pay-as-you-go 100 GB premium cloud disk in Guangzhou Zone 3.

Input Example

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

{
    "DiskName": "postPayDisk",
    "Placement": {
        "ProjectId": "0",
        "Zone": "ap-guangzhou-3"
    },
    "DiskChargeType": "POSTPAID_BY_HOUR",
    "DiskCount": "1",
    "DiskType": "CLOUD_PREMIUM",
    "DiskSize": "100"
}

Output Example

{
    "Response": {
        "DiskIdSet": [
            "disk-ecjc4cpw"
        ],
        "RequestId": "fe2274fa-eaec-4009-807b-6ffc00963fec"
    }
}

Example3 Creating a cloud disk by using a snapshot

This example shows you how to create a cloud disk by specifying a snapshot without specifying DiskSize. In this example, the size of the new cloud disk is the same as that of the snapshot, and the snapshot data will be copied to the new cloud disk.

Input Example

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

{
    "Placement": {
        "ProjectId": "0",
        "Zone": "ap-guangzhou-2"
    },
    "DiskChargeType": "PREPAID",
    "DiskCount": "1",
    "DiskType": "CLOUD_BASIC",
    "DiskChargePrepaid": {
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
        "Period": "1"
    },
    "SnapshotId": "snap-iepc4w3h"
}

Output Example

{
    "Response": {
        "DiskIdSet": [
            "disk-6rz0ilvu"
        ],
        "RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.