Links

Data Types

Zone

Zone information, including city, etc.
Parameter Name
Type
Required
Description
zoneId
String
Yes
Zone ID. For example, SEL-A.
zoneName
String
Yes
Zone name.
cityName
String
Yes
City name of the zone.
areaName
String
Yes
Region name of the zone.

ChargePrepaid

Details of the monthly subscription, including the purchase period, auto-renewal, etc.
Parameter Name
Type
Required
Description
period
Integer
Yes
Period of subscription.
Unit: month.

RaidConfig

Disk RAID configuration, including custom RAID settings.
Parameter Name
Type
Required
Description
raidType
Integer
No
RAID levels for rapid RAID settings. Value possible: 0, 1, 5, 10. Only one of raidType and customRaids can be specified.
customRaids
Array of CustomRaid
No
RAID levels for custom RAID settings. Only one of raidType and customRaids can be specified.

CustomRaid

RAID levels and disk serial number for custom RAID settings.
Parameter Name
Type
Required
Description
raidType
Integer
Yes
RAID levels. Value possible: 0, 1, 5, 10.
diskSequence
Array of Integer
Yes
Serial number of the disk Numbered sequentially starting from 1. Multiple disk serial numbers should be consecutive.

Partition

Partition configuration information, including file type, partition size, etc.
Parameter Name
Type
Required
Description
fsType
Integer
Yes
File type of partition.
Linux: ext2, ext3, ext4, ext type is needed.
Windows: NTFS.
fsPath
String
Yes
Partition letter.
Linux: must start with "/", and the first system partition must be "/".
Windows: support C~H, the first system partition must be designated as "C".
size
Integer
Yes
Partition size. Unit: GiB.

Nic

NIC configuration, including public and private NIC names settings.
Parameter Name
Type
Required
Description
wanName
String
No
Public NIC name. Only numbers, uppercase and lowercase letters are allowed, starting with a letter with a length limit of 4 to 10 characters. For non-high-availability models, the default public NIC name is wan0. It cannot start with lan. For high-availability models, the default public NIC name is bond0. Public and private NIC names cannot be the same.
lanName
String
No
Private NIC name. Only numbers, uppercase and lowercase letters are allowed, starting with a letter with a length limit of 4 to 10 characters.
For non-high-availability models, the default private NIC name is lan0. It cannot start with wan. For high-availability models, the default private NIC name is bond1. Public and private NIC names cannot be the same.

InstanceType

Information on instance models, including CPU, memory, subnet supported or not, etc.
Parameter Name
Type
Description
instanceTypeId
String
Instance model ID.
description
String
Model description, including memory size, disk, etc.
cpuCoreCount
Integer
Quantity of CPU cores.
memorySize
Integer
Memory size.
Unit: GB.
supportRaids
Array of Integer
RAID level supported.
supportSubnet
Boolean
Subnet supported or not.
maximumBandwidth
Integer
Outbound bandwidth cap.
Unit: Mbps.
diskInfo
Disk size.
Unit: GB.
imageIds
Array of String
Image ID supported.
isHA
Boolean
High availability supported or not.

InstanceDiskInfo

Information on disks.
Parameter Name
Type
Description
totalDiskSize
Integer
Total disk size. Unit: GiB. The available storage space is relatively less than the total disk size to create partitions successfully. What remains actually will be added to the last partition.
diskDescription
String
Description of the disks.
disks
Array of Disk
Disk information available for RAID and partition. Numbered sequentially. For example, for 880 x 2 and 220 x 2, the disk serial numbers 1, 2, 3, and 4 respectively correspond to disk sizes of 880 GB, 880 GB, 220 GB, and 220 GB.

AvailableResource

Information on instance resources for sale. Describe what kinds of instance models are available for sale in the specified zones.
Parameter Name
Type
Description
zoneId
String
Zone ID
sellStatus
String
Status for sale.
  • SELL: available for sale, stock > 10.
  • SELL_SHORTAGE: available for sale, stock < 10.
  • SOLD_OUT: sold out.
internetChargeTypes
Array of String
Network pricing model.
See InternetChargeType for details.
instanceTypeId
String
ID of the instance model.
maximumBandwidthOut
Integer
Public outbound bandwidth cap. Unit: Mbps.
defaultBandwidthOut
Integer
Default free public bandwidth for the pricing model of flat rate. Unit: GB.
defaultTrafficPackageSize
Float
Default free traffic package for the pricing model of data transfer. Unit: TB.
qty
Integer
The inventory quantity of the instance model at zone.

Disk

Information on disks.
Parameter Name
Type
Description
diskSize
Integer
Disk size. Unit: GB.
diskCount
Integer
Quantity of disks of the size.

InstanceStatus

