Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to create one or more cloud disks.
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: CreateDisks. |
Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
Zone | Yes | String | Availability zone. You can call DescribeZones and get the information in the Zone parameter re |
DiskSize | Yes | Integer | Cloud disk size in GB. |
DiskType | Yes | String | Cloud disk media type. Valid values: "CLOUD_PREMIUM" (premium cloud disk), "CLOUD_SSD" (SSD cloud disk). |
DiskChargePrepaid | Yes | DiskChargePrepaid | Parameters of monthly subscribed cloud disks |
DiskName | No | String | Image name, which can contain up to 60 characters. |
DiskCount | No | Integer | Number of cloud disks. Range: [1, 30]. Default value: 1. |
DiskBackupQuota | No | Integer | Specify the quota of disk backups. No quota if it’s left empty. Only one quota is allowed. |
AutoVoucher | No | Boolean | Whether to use the vouchers automatically. It defaults to No. |
AutoMountConfiguration | No | AutoMountConfiguration | Automatically mount and initialize the data disk. |
Parameter Name | Type | Description |
---|---|---|
DiskIdSet | Array of String | List of IDs created by using this API. The returning of IDs does not mean that the instances are created successfully. You can call DescribeDisks API, and find the disk ID in the DiskSet returned to check its status. If the status changes from PENDING to UNATTACHED or ATTACHED , the instance is created successfully. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to create a cloud disk.
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDisks
<Common request parameters>
{
"DiskCount": 1,
"DiskChargePrepaid": {
"Period": 1,
"TimeUnit": "m"
},
"DiskName": "test",
"DiskType": "CLOUD_PREMIUM",
"DiskSize": 20,
"Zone": "ap-hongkong-2",
"DiskBackupQuota": 1
}
{
"Response": {
"DiskIdSet": [
"lhdisk-2q0cs4oe"
],
"RequestId": "69765fd3-56a6-4633-8afd-72ca7805226b"
}
}
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 |
---|---|
FailedOperation | Operation failed. |
FailedOperation.CreateDisksFailed | Failed to create the cloud disks. |
FailedOperation.InsufficientBalance | |
InvalidParameterValue.DiskInstanceZoneNotMatch | The AZ of cloud disk does not match the AZ of instance. |
InvalidParameterValue.InvalidDiskType | Invalid cloud disk type. |
InvalidParameterValue.InvalidZone | Invalid Zone value. |
InvalidParameterValue.PlatformTypeNotSupportFileSystem | The instance OS does not support this file system. |
InvalidParameterValue.PlatformTypeNotSupportMountPoint | The instance OS does not support the specified mount point. |
LimitExceeded.AttachDataDiskQuotaLimitExceeded | Failed to attach the disk: Reached the upper limit of attached data disks |
LimitExceeded.DiskQuotaLimitExceeded | Failed to create the image: Insufficient quota. |
ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
UnsupportedOperation.InvalidInstanceState | Unsupported operation: the instance status is invalid. |
UnsupportedOperation.LatestOperationUnfinished | Unsupported operation: the last operation of the instance has not been completed. |
UnsupportedOperation.TatAgentNotOnline | TAT agent on the instance is not online. |
Was this page helpful?