1. API Description

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

This API is used to create one or more 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 an async API. 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 state is 'UNATTACHED' or 'ATTACHED', it means that the cloud disk has been created successfully.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

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

Purchase a 50GB HDD cloud disk in Guangzhou Zone 2 for one month, assign it to project 0, and enable expiry notification and auto-renewal for it.

Input Example

https://cbs.tencentcloudapi.com/?Action=CreateDisks
&DiskType=CLOUD_BASIC
&DiskCount=1
&DiskSize=50
&Placement.Zone=ap-guangzhou-2
&Placement.ProjectId=0
&DiskChargeType=PREPAID
&DiskChargePrepaid.Period=1
&DiskChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
&<common request parameters>

Output Example

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

Example2 Creating a Cloud Disk Based on a Snapshot

Specify a snapshot to create a cloud disk. The DiskSize parameter is not specified, so the size of the purchased cloud disk equals to that of the snapshot. The snapshot data are copied to the purchased cloud disk.

Input Example

https://cbs.tencentcloudapi.com/?Action=CreateDisks
&DiskType=CLOUD_BASIC
&DiskCount=1
&SnapshotId=snap-iepc4w3h
&Placement.Zone=ap-guangzhou-2
&Placement.ProjectId=0
&DiskChargeType=PREPAID
&DiskChargePrepaid.Period=1
&DiskChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
&<common request parameters>

Output Example

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

Example3 Creating a Pay-as-you-go Cloud Disk

Create a 100GB pay-as-you-go premium cloud disk in the Guangzhou Zone 3.

Input Example

https://cbs.tencentcloudapi.com/?Action=CreateDisks
&DiskType=CLOUD_PREMIUM
&DiskCount=1
&Placement.Zone=ap-guangzhou-3
&Placement.ProjectId=0
&DiskChargeType=POSTPAID_BY_HOUR
&DiskName=postPayDisk
&DiskSize=100
&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

• API 3.0 Explorer

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

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.