Status of instance.
Status
Description
PENDING
To be created.
CREATING
Creating.
CREATE_FAILED
Creating failed.
INSTALLING
Installing.
INSTALL_FAILED
Installing failed.
RUNNING
Running.
STOPPED
Powered off.
BOOTING
Powered on.
STOPPING
Powering off.
RECYCLE
Recycled.

InternetChargeType

Network pricing model.
Type
Description
ByBandwidth
Billed by the flat rate bandwidth.
ByTrafficPackage
Billed by the traffic package size purchased.
ByInstanceBandwidth95
Billed by the burstable 95th bandwidth of a single instance.
ByClusterBandwidth95
Billed by the burstable 95th bandwidth of instances in a bandwidth cluster.

EipAddress

Information on elastic IPs.
Parameter Name
Type
Description
eipId
String
ID of the elastic IP.
zoneId
String
Zone ID to which the elastic IPs belong.
ipAddress
String
IP address.
instanceId
String
Instance ID
instanceName
String
Instance name.
eipChargeType
String
Pricing model.
PREPAID: monthly subscription.
POSTPAID: pay-as-you-go.
period
Integer
Period of elastic IP subscription.
Unit: month.
The value is empty for pay-as-you-go elastic IPs.
createTime
Timestamp
Creation time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
expiredTime
Timestamp
Expiration time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
Note:
The value is empty for pay-as-you-go resources.
eipStatus
String
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.

EipAvailable

Available elastic IPs for sale in specified zones.
Parameter Name
Type
Description
zoneId
String
Zone ID to which the elastic IPs belong.
status
String
Status for sale.
  • SELL: available for sale, stock > 10.
  • SELL_SHORTAGE: available for sale, stock < 10.
  • SOLD_OUT: sold out.

InstanceAvailableEip

Information on elastic IPs.
Parameter Name
Type
Description
eipId
String
ID of an elastic IP.
To obtain the elastic IP ID, you can call DescribeEipAddresses and look for eipId in the response.
ipAddress
String
IP address.

DdosIpAddress

Information on DDoS protected IPs.
Parameter Name
Type
Description
ddosIpId
String
ID of the DDoS protected IP.
zoneId
String
Zone ID to which the DDoS protected IPs belong.
ipAddress
String
IP address.
instanceId
String
Instance ID.
instanceName
String
Instance name.
ddosIpChargeType
String
Pricing model.
PREPAID: monthly subscription.
POSTPAID: pay-as-you-go.
period
Integer
Period of DDoS protected IP subscription.
Unit: month.
The value is empty for pay-as-you-go DDoS protected IPs.
createTime
Timestamp
Creation time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
expiredTime
Timestamp
Expiration time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
Note:
The value is empty for pay-as-you-go resources.
ddosIpStatus
String
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.

DdosIpAvailable

Available DDoS protected IPs for sale in specified zones.
Parameter Name
Type
Description
zoneId
String
Zone ID to which the DDoS protected IPs belong.
status
String
Status for sale.
  • SELL: available for sale, stock > 10.
  • SELL_SHORTAGE: available for sale, stock < 10.
  • SOLD_OUT: sold out.

InstanceAvailableDdosIp

Information on DDoS protected IPs.
Parameter Name
Type
Description
ddosIpId
String
ID of a DDoS protected IP.
To obtain the DDoS protected IP ID, you can call DescribeDdosIpAddresses and look for ddosIpId in the response.
ipAddress
String
IP address.

Price

Describe price information of prepaid and postpaid resources.
Parameter Name
Type
Description
OriginalPrice
Float
Original price of prepaid resources.
Only used in subscription model. For pay-as-you-go model, the value is empty.
discountPrice
Float
Discount price of prepaid resources.
Only used in subscription model. For pay-as-you-go model, the value is empty.
discount
Float
Discount. For example, 80.0 means 20% off.
unitPrice
Float
Original unit price of postpaid resources.
Only used in pay-as-you-go model. For tiered billing, the value is empty.
discountUnitPrice
Float
Discount unit price of postpaid resources.
Only used in pay-as-you-go model. For tiered billing, the value is empty.
chargeUnit
String
Unit of postpaid billing. Only used in pay-as-you-go model.
Value range: HOUR: you will be billed by hour. DAY: you will be billed by day. MONTH: you will be billed by month. For example, the burstable 95th pricing model.
stepPrices
Array of StepPrice
Tiered price of postpaid billing. Only used in pay-as-you-go model. If it is not tiered price, the value is empty.

StepPrice

Tiered price of postpaid billing. Describe a tier of the price.
Parameter Name
Type
Description
stepStart
Float
First price range of a tiered price.
stepEnd
Float
Last price range of a tiered price.
unitPrice
Float
Original unit price of current price range. Only used in pay-as-you-go model.
discountUnitPrice
Float
Discount unit price of current price range. Only used in pay-as-you-go model.

