Docs
api
Cloud Disk(UDisk)
CreateUDisk

Create UDisk - CreateUDisk

Overview

Create UDisk Disk

💡 17092”: “The disk version is too low to enable UDataArk

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateUDisk.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
SizeintPurchase UDisk size, unit: GB, ordinary data disk: range [1~8000]; SSD data disk: range [1~8000]; RSSD data disk: range [1~32000]; High-efficiency data disk: range [1~32000].Yes
NamestringInstance NameYes
ChargeTypestringYearly, Monthly, Dynamic, Postpay, Trial. The default is Dynamic.No
QuantityintPurchase Duration Default: 1No
UDataArkModestring[Data Ark Access Has Been Disabled] Do you want to enable Data Ark? Yes: Enable, No: Disable, Default value: NoNo
SnapshotServicestringEnable snapshot service (Enabling snapshot service allows free activation of UDataArk). Yes: Enable, No: Do not enable, Default value: NoNo
TagstringBusiness Group Default: DefaultNo
DiskTypestringUDisk Type: DataDisk (Ordinary Data Disk), SSDDataDisk (SSD Data Disk), RSSDDataDisk (RSSD Data Disk), EfficiencyDataDisk (High Efficiency Data Disk), Default Value (DataDisk)No
UKmsModestringIs it encrypted. Yes: Encrypted, No: Not encrypted, Default value (No)No
CmkIdstringThe CMK ID required for encryption, must be filled when UKmsMode is ‘Yes’.No
RdmaClusterIdstringRDMA cluster id. Can be filled when DiskType is RSSDDataDisk, specifying the creation of the cloud disk to the corresponding RDMA cluster.No
BackupModestringSnapshot Service Backup Strategy. The basic package is activated by default, ‘Base’: Basic Edition, ‘Ultimate’: Flagship Edition, ‘Custom’: Custom Backup Chain.No
JournalintWhen BackupMode is set to Custom, settings are made based on multiples of 12 hours in seconds, such as 12, 24, 36, 48.No
HourintWhen BackupMode is set to Custom, settings are made on a 24-hour basis and multiplied, such as 24, 48, 72, 96.No
DayintWhen BackupMode is set to Custom, settings are made based on a multiple of 5 days, such as 5, 10, 15, 20, 25, 30.No
CouponIdstringID of the voucher usedNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
UDiskIdarray[string]UDisk Instance IdNo

Example

Request Example

https://api.dezai.com/?Action=CreateUDisk
&Region=cn-bj2
&Zone=cn-bj2-04
&Size=1
&Name=test_udisk
&UKmsMode=nVotfCwC
&UKmsMode=dETGTJcu
&CmkId=QimcSCvt
&IgnoreUBillInfo=ehrQXgoX
&UHostIdForAttachment=yIbJQDVn
&SnapshotService=VSFFRIXh
&RdmaClusterId=MBKDGzzF
&BackupMode=DvLHTYYK
&Journal=3
&Hour=1
&Day=9

Response Example

{
  "Action": "CreateUDiskResponse",
  "RetCode": 0,
  "UDiskId": [
    "bs-xxx"
  ]
}