Links

Data Types

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.

ZoneInfo

Zone information, including city, etc.
Parameter Name
Type
Description
zoneId
String
Zone ID. For example, SEL-A.
zoneName
String
Zone name.
supportSecurityGroup
Boolean
Support security groups or not.
supportNetworkType
String
Supported network types.
  • CLASSICS: Classic network
  • VPC: VPC network

InstanceStatus

Status of instances. See InstanceStatusValue for more detailed information.
Parameter Name
Type
Description
instanceId
String
Instance ID.
instanceStatus
String
Instance status. See InstanceStatusValue for more detailed information.

InternetChargeType

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

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.
instanceType
String
Instance model ID.
cpuCount
Integer
Quantity of CPU cores.
Unit: cores.
memory
Integer
Memory size.
Unit: GiB.
imageId
String
Image ID.
imageName
String
Image name.
instanceChargeType
String
Instance pricing model.
PREPAID: monthly subscription.
POSTPAID: pay-as-you-go.
internetMaxBandwidthOut
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 IP addresses.
subnetId
String
Subnet ID to which the instances belong..
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.
trafficPackageSize
Float
Traffic package size purchased.
Unit: TB.
securityGroupIds
Array of String
ID List of security groups to which the instances are added.
systemDisk
Information of system disk.
dataDisks
Array of DataDisk
Information of data disk.
autoRenew
Boolean
Whether to enable auto-renewal. For subscription instances, if you cancel subscription, the field returns false.
keyId
String
SSH key pair ID. The value may be null, indicating that there is no valid value.

KeyPair

Information in SSH key pair.
Parameter Name
Type
Description
keyId
String
SSH key pair ID.
For example: key-xxxxxxxx.
keyName
String
SSH key pair name.
publicKey
String
Public key pair content in OpenSSH format.
For example: ssh-rsa XXXXXXXXXXXX key_xxx.
keyDescription
String
SSH key pair description.
createTime
Timestamp
Creation time.
Format: YYYY-MM-DDTHH:mm:ssZ.

SystemDisk

Information on system disk that stores operating system.
Parameter Name
Type
Description
diskId
String
System disk ID. This is an output parameter returned in the data query APIs like DescribeInstances. Can't be used as an input parameter in data writer interfaces like
CreateInstances.
diskSize
Integer
Size of system disk. Unit: GiB.
diskCategory
String
Disk type.
  • Standard Disk: Hard Disk Drive
  • SSD: Solid State Drive
The default value is Standard Disk.

DataDisk

Information on data disk.
Parameter Name
Type
Description
diskId
String
Data disk ID. This is an output parameter returned in the data query APIs like DescribeInstances. Can't be used as an input parameter in data writer interfaces like
CreateInstances.
diskSize
Integer
Size of data disk. Unit: GiB.
diskName
String
Data disk name. This is an output parameter returned in the data query APIs like DescribeInstances.
diskCategory
String
Disk type.
  • STANDARD: Standard Disk
  • SSD: Solid State Drive
The default value is STANDARD.
portable
Boolean
Whether the data disk is detachable or not.
This parameter is only used to query the output parameter, while not the input parameter. true: the data disk is detachable, and thus will not be deleted while deleting its attached instance. false: the data disk is undetachable, and thus will be deleted at the same time while deleting its attached instance.
diskAmount
Integer
Quantity of data disks. This parameter is used only as the input parameter in interfaces such as CreateInstances and InquiryPriceCreateInstance.
diskPrice
Price
Price of data disks. This parameter is used only as the output parameter in interfaces such as
InquiryPriceCreateInstance.

InstanceTypeQuotaItem

Quotas of instance models.
Parameter Name
Type
Description
zoneId
String
Zone ID.
instanceType
String
Instance model.
cpuCount
Integer
Quantity of CPU cores.
Unit: cores.
memory
Integer
Memory size.
Unit: GiB.
frequency
String
CPU frequency.
internetMaxBandwidthOutLimit
Integer
Outbound bandwidth cap.
Unit: Mbps.
instanceTypeName
String
Instance model name.
internetChargeTypes
Array of String
Network billing model. See
InternetChargeType for more details.

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.

InstanceStatusValue

Status of instance.
Status
Description
PENDING
To be created.
DEPLOYING
Creating.
CREATE_FAILED
Creating failed.
REBUILDING
Rebuilding.
RUNNING
Running.
STOPPED
Powered off.
BOOTING
Powered on.
STOPPING
Powering off.
RELEASING
Releasing.
RECYCLING
Recycling.
RECYCLE
Recycled.
RESIZING
Resizing.

ImageInfo

Information on images.
Parameter Name
Type
Description
imageId
String
Image ID.
imageName
String
Image name.
imageType
String
Image type.
  • PUBLIC_IMAGE: the default images.
  • CUSTOM_IMAGE: the newly created images by yourself.
imageSize
String
Image size. Unit: GB.
imageDescription
String
Image description.
imageVersion
String
Image version.
imageStatus
String
Image status.
  • CREATING: creating.
  • AVAILABLE: able to use.
  • UNAVAILABLE: unable to use.
category
String
Image category.
Available values:
  • CentOS
  • Windows
  • Ubuntu
  • Debian
osType
String
Operating system type.
Available values:
  • Windows
  • Linux

ImageQuotaInfo

Quotas of images.
Parameter Name
Type
Description
zoneId
String
Zone supported for images.
count
Integer
Quantity of current images.
maxCount
Integer
Maximum quantity of images in current zone.