ImageInfo

Information on images.
Parameter Name
Type
Description
imageId
String
Image ID
imageName
String
Image name.
catalog
String
Image catalog.
The optional values are as follows:
  • CentOS
  • Windows
  • Ubuntu
  • Debian
  • ESXi
imageType
String
Image type.
The optional values are as follows:
PUBLIC_IMAGE: public image.
CUSTOM_IMAGE: custom image.
You cannot create a custom image by yourself currently. If necessary, please submit a ticket.
osType
String
Operating system type.
The optional values are as follows:
  • Windows
  • Linux

InstanceInfo

Information on instances.
Parameter Name
Type
Description
instanceId
String
Instance ID
zoneId
String
Zone ID to which the instances belong.
instanceName
String
Instance name to be displayed.
hostname
String
Instance hostname.
instanceTypeId
String
Instance model ID.
imageId
String
Image ID.
imageName
String
Image name.
instanceChargeType
String
Instance pricing model.
PREPAID: monthly subscription.
POSTPAID: pay-as-you-go.
bandwidthOutMbps
Integer
Public outbound bandwidth.
Unit: Mbps.
Value 0 means no limit, but not exceeds the upper limit of the instance model supported.
internetChargeType
String
Network pricing model.
See InternetChargeType for details.
period
Integer
Period of instance subscription.
Unit: month.
For postpaid instances, the value is empty.
publicIpAddresses
Array of String
List of public IPv4 addresses.
If the instance primary IP is not added to the public network interface, the primary IP will not be available., and its value will not be returned.
privateIpAddresses
Array of String
List of private IPv4 addresses.
ipv6Addresses
Array of String
Instance IPv6 addresses.
The value may be empty, which means no available IPv6 address exists.
subnetIds
Array of String
List of subnet IDs.
createTime
Timestamp
Creation time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
expiredTime
Timestamp
Expiration time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
resourceGroupId
String
Resource group ID to which instances belong.
resourceGroupName
String
Resource group name to which instances belong.
instanceStatus
String
Status of instances.
See InstanceStatus for details.
primaryPublicIpAddress
String
Instance primary IP.
trafficPackageSize
Double
Traffic package size purchased.
Unit: TB.
raidConfig
Disk array configuration.
partitions
Array of Partition
Partition configuration.
nic
Nic
NIC configuration.
autoRenew
Boolean
Whether to enable auto-renewal.

EipStatus

Status of elastic IPs.
Status
Description
CREATING
Creating.
CREATE_FAILED
Creating failed.
ASSOCIATING
Assigning.
UNASSOCIATING
Unassigning.
ASSOCIATED
Assigned.
AVAILABLE
Available.
RECYCLING
Recycling.
RECYCLE
Recycled.

DdosIpStatus

Status of DDoS protected IPs.
Status
Description
CREATING
Creating.
CREATE_FAILED
Creating failed.
ASSOCIATING
Assigning.
UNASSOCIATING
Unassigning.
ASSOCIATED
Assigned.
AVAILABLE
Available
RECYCLING
Recycling.
RECYCLE
Recycled.

CidrBlockInfo

Information on CIDR blocks.
Parameter Name
Type
Description
cidrBlockId
String
ID of CIDR block.
cidrBlockType
String
Type of CIDR block. The optional values are as follows:
  • IPv4
  • IPv6
cidrBlockName
String
CIDR block name.
zoneId
String
Zone ID to which the CIDR block belong.
cidrBlock
String
CIDR block.
gateway
String
Gateway address.
availableIpStart
String
Available IP starts.
availableIpEnd
String
Available IP ends.
availableIpCount
Integer
Quantity of available IPs.
instanceIds
Array of String
List of instance IDs.
status
String
chargeType
String
Pricing model.
PREPAID: monthly subscription.
POSTPAID: pay-as-you-go.
createTime
Timestamp
Creation time.
Format: YYYY-MM-DDThh:mm:ssZ.
expireTime
Timestamp
Expiration time.
Format: YYYY-MM-DDThh:mm:ssZ.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.

CidrBlockStatus

Status of CIDR blocks.
Status
Description
CREATING
Creating.
CREATE_FAILED
Creating failed.
RECYCLING
Recycling.
RECYCLE
Recycled.
AVAILABLE
Available.

AvailableIpv4Resource

Available IPv4 CIDR blocks.
Parameter Name
Type
Description
zoneId
String
Zone ID to which the CIDR block belongs.
netmask
Integer
Netmask.
sellStatus
String
Status for sale.
  • SELL: available for sale, stock > 10.
  • SELL_SHORTAGE: available for sale, stock < 10.
  • SOLD_OUT: sold out.

AvailableIpv6Resource

Available IPv6 CIDR blocks.