Docs
api
Cloud Disk(UDisk)
DescribeUDiskPrice

Get UDisk Price - DescribeUDiskPrice

Overview

Get UDisk Instance Price Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeUDiskPrice.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
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]; ordinary system disk: range [1~8000]; SSD system disk: range [1~4000]; RSSD data disk: range [1~32000]; RSSD system disk: range [1~4000]; high-efficiency data disk: range [1~32000]; high-efficiency system disk: range [1~500].Yes
ChargeTypestringYearly, Monthly, Dynamic, Postpay, Trial Default: MonthlyNo
QuantityintThe duration of purchasing UDisk, the default value is 1.No
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
DiskTypestringUDisk Types: DataDisk (Ordinary Data Disk), SSDDataDisk (SSD Data Disk), RSSDDataDisk (RSSD Data Disk), EfficiencyDataDisk (High Efficiency Data Disk), SystemDisk (Ordinary System Disk), SSDSystemDisk (SSD System Disk), RSSDSystemDisk (RSSD System Disk), EfficiencySystemDisk (High Efficiency System Disk), Default Value (DataDisk)No
IsTotalPricestringDo you want to put the snapshot service (UDataArk) and cloud disk into one order? Yes: "Yes", No: "No", the default is "No"."""
No
MachineTypestringCloud Host Type (V2.0), enumeration values ["N", "C", "G", "O", "OM"]. Refer to Cloud Host Type Description.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

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
DataSetarray[UDiskPriceDataSet]Price parameter list, see UDiskPriceDataSet for specific instructions.No

Data Model

UDiskPriceDataSet

Field NameTypeDescription InformationRequired
ChargeTypestringYearly, Monthly, Dynamic, TrialNo
PriceintActual Price (Unit: Cent)No
ChargeNamestringUDataArk, USnap, UDisk, TotalNo
OriginalPriceintUser's discounted price (corresponding to billing CustomPrice)No
ListPriceintOriginal Price (Corresponding to Billing OriginalPrice)No

Example

Request Example

https://api.ucloud-global.com/udisk/?Action=DescribeUDiskPrice
&Region=cn-bj2
&Zone=cn-bj2-04
&ProjectId=org-xxx
&Size=1   
&ChargeType=Month   
&Quantity=12
&UDataArkMode=Yes
&IsTotalPrice=YdLeYNzn
&MachineType=pQoolJSR
&SnapshotService=pqQNahzy
&BackupMode=ijgbiqWg
&Journal=3
&Hour=5
&Day=9

Response Example

{
  "Action": "DescribeUDiskPriceResponse",
  "DataSet": [
    {
      "ChargeName": "UDisk",
      "ChargeType": "Month",
      "Price": 1360
    }
  ],
  "RetCode": 0
}