DiskInfo

Information on disks, including size, type and etc. of both system disks and data disks.
Parameter Name
Type
Description
diskId
String
Disk ID.
diskName
String
Disk name.
zoneId
String
Zone ID to which the disks belong.
diskType
String
Disk type.
  • SYSTEM: System Disk;
  • DATA: Data Disk.
portable
Boolean
Whether the disk is detachable or not.
diskCategory
String
Disk category.
  • cloud_efficiency: Ultra Disk.
diskSize
Integer
Disk size. Unit: GB.
diskStatus
String
Disk status.
See DiskStatus for more details.
instanceId
String
Attached instance ID.
instanceName
String
Attached instance name.
chargeType
String
Disk pricing model.
PREPAID: monthly subscription.
POSTPAID: pay-as-you-go.
createTime
Timestamp
Creation time.
Format: YYYY-MM-DDThh:mm:ssZ.
expiredTime
Timestamp
Expiration time.
Format: YYYY-MM-DDThh:mm:ssZ.
period
Integer
Subscription term.
Unit: Month.
The value is empty for POSTPAID pricing model.
autoRenew
Boolean
Whether to enable auto-renewal. For subscription instances, if you cancel subscription, the field returns false.

DiskStatus

Information on disk status.
Status
Description
IN_USE
In use.
AVAILABLE
Available to be attached.
ATTACHING
Attaching.
DETACHING
Detaching.
CREATING
Creating.
DELETING
Releasing.
RECYCLING
Recycling.
RECYCLED
Recycled.

diskCategory

Information on disk type.
Parameter Name
Type
Description
zoneId
String
Zone ID.
categorySet
Array of String
Available disk type.

SecurityGroupInfo

Information on security group, including security group creation.
Parameter Name
Type
Description
securityGroupId
String
Security group ID.
securityGroupName
String
Security group name.
securityGroupStatus
String
createTime
Timestamp
Creation time.
Format: YYYY-MM-DDThh:mm:ssZ.
description
String
Security group description.
instanceIds
Array of String
ID list of applied instances.
ruleInfos
Array of RuleInfo
Security group rules.
isDefault
Boolean
Whether the security group is default or not.

SecurityGroupStatus

Status of security group.
Status
Description
Available
Available.
Fail
Creating failed.

RuleInfo

Information on security group rules, including inbound/outbound rules, port range, IP protocol, etc.
Parameter Name
Required
Type
Description
direction
Yes
String
Traffic directions.
ingress: inbound rules.
egress: outbound rules.
policy
No
String
Access strategy.
Available values:
accept: allows access by default.
Only accept strategy is supported for now.
priority
Yes
Integer
Priority of rules.
Available values:
[1,100].
Default value: 1.
ipProtocol
Yes
String
Transport protocol. The value is case sensitive.
Available value:
  • tcp: TCP protocol.
  • udp: UDP protocol.
  • icmp: ICMP protocol.
  • all: all protocols supported.
portRange
Yes
String
Destination port range.
Available values:
  • For TCP and UDP protocols: The value ranges from 1 to 65535. Use a slash (/) to separate the start port number and the end port number. Examples: 1/200; incorrect example: 200/1.
  • For ICMP protocol: -1/-1.
  • For all protocols: -1/-1.
cidrIp
Yes
String
Source IP address range.
Default value: 0.0.XX.XX/0.

InstanceAvailableSecurityGroup

Available security groups for instances.
Parameter Name
Type
Description
securityGroupId
String
Security group ID.
securityGroupName
String
Security group name.
isDefault
Boolean
Whether the security group is default or not.

NetworkInfo

Information on private network, including network name, CIDR block, instance ID, etc.
Parameter Name
Type
Description
networkId
String
Network ID.
zoneId
String
Zone ID of network.
networkName
String
Network name.
networkStatus
String
Network status. See NetworkStatus for more details.
networkDescription
String
Network description.
cidrBlock
String
Network CIDR block.
subnetCount
Integer
Quantity of subnets under a network.
instanceCount
Integer
Quantity of instances under a network.
createTime
Timestamp
Creation time.
instanceIdList
Array of String
ID list of instances under a network.

SubnetInfo

Information on subnet of private network, including subnet name, CIDR block, instance ID, etc.
Parameter Name
Type
Description
subnetId
String
Subnet ID.
zoneId
String
Zone ID of subnet.
subnetName
String
Subnet name.
subnetStatus
String
Subnet status. See SubnetStatus for more details.
subnetDescription
String
Subnet description.
cidrBlockList
Array of String
ID list of subnet CIDR block.
cidrBlock
String
Subnet CIDR block.
usageIpCount
Integer
Quantity of used IP addresses in subnet.
totalIpCount
Integer
Quantity of total IP addresses in subnet.
createTime
Timestamp
Creation time.
instanceIdList
Array of String
ID list of instances under a subnet.
isDefault
Boolean
Whether the subnet is default or not.

VpcNetworkInfo

VPC information.
Parameter Name
Type
Description
vpcId
String
VPC ID.
zoneId
String
Zone ID of VPC.
vpcName
String
VPC name.
vpctStatus
String
VPC state.
cidrBlock
String
CIDR block of VPC.
subnetIdList
Array of String
List of subnets under a VPC.
createTime
String
Creation time of VPC.
isDefault
Boolean
Whether the VPC is default or not.

VpcSubnetInfo

VPC subnet information.