Data Types
CapacityValue
Describing inventory capacity information.
Referenced by：DescribeVmInventoryCapacity
LIMITED
Limited inventory, with available vCPU cores < 1000.
STANDARD
Normal inventory, with available vCPU cores from 1000 to 2000.
SUFFICIENT
Sufficient inventory, with available vCPU cores from 2000 to 5000.
ABUNDANT
Abundant inventory, with available vCPU cores ≥ 5000.
ChargePostpaid
Postpaid mode, parameter settings related to pay-as-you-go.
Referenced by：CreateInstances, InquiryPriceCreateInstance
period
Integer
Yes
Postpaid duration.
Unit: Month.
Value range: [1.0, +)
Default value: 0
ChargePrepaid
Details of the monthly subscription, including the purchase period, auto-renewal, etc.
Referenced by：InquiryPriceCreateDisks, CreateDisks, CreateInstances, InquiryPriceCreateInstance
period
Integer
Yes
Period of subscription.
Unit: month.
Value range: [1, +)
ChargeType
Pricing model.
Referenced by：InquiryPriceCreateDisks, CreateDisks, CreateInstances, DescribeInstances, DescribeZoneInstanceConfigInfos, DescribeDiskCategory, InquiryPriceCreateInstance, DescribeDisks
PREPAID
Subscription.
POSTPAID
Pay-as-you-go.
DataDisk
Information on data disk.
Referenced by：CreateInstances, DescribeInstances, InquiryPriceCreateInstance
diskSize
Integer
Yes
Size of data disk.
Unit: GiB.
Value range: [1, +)
diskId
String
No
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.
diskName
String
No
Data disk name.
This is an output parameter returned in the data query APIs like DescribeInstances.
diskAmount
Integer
No
Quantity of data disks.
This parameter is used only as the input parameter in interfaces such as CreateInstances and InquiryPriceCreateInstance.
Value range: [1, +)
Default value: 1
portable
Boolean
No
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.
diskCategory
String
No
Disk type.STANDARD: Standard DiskSSD: Solid State DriveThe default value is STANDARD.
Default value: SSD
diskPrice
No
Price of data disks.
This parameter is used only as the output parameter in interfaces such as
InquiryPriceCreateInstance.
DescribeInstanceCpuMonitorData
Information about CPU monitor data
Referenced by：DescribeInstanceCpuMonitor
cpu
String
CPU utilization.
Unit: % .
time
String
Data time
DiskCategory
Information on disk type.
Referenced by：DescribeDiskCategory
zoneId
String
Zone ID.
categorySet
Array of String
Available disk type.
DiskInfo
Information on disks, including size, type and etc. of both system disks and data disks.
Referenced by：DescribeDisks
diskId
String
Disk ID.
diskName
String
Disk name.
zoneId
String
Zone ID to which the disks belong.
portable
Boolean
Whether the disk is detachable or not.
Default value: false
diskCategory
String
Disk category.cloud efficiency: Ultra Disk.
diskSize
Integer
Disk size. Unit: GB.
instanceId
String
Attached instance ID.
instanceName
String
Attached instance name.
createTime
String
Creation time.
Format: YYYY-MM-DDThh:mm:ssZ.
expiredTime
String
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.
Referenced by：DescribeDisks
CREATING
Creating.
IN_USE
In use.
AVAILABLE
Available to be attached.
CHANGING
Changing
ATTACHING
Attaching.
DETACHING
Detaching.
DELETING
Releasing.
RECYCLED
Recycled.
RECYCLING
Recycling.
DiskType
Describe the value of cloud disk type.
Referenced by：DescribeDisks
SYSTEM
System Disk.
DATA
Data Disk.
DiskWithInstance
Information on data disks created along with the instance.
Referenced by：CreateInstances
instanceId
String
Instance ID.
diskIdSet
Array of String
Data disk ID created along with the instance.
ImageCategory
Image Type.
Referenced by：DescribeImages
Windows
Windows
Ubuntu
Ubuntu
CentOS
CentOS
Debian
Debian
ARCH_LINUX
Arch Linux
COREOS
CoreOS
FEDORA
Fedora
FreeBSD
FreeBSD
KYLIN
Kylin
ORACLE_LINUX
Oracle Linux
REDHAT
Red Hat
SUSE
SUSE
TencentOS
TencentOS
OTHERS
Others
ImageInfo
Information on images.
Referenced by：DescribeImages
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
Image status.CREATING: creating.AVAILABLE: able to use.UNAVAILABLE: unable to use.
category
String
Image category.
Available values:CentOSWindowsUbuntuDebian
osType
String
Operating system type.
Available values:WindowsLinux
ImageQuotaInfo
Quotas of images.
Referenced by：DescribeImageQuota
zoneId
String
Zone supported for images.
count
Integer
Quantity of current images.
maxCount
Integer
Maximum quantity of images in current zone.
ImageSourceType
The image source.
Referenced by：DescribeImages
PUBLIC_IMAGE
System image.
CUSTOM_IMAGE
Custom image.
ImageStatus
Values of image states.
Referenced by：DescribeImages
CREATING
Creating.
AVAILABLE
Image creation succeeded.
UNAVAILABLE
Not available.
ImageType
Information about image type.
Referenced by：DescribeImages
linux
Linux
windows
Windows
InstanceAvailableSecurityGroup
Available security groups for instances.
Referenced by：DescribeInstanceAvailableSecurityGroupResources
securityGroupId
String
Security group ID.
securityGroupName
String
Security group name.
isDefault
Boolean
Whether the security group is default or not.
InstanceInfo
Information on instances.
Referenced by：DescribeInstances
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
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.
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.
publicIpv6Addresses
Array of String
List of public IPv6 addresses.
privateIpAddresses
Array of String
List of private IP addresses.
subnetId
String
Subnet ID to which the instances belong..
createTime
String
Creation time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
expiredTime
String
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.
trafficPackageSize
Float
Traffic package size purchased.
Unit: TB.
securityGroupIds
Array of String
ID List of security groups to which the instances are added.
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.
InstancePlanStatus
Describe the status of the instance plan change.
Referenced by：DescribeInstanceTypeStatus
Processing
Processing.
WaitToEnable
Waiting for the plan changes to take effect.
Disable
Disabled.
InstanceStatus
Status of instances. See InstanceStatusValue for more detailed information.
Referenced by：DescribeInstancesStatus
instanceId
String
Instance ID.
InstanceStatusValue
Status of instances.
Referenced by：DescribeInstancesStatus, DescribeInstances
PENDING
Pending
DEPLOYING
Deploying
REBUILDING
Rebuilding.
REBOOT
Rebooting.
RUNNING
Running.
STOPPED
Powered off.
BOOTING
Powered on.
RELEASING
Releasing.
STOPPING
Powering off.
RECYCLE
Recycled.
RECYCLING
Recycling.
CREATE_FAILED
Creating failed.
IMAGING
Image creating.
InstanceTrafficData
Instance bandwidth data.
Referenced by：DescribeInstanceTraffic
internetRX
Integer
Inbound bandwidth. Unit: bps.
internetTX
Integer
Outbound bandwidth. Unit: bps.
time
String
Data time.
Format: YYYY-MM-DDThh:mm:ssZ.
InstanceTypeQuotaItem
Quotas of instance models.
Referenced by：DescribeZoneInstanceConfigInfos
zoneId
String
Zone ID.
instanceType
String
Instance model.
instanceTypeName
String
Instance model name.
cpuCount
Integer
Quantity of CPU cores.
Unit: cores.
memory
Integer
Memory size.
Unit: GiB.
internetMaxBandwidthOutLimit
Integer
Outbound bandwidth cap.
Value -1 means speed limit is not supported.
Unit: Mbps.
frequency
String
CPU frequency.
internetChargeTypes
Array of InternetChargeType
Network billing model. See
InternetChargeType for more details.
InternetChargeType
Network pricing model.
Referenced by：CreateInstances, DescribeInstances, DescribeZoneInstanceConfigInfos, InquiryPriceCreateInstance
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-based bandwidth cluster
BandwidthCluster
Billed by the burstable 95th bandwidth of all compute resources in a city-based or regional bandwidth cluster with a shared commitment.
MarketingInfo
Information on marketing campaigns.
Referenced by：CreateDisks, CreateInstances
discountCode
String
No
Promo Code.
If no Promo Code exists, the final discount will not apply.
usePocVoucher
Boolean
No
Whether to use POC voucher.
If no POC voucher exists, the related creation will fail.
NetworkLineType
Network line information.
Referenced by：DescribeZones
BGP
Premium BGP for optimized network performance.
CN2
China Telecom Next Carrier Network.
Cogent
Standard BGP for general use with cost optimization.
NetworkMode
Describe the values of the network card mode.
Referenced by：CreateInstances
Virtio
Virtio-net mode.
Vf
VFIO mode.
Nic
NIC configuration, including public and private NIC names settings.
Referenced by：CreateInstances, DescribeInstances
wanName
String
No
Public NIC name.
Only numbers and lowercase letters are allowed, starting with a letter with a length limit of 4 to 15 characters.
The default public NIC name is eth0.
lanName
String
No
Private NIC name.
Only numbers and lowercase letters are allowed, starting with a letter with a length limit of 4 to 15 characters.
The default private NIC name is eth1.
PriceCategory
Information on the pricing category.
Referenced by：InquiryPriceCreateInstance
STANDARD
Standard price.
CUSTOMIZED
Fixed price.
PriceItem
Information on the price.
Referenced by：InquiryPriceInstanceTrafficPackage, InquiryPriceInstanceBandwidth, InquiryPriceCreateDisks, InquiryPriceCreateInstance
discount
Float
No
Discount.
For example, 80.0 means 20% off.
discountPrice
Float
No
Discount price of postpaid resources.
Only used in pay-as-you-go model. For tiered billing, the value is empty.
originalPrice
Float
No
Original price of prepaid resources.
Only used in subscription model. For pay-as-you-go model, the value is empty.
unitPrice
Float
No
Original unit price of postpaid resources.
Only used in pay-as-you-go model. For tiered billing, the value is empty.
discountUnitPrice
Float
No
Discount unit price of postpaid resources.
Only used in pay-as-you-go model. For tiered billing, the value is empty.
chargeUnit
String
No
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
No
Tiered price of postpaid billing.
Only used in pay-as-you-go model. If it is not tiered price, the value is empty.
amountUnit
String
No
Unit of overage usage.
If the value is empty, it means there is no unit.
excessUnitPrice
Float
No
Original unit price of overages.
excessDiscountUnitPrice
Float
No
Discount unit price of overages.
excessAmountUnit
String
No
Unit of overage usage.
If the value is empty, it means there is no unit.
RuleInfo
Information on security group rules, including inbound/outbound rules, port range, IP protocol, etc.
Referenced by：CreateSecurityGroup, RevokeSecurityGroupRules, AuthorizeSecurityGroupRules, DescribeSecurityGroups, ConfigureSecurityGroupRules
direction
String
Yes
Traffic directions.
ingress: inbound rules.
egress: outbound rules.
ipProtocol
String
Yes
Transport protocol. The value is case sensitive.
Available value:tcp: TCP protocol.udp: UDP protocol.icmp: ICMP protocol.all: all protocols supported.
portRange
String
Yes
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
String
Yes
Source IP address range.
Default value: 0.0.XX.XX/0.
policy
String
No
Access strategy.
Available values:
accept: allows access by default.
Only accept strategy is supported for now.
Default value: accept
priority
Integer
No
Rule priority.
Default value: 1
description
String
No
Rule description.
SecurityGroupInfo
Information on security group, including security group creation.
Referenced by：DescribeSecurityGroups
securityGroupId
String
Security group ID.
securityGroupName
String
Security group name.
createTime
String
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.
StepPrice
Tiered price of postpaid billing. Describe a tier of the price.
Referenced by：InquiryPriceCreateInstance
stepStart
Float
No
First price range of a tiered price.
stepEnd
Float
No
Last price range of a tiered price.
unitPrice
Float
No
Original unit price of current price range.
Only used in pay-as-you-go model.
discountUnitPrice
Float
No
Discount unit price of current price range.
Only used in pay-as-you-go model.
SubnetInfo
Information on subnet of private network, including subnet name, CIDR block, instance ID, etc.
Referenced by：DescribeSubnets
subnetId
String
Subnet ID.
zoneId
String
Zone ID of subnet.
subnetName
String
Subnet name.
subnetStatus
String
Subnet status.See SubnetStatus for more details.
cidrBlockList
Array of String
ID list of subnet CIDR block.
usageIpCount
Integer
Quantity of used IP addresses in subnet.
totalIpCount
Integer
Quantity of total IP addresses in subnet.
createTime
String
Creation time.
instanceIdList
Array of String
ID list of instances under a subnet.
subnetDescription
String
Subnet description.
cidrBlock
String
Subnet CIDR block.
isDefault
Boolean
Whether the subnet is default or not.
SystemDisk
Information on system disk that stores operating system.
Referenced by：CreateInstances, DescribeInstances, InquiryPriceCreateInstance
diskSize
Integer
Yes
Size of system disk.Unit: GiB.
Value range: [1, +)
diskId
String
No
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.
diskCategory
String
No
Disk type.STANDARD: Standard DiskSSD: Solid State DriveThe default value is Standard Disk.
Default value: SSD
Tag
Information on a tag, including its key and value.
Referenced by：CreateInstances, DescribeInstances, DescribeDisks
key
String
Yes
Tag key.
Length limit: 1 to 64 characters.
value
String
No
Tag value.
Length limit: 1 to 64 characters.
TagAssociation
Information on tags bound to resources, including their keys and values.
Referenced by：CreateDisks, CreateInstances
Tags
Information on tags bound to resources, including their keys and values.
Referenced by：DescribeInstances, DescribeDisks
VmInventoryCapacityInfo
Availability zone inventory information
Referenced by：DescribeVmInventoryCapacity
zoneId
String
Availability Zone ID
capacity
Gearshift.
Inventory capacity is defined based on the total number of available units for all models.
ZoneInfo
Zone information, including city, etc.
Referenced by：DescribeZones
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
supportIpv6
Boolean
Whether support public IPv6 or not
supportCpuPassThrough
Boolean
Whether CPU passthrough is enabled.
Last updated