Data Types
ChargePrepaid
Details of the monthly subscription, including the purchase period, auto-renewal, etc.
period
Integer
Yes
Period of subscription.
Unit: month.
ZoneInfo
Zone information, including city, etc.
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 networkVPC: VPC network
InstanceStatus
Status of instances. See InstanceStatusValue for more detailed information.
instanceId
String
Instance ID.
InternetChargeType
Network pricing model.
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.
DiskWithInstance
Information on data disks created along with the instance.
instanceId
String
Instance ID.
diskIdSet
Array of String
Data disk ID created along with the instance.
KeyPair
Information in SSH key pair.
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.
BootDisk
Information on boot disk that stores operating system.
diskId
String
Boot 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 boot disk. Unit: GiB.
diskCategory
String
Disk type.
Standard: the Standard NVMe SSD.SSD: the Basic NVMe SSD.
Default value: Standard.
Disk
Information on disk.
diskId
String
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 disk. Unit: GiB.
diskName
String
Disk name.
This is an output parameter returned in the data query APIs like DescribeInstances.
diskCategory
String
Disk type.
Standard: the Standard NVMe SSD.SSD: the Basic NVMe SSD.
Default value: Standard.
portable
Boolean
Whether the disk is detachable or not.
This parameter is only used to query the output parameter, while not the input parameter.
true: the disk is detachable, and thus will not be deleted while deleting its attached instance.
false: the disk is undetachable, and thus will be deleted at the same time while deleting its attached instance.
diskAmount
Integer
Quantity of disks.
This parameter is used only as the input parameter in interfaces such as CreateInstances and InquiryPriceCreateInstance.
diskPrice
Price of disks. This parameter is used only as the output parameter in interfaces such as
InquiryPriceCreateInstance.
InstanceTypeQuotaItem
Quotas of instance models.
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.
Price
Describe price information of prepaid and postpaid resources.
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.
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.
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.
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.
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.
diskId
String
Disk ID.
diskName
String
Disk name.
zoneId
String
Zone ID to which the disks belong.
diskType
String
Disk type.
SYSTEM: Boot Disk;
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.
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.
resourceGroupId
String
Resource Id
resourceGroupName
String
Resource name
DiskCategory
Information on disk type.
zoneId
String
Zone ID.
categorySet
Array of String
Available disk type.
SecurityGroupInfo
Information on security group, including security group creation.
securityGroupId
String
Security group ID.
securityGroupName
String
Security group name.
createTime
Timestamp
Creation time.
Format: YYYY-MM-DDThh:mm:ssZ.
description
String
Security group description.
instanceIds
Array of String
ID list of applied instances.
isDefault
Boolean
Whether the security group is default or not.
SecurityGroupStatus
Status of security group.
Available
Available.
Fail
Creating failed.
RuleInfo
Information on security group rules, including inbound/outbound rules, port range, IP protocol, etc.
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.
securityGroupId
String
Security group ID.
securityGroupName
String
Security group name.
isDefault
Boolean
Whether the security group is default or not.
RegionInfo
regionId
String
Region ID.
regionName
String
Region name.
regionTitle
String
Region title.
enablePubIpv6
Boolean
Whether support public IPv6 or not.
VpcInfo
vpcId
String
Global VPC ID.
name
String
Global VPC name.
cidrBlock
String
CIDR block of global VPC.
ipv6CidrBlock
String
IPv6 CIDR block of global VPC.
mtu
Integer
MTU of global VPC.
isDefault
Boolean
Whether is default global VPC or not.
createTime
Timestamp
Creation time of global VPC.
usageIpv4Count
Integer
Used IPv4 quantity of the global VPC.
usageIpv6Count
Integer
Used IPv6 quantity of the global VPC.
securityGroupId
String
Associated security group ID of global VPC.
SubnetInfo
subnetId
String
Subnet ID.
regionId
String
Region ID.
name
String
Subnet name.
cidrBlock
String
CIDR block of subnet.
ipv6CidrBlock
String
IPv6 CIDR block of subnet.
stackType
String
Subnet IP stack type.
The optional values are as follows:
IPv4, IPv4_IPv6, IPv6
ipv6Type
String
Subnet IPv6 type.
The optional values are as follows:
Public, Private
vpcId
String
Global VPC ID to which the subnet belong.
vpcName
String
Global VPC name to which the subnet belong.
usageIpv4Count
Integer
Used IPv4 quantity of the subnet.
usageIpv6Count
Integer
Used IPv6 quantity of the subnet.
createTime
Timestamp
Creation time of subnet.
isDefault
Boolean
Whether is default subnet or not.
RouteInfo
routeId
String
Route ID.
name
String
Route name.
vpcId
String
Global VPC ID.
vpcName
String
Global VPC name.
ipVersion
String
IP type.
The optional values are as follows: IPv4, IPv6
type
String
Route type.
The optional values are as follows: RouteTypeSubnet, RouteTypeStatic
cidrBlock
String
CIDR block of route.
priority
Integer
Route priority.
nextHopId
String
Next hop ID.
nextHopName
String
Next hop name.
nextHopType
String
Next hop type.
The optional values are as follows: VPC, INSTANCE
createTime
Timestamp
Route creation time.
InstanceTrafficData
Instance bandwidth data.
internetRX
Long
Inbound bandwidth. Unit: bps.
internetTX
Long
Outbound bandwidth. Unit: bps.
time
String
Data time.
Format: YYYY-MM-DDThh:mm:ssZ.
InstanceCpuMonitorData
Instance CPU utilization information.
in
Float
Inbound bandwidth. Unit: bps.
out
Float
Outbound bandwidth. Unit: bps.
time
String
Data time.
Format: YYYY-MM-DDThh:mm:ssZ.
NetmaskInfo
Information on CIDR block size.
netmask
Integer
CIDR block size.
amount
Integer
CIDR block quantity.
CidrUsedIpInfo
Information on used CIDR IPs.
publicIp
String
CIDR IP address.
lanIp
String
Private IP address.
nicId
String
vNIC ID.
nicName
String
vNIC name.
instanceId
String
Instance ID.
instanceName
String
Instance name.
OwnCidr
Information on CIDR block that you bring.
cidrBlock
String
CIDR IP range.
ipNum
Integer
Quantity of CIDR IPs.
networkType
String
Network type of elastic IP.
CidrInfo
Information on CIDR block.
cidrId
String
CIDR block ID.
regionId
String
Region ID.
name
String
CIDR block name.
cidrBlock
String
CIDR IP range.
totalCount
Integer
Quantity of available CIDR IPs.
usedCount
Integer
Quantity of used CIDR IPs.
source
String
IP type. IP leasing or BYOIP.
networkType
String
Network type of elastic IP.
netmask
Integer
CIDR block size.
createTime
String
Creation time.
expiredTime
String
Expiration time.
period
Integer
Commitment term.
instanceChargeType
String
Billing model.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
PrivateIpInfo
Information on private IP address.
lanIp
String
Private IP address.
nicId
String
vNIC ID.
nicName
String
vNIC name.
instanceId
String
Instance ID.
instanceName
String
Instance name.
InstanceInfo
Information on instances.
instanceId
String
Instance ID.
instanceName
String
Instance name to be displayed.
zoneId
String
Availability zone ID to which the instances belong.
cpu
Integer
Quantity of CPU cores.
Unit: cores.
memory
Integer
Memory size.
Unit: GiB.
imageId
String
Image ID.
imageName
String
Image name.
publicIpAddresses
Array of String
List of public IPs.
privateIpAddresses
Array of String
List of private IPs.
keyId
String
SSH key pair ID. The value may be null, indicating that there is no valid value.
createTime
Timestamp
Creation time.
Format: YYYY-MM-DDThh:mm:ssZ.
expiredTime
Timestamp
Expiration time.
Format: YYYY-MM-DDThh:mm:ssZ.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
eipV4Type
Network type of public IPv4 address.
BGPLine
BGP IP.
CN2Line
CN2 IP.
LocalLine
Local IP.
ChinaTelecom
1-Line IP China Telecom.
ChinaUnicom
1-Line IP China Unicom.
ChinaMobile
1-Line IP China Mobile.
ThreeLine
3-in-1 IP Pool.
CidrIpBind
Information on CIDR IP and private IP binding.
nicId
String
vNIC ID.
publicIp
String
CIDR IP address.
lanIp
String
Private IP address.
Last updated