Docs
api
Cloud Disk(UDisk)
CloneUDiskSnapshot

Clone Snapshot - CloneUDiskSnapshot

Overview

Create UDisk clone from snapshot

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CloneUDiskSnapshot.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
NamestringInstance NameYes
SourceIdstringClone Parent Snapshot’s IdYes
SizeintThe size of the new cloned UDisk, unit: GB. The specified Size must be greater than or equal to the source disk Size, if it’s less than the source disk Size or this parameter is not specified, the new disk will be cloned according to the source disk Size. 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].No
CommentstringDisk AnnotationNo
ChargeTypestringYearly, Monthly, Dynamic, Postpay Default: DynamicNo
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
RdmaClusterIdstringRDMA cluster id. Specifies the corresponding RDMA cluster to which the RSSD cloud disk is cloned.No
HostIdstringHost Instance ID. The cloned cloud disk can be directly mounted to this host.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]Create UDisk IdNo

Example

Request Example

https://api.dezai.com/?Action=CloneUDiskSnapshot
&Region=cn-bj2
&Zone=cn-bj2-04
&Size=20
&SourceId=bsSnap-xxx
&Tag=LSaZloNt
&SnapshotService=qXPYAcHA
&RdmaClusterId=hmzHOiGl
&HostId=lnQqLvCP
&BackupMode=JFerwpSG
&Journal=9
&Hour=5
&Day=4

Response Example

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