Data Types
AttackEventInfo
Informations on a DDoS attack event.
Referenced by：DescribeDDosAllEventList
eventId
String
DDoS attack event ID.
ipAddress
String
Attack target IP.
protecting
Boolean
Whether the IP is being protected.
startTime
String
Attack start time.
endTime
String
Attack end time.
endBlackholeTime
String
Time to unblock from blackhole.
attackBandwidthMax
Float
Peak attack bandwidth. Unit: bps.
attackPackageMax
Float
Peak attack packet rate. Unit: pps.
regionId
String
Region ID of attack event.
AutoSnapshotPolicy
Information on snapshot schedules.
Referenced by：DescribeAutoSnapshotPolicies
autoSnapshotPolicyId
String
Snapshot schedule ID.
zoneId
String
Availability zone ID.
autoSnapshotPolicyName
String
Snapshot schedule name.
repeatWeekDays
Array of Integer
The backup date of the schedule.
Unit: day, cycle: week (e.g., 1 = Monday)
Available range: [1, 7].
Value range: [1, 7]
hours
Array of Integer
Specify the start time of the snapshot schedule.
UTC time is used. Unit: hour.
24 time points are available from 00:00 to 23:00, 1 = 01:00, and so on.
Available range: [0, 23].
Value range: [0, 23]
diskNum
Integer
Source disk quantity.
createTime
String
Creation time.
diskIdSet
Array of String
Source disk information.
retentionDays
Integer
Retention time of automatic snapshots. Unit: day.
If the value is set to -1, it means that it is retained indefinitely.
The default is indefinite.
Value range: -1 or [1,65535].
BandwidthClusterInfo
Details of the bandwidth cluster.
Referenced by：DescribeNetworkInterfacePublicIPv6, DescribeEips
bandwidthClusterId
String
Bandwidth Cluster ID.
bandwidthClusterName
String
Bandwidth Cluster name.
BindType
Information on elastic IP mode.
Referenced by：ChangeEipBindType, CreateEips, CreateZecInstances, DescribeEips, AssociateEipAddress
FullNat
NAT mode.
Passthrough
Bypass mode.
BlockInfo
Information on elastic IP block threshold.
Referenced by：DescribeEips
ip
String
The elastic IP address being blocked.
bps
Integer
Blocking threshold in bandwidth, unit: bps (bits per second).
pps
Integer
Blocking threshold in packet rate, unit: pps (packets per second).
inCps
Integer
Blocking threshold for inbound connections, unit: count .
outCps
Integer
Blocking threshold for outbound connections, unit: count .
enable
Boolean
Whether to enable the specific threshold.
ByoipCreateItem
Information on BYOIP creation.
Referenced by：CreateByoip
cidrBlock
String
Yes
Advertise an IPv4 or IPv6 BYOIP prefix.
regionId
String
Yes
Region ID.
asn
Integer
Yes
ASN number.
subnetMaskLength
Integer
No
Subnet mask length.
Must be greater than or equal to the CIDR mask length, with a maximum difference of 4.
The maximum value is 64. Defaults to the CIDR mask length.
Value range: [-, 64]
ByoipPriceItem
Information on BYOIP price querying.
Referenced by：DescribeByoipPrice
cidrBlock
String
Yes
Advertised IP range.
regionId
String
Yes
Region ID.
CidrCreateSource
Information on CIDR block ownership.
Referenced by：DescribeIpv6Cidrs, DescribeCidrs
CONSOLE
CIDR block created on Console.
BYOIP
Bring your own IP (BYOIP).
CidrInfo
Information on CIDR block.
Referenced by：DescribeCidrs
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.
eipV4Type [Deprecated]
Network type of elastic IP.
Deprecated. Please use networkLineType instead.
netmask
Integer
CIDR block size.
poolId
String
IP pool ID.
createTime
String
Creation time.
expiredTime
String
Expiration time.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
CidrStatus
Status of CIDR block.
Referenced by：DescribeIpv6Cidrs, DescribeCidrs
CREATING
Creating.
AVAILABLE
Available to be used.
RECYCLING [Deprecated]
Recycling.
RECYCLED
Recycled.
DELETING
Deleting.
FAILED
Created failed.
CrossRegionBandwidthApiMonitorMeta
Values of cross-region bandwidth performance metrics.
Referenced by：DescribeCrossRegionBandwidthMonitorData
BANDWIDTH
Bandwidth.
Unit: bps .
PACKETS
Data transfer.
Unit: pps .
CrossRegionBandwidthInfo
Information on cross-region bandwidth.
Referenced by：DescribeCrossRegionBandwidth
crossRegionBandwidthId
String
Cross-region bandwidth ID.
crossRegionBandwidthName
String
Cross-region bandwidth name.
vpcId
String
Global VPC ID where the cross-region bandwidth belong.
regionA
String
One end of the cross-region bandwidth.
regionZ
String
The other end of the cross-region bandwidth.
bandwidth
Integer
Bandwidth cap.
bandwidthCap
Integer
Burst bandwidth.
The value may be empty.
createTime
String
Creation time.
expiredTime
String
Expiration time.
The value may be empty.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
CrossRegionBandwidthMetricValue
Metrics of cross-region bandwidth performance.
Referenced by：DescribeCrossRegionBandwidthMonitorData
time
String
Data time.
inValue
Float
Inbound value.
outValue
Float
Outbound value.
DataDisk
Information on disk.
Referenced by：CreateZecInstances, DescribeInstances, InquiryPriceCreateInstance
diskSize
Integer
Yes
Disk size.
Unit: GiB.
Value range: [1, +)
diskId
String
No
Disk ID.
This parameter is currently only used as a response parameter in query operations such as DescribeInstances, and cannot be used as an input parameter for write operations such as CreateInstances.
diskName
String
No
Disk name.
This parameter is currently only used as a response parameter for query operations such as DescribeInstances.
diskAmount
Integer
No
Number of disks.
This parameter is only used as an input parameter for APIs such as CreateInstances and InquiryPriceCreateInstance.
Value range: [1, +)
Default value: 1
portable
Boolean
No
Whether the disk is detachable.
This parameter is used as a response parameter in query operations, not as an input parameter.
true means the disk will not be deleted when the instance is deleted.
false means the disk will be deleted when the instance is deleted.
burstingEnabled
Boolean
No
Whether to enable disk bursting.
Default value: false
diskCategory
String
No
Disk type.
Basic NVMe SSD: the Basic NVMe SSD.
Standard NVMe SSD: the Standard NVMe SSD.
Default value: Standard NVMe SSD.
Default value: Standard NVMe SSD
DdosAction
Protection actions based on packet fingerprint rules.
Referenced by：CreatePolicy
Drop
Drop traffic based on packet fingerprint rules.
DdosAttackStatus
States of DDoS attack events.
Referenced by：DescribeDDosAllEventList, DescribeDDosEventDetail
ATTACKING
The attack target is under attack.
ATTACKED
The attack event is resolved.
BLOCKING
The attack event is mitigating.
DdosFingerprintRule
Informations on fingerprint filtering rules of DDoS protection strategy.
Referenced by：CreatePolicy, DescribePolicyDetail, ModifyPolicy
srcPortStart
Integer
Yes
Start value of the source port range for the fingerprint.
Valid range: [0, 65535].
Value range: [0, 65535]
srcPortEnd
Integer
Yes
End value of the source port range for the fingerprint.
Valid range: [0, 65535].
Value range: [0, 65535]
dstPortStart
Integer
Yes
Start value of the destination port range for the fingerprint.
Valid range: [0, 65535].
Value range: [0, 65535]
dstPortEnd
Integer
Yes
End value of the destination port range for the fingerprint.
Valid range: [0, 65535].
Value range: [0, 65535]
minPktLength
Integer
Yes
Minimum packet length to be filtered.
Valid range: [1, 1500].
Value range: [1, 1500]
maxPktLength
Integer
Yes
Maximum packet length to be filtered.
Valid range: [1, 1500].
Value range: [1, 1500]
matchBytes
String
Yes
Payload pattern to match.
Hex string in lowercase, padded to 2 digits, without 0x prefix.
offset
Integer
No
Byte offset of the payload signature.
Offset within TCP/UDP payload: [0–1500].
Valid range: [0, 1500].
Value range: [0, 1500]
DdosPolicyPort
Informations on port blocking of DDoS protection strategy.
Referenced by：CreatePolicy, DescribePolicyDetail, ModifyPolicy
srcPortStart
Integer
Yes
Start value of the source port range for port blocking.
Valid range: [0, 65535].
Value range: [0, 65535]
srcPortEnd
Integer
Yes
End value of the source port range for port blocking.
Valid range: [0, 65535].
Value range: [0, 65535]
dstPortStart
Integer
Yes
Start value of the destination port range for port blocking.
Valid range: [0, 65535].
Value range: [0, 65535]
dstPortEnd
Integer
Yes
End value of the destination port range for port blocking.
Valid range: [0, 65535].
Value range: [0, 65535]
DdosProtectedType
Informations on DDoS protection type.
Referenced by：DescribeDDosEventDetail
DDOS
DDoS protection.
DdosReflectUdpPort
Informations on reflection attack filtering of DDoS protection strategy.
Referenced by：CreatePolicy, DescribePolicyDetail, ModifyPolicy
port
Integer
Yes
Custom UDP reflection source port.
Valid range: [0, 65535].
Value range: [0, 65535]
DdosTrafficControl
Informations on source IP rate limiting of DDoS protection strategy.
Referenced by：CreatePolicy, DescribePolicyDetail, ModifyPolicy
bpsEnabled
Boolean
No
Enable bandwidth rate limit or not.
bps
Integer
No
Limited bandwidth value.
Valid range: [8192, 2147483648].
Value range: [8192, 2147483648]
ppsEnabled
Boolean
No
Enable packet rate limit or not.
pps
Integer
No
Limited packet rate value.
Valid range: [32, 50000].
Value range: [32, 50000]
synBPSEnabled
Boolean
No
Enable SYN bandwidth limit or not.
synBPS
Integer
No
Limited SYN traffic value.
Valid range: [8192, 2147483648].
Value range: [8192, 2147483648]
synPPSEnabled
Boolean
No
Enable SYN packet rate limit or not.
synPPS
Integer
No
Limited SYN packet rate value.
Valid range: [1, 100000].
Value range: [1, 100000]
DescribeDiskCategoryItem
Information on disk types supported in an availability zone.
Referenced by：DescribeDiskCategory
zoneId
String
Availability zone ID.
categorySet
Array of String
The supported disk types.
DhcpOptionsSet
Information on the DHCP options set.
Referenced by：DescribeDhcpOptionsSets
dhcpOptionsSetId
String
DHCP options set ID.
dhcpOptionsSetName
String
DHCP options set name. The length must be between 1 and 64 characters.
Value range: [1.0, +).
Value range: [1.0, +)
domainNameServers
String
DNS server IP.
Up to 4 DNS server IPv4s can be passed in, separated by a comma (,).
ipv6DomainNameServers
String
DNS server IP.
Up to 4 DNS server IPv6s can be passed in, separated by a comma (,).
leaseTime
String
Lease duration for the IPv4 DHCP options set.
Unit: h.
ipv6LeaseTime
String
Lease duration for the IPv6 DHCP options set.
Unit: h.
createTime
String
Creation time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-ddTHH:mm:ssZ .
description
String
Description information of the DHCP options set.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
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.
regionId
String
Region ID.
zoneId
String
Zone ID to which the disks belong.
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.
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.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
serial
String
The index of the disk.
This value may be null if unavailable.
snapshotAbility
Boolean
Available for snapshot creation or not.
autoSnapshotPolicyId
String
ID of snapshot schedule attached to the disk.
burstingEnabled
Boolean
Whether to enable disk bursting.
DiskMetricData
Information on disk performance metrics.
Referenced by：DescribeDiskMonitorData
DISK_WRITE_BYTES
Disk write throughput.
Unit: KiB/s .
DISK_READ_BYTES
Disk read throughput.
Unit: KiB/s .
DISK_READ_OPS
Disk read operations.
Unit: IOPS .
DISK_WRITE_OPS
Disk write operations.
Unit: IOPS .
DISK_UTIL
Disk utilization.
Unit: % .
DiskStatus
Information on disk states.
Referenced by：DescribeDisks
CREATING
Disk is in creation.
IN_USE
Disk is active.
AVAILABLE
Disk is inactive.
CHANGING
Disk size is changing.
ATTACHING
Disk is attaching to an instance.
DETACHING
Disk is detaching from an instance.
DELETING
Disk is in deletion.
RECYCLED
Disk is recycled.
RECYCLING
Disk is being recycled.
FAILED
Creating a disk failed.
SNAPSHOT_CREATING
Snapshot is in creation.
ROLLING_BACK
Reverting to snapshot.
DiskType
Information on storage type.
Referenced by：DescribeSnapshots, DescribeDisks
SYSTEM
Boot disk.
DATA
Disk.
DiskWithInstance
Information on data disks created along with the instance.
Referenced by：CreateZecInstances
instanceId
String
Instance ID.
diskIdSet
Array of String
Data disk ID created along with the instance.
DnatEntry
Information on the DNAT rules.
Referenced by：DescribeNatGatewayDetail
dnatEntryId
String
DNAT entry ID.
status
String
DNAT rule status.
privateIp
String
The private IP address configured in the DNAT rule.
eipId
String
The elastic IP ID configured in the DNAT rule.
listenerPort
String
The public port or port range forwarded by the DNAT rule.
Valid values: 1–65535.
internalPort
String
The private port or port range forwarded by the DNAT rule.
Valid values: 1–65535.
DnatEntryProtocol
DNAT rule protocol.
Referenced by：CreateDnatEntry, DescribeNatGatewayDetail, ModifyDnatEntry
TCP
TCP protocol.
UDP
UDP protocol.
Any
Any protocol.
EipBindResourceType
Information on resource type bound to elastic IP.
Referenced by：DescribeEips
NIC
vNIC.
NAT
NAT gateway.
LB
Load balancer.
EipGeoInfo
IP geolocation information retrieved from third-party IP database providers such as DB-IP, ipdata, etc.
Referenced by：DescribeEips
dbIp
String
Geolocation information queried from DB-IP (db-ip.com).
ipData
String
Geolocation information queried from ipdata (ipdata.co).
ipInfo
String
Geolocation information queried from IPinfo (ipinfo.io).
maxMind
String
Geolocation information queried from MaxMind.
standard
String
Geolocation information of the elastic IP.
isConsistent
Boolean
Whether the queried geolocation matches the actual location.
EipInfo
Information on elastic IPs.
Referenced by：DescribeEips
eipId
String
ID of elastic IP.
name
String
Name of elastic IP.
regionId
String
Region ID.
peerRegionId
String
Remote region ID.
This field is valid only when the IP is a Remote IP.
isDefault
Boolean
Default IP or not.
publicIpAddresses
Array of String
Public IP address.
privateIpAddress
String
Private IP bound to the elastic IP.
eipV4Type [Deprecated]
Network type of elastic IP.
Deprecated. Please use networkLineType instead.
cidrId
String
CIDR block ID from which the elastic IP originates.
nicId [Deprecated]
String
vNIC ID associated with the elastic IP.
This field is deprecated; please use the associatedId field instead.
associatedId
String
Resource ID bound to the elastic IP.
It may be an instance ID, vNIC ID, or NAT gateway ID.
associatedType
Resource type bound to the elastic IP.
It may be an instance, vNIC, or NAT gateway.
instanceId
String
ID of the instance to which elastic IP is bound.
This field may have a value only when the associatedType is NIC .
flowPackage
Float
Data transfer package.
bandwidth
Integer
Bandwidth
createTime
String
Creation time.
expiredTime
String
Expiration time.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
EipIsp
Information on the IP ISP (Internet Service Provider).
Referenced by：CreateEips
CHINA_MOBILE
China Mobile.
CHINA_UNICOM
China Unicom.
CHINA_TELECOM
China Telecom.
EipMetricValue
Metric value of elastic IP performance data.
Referenced by：DescribeEipMonitorData
time
String
Time.
inValue
Float
Inbound value.
outValue
Float
Outbound value.
loseIn
Float
Inbound loss value.
loseOut
Float
Outbound loss value.
EipMonitorMeta
Performance metrics of elastic IP.
Referenced by：DescribeEipMonitorData
BANDWIDTH
Bandwidth.
Unit: bps .
PACKETS
Packet transmission.
Unit: pps .
EipNetworkType
Network type of elastic IP. See NetworkLineType for more details.
Referenced by：CreateEips, CreateZecInstances, DescribeEipPrice, CreateCidr, DescribeEipRemoteRegions, InquiryPriceCreateInstance, DescribeEips, DescribeCidrs, DescribeEipInternetChargeTypes, DescribeCidrPrice
BGPLine
BGP network type.
CN2Line
CN2 GIA (CN2 Global Internet Access) network type.
LocalLine
Local IP network type.
ChinaMobile
China Mobile network type.
ChinaUnicom
China Unicom network type.
ChinaTelecom
China Telecom network type.
Cogent
Cogent Communications network type.
ThreeLine
3-in-1 IP pool network type.
EipStatus
Status of elastic IPs.
Referenced by：DescribeEips
CREATING
Creating.
DELETING
Deleting.
ASSIGNING
Binding.
BINDED
Bound.
RECYCLING [Deprecated]
Recycling.
RECYCLED
Recycled.
UNBIND
Unbound.
CREATE_FAILED
Creating failed.
EipTrafficData
Information on traffic of elastic IP.
Referenced by：DescribeEipTraffic
internetRX
Integer
Inbound bandwidth. Unit: bps.
internetTX
Integer
Outbound bandwidth. Unit: bps.
time
String
Time. Format: YYYY-MM-ddTHH:mm:ssZ .
IPv6Type
Whether the IPv6 address is public or private.
Referenced by：CreateSubnet, ModifySubnetStackType
Private
Private network.
Public
Public network.
Image
Information on images.
Referenced by：DescribeImages
imageId
String
Image ID.
imageName
String
Image name.
imageSize
String
Image size.
imageDescription
String
Image note.
imageVersion
String
Image version.
category
String
Image category.
ImageOsType
Values of image operating systems.
Referenced by：DescribeImages
linux
Linux operating system.
bsd
BSD operating system.
windows
Windows operating system.
android
Android operating system.
any
Any other operating systems.
ImageSource
Values of image sources.
Referenced by：DescribeImages
OFFICIAL
System image.
MARKETING
Marketplace image.
CUSTOM
Custom image.
ImageStatus
Values of image states.
Referenced by：DescribeImages
CREATING
Image is being created.
AVAILABLE
Image creation succeeded.
UNAVAILABLE
Image is unavailable.
SYNCING
Image is being replicated.
FAILED
Image creation failed.
DELETING
Image is being deleted.
PROCESSING
Image is being operated.
ImageType
Values of image types.
Referenced by：DescribeImages
PUBLIC_IMAGE
System image.
CUSTOM_IMAGE
Custom image.
InstanceApiMonitorMeta
Performance metrics of instances.
Referenced by：DescribeInstanceMonitorData
CPU_UTILIZATION
CPU utilization.
Unit: % .
HYPERVISOR_IO_WAIT_TIME
Hypervisor I/O wait time.
Unit: % .
HYPERVISOR_QUEUE_TIME
Hypervisor CPU queue time.
Unit: % .
HYPERVISOR_CPU_USER
Hypervisor CPU user.
Unit: % .
HYPERVISOR_CPU_TIME
Hypervisor CPU time.
Unit: % .
HYPERVISOR_CPU_SYSTEM
Hypervisor CPU system.
Unit: % .
PROC_CPU_USER
CPU user.
Unit: % .
PROC_CPU_SYSTEM
CPU system.
Unit: % .
PROC_CPU_IOWAIT
CPU IOWait.
Unit: % .
PROC_CPU_SOFTIRQ
CPU SoftIRQ.
Unit: % .
PROC_CPU_IDLE
CPU idle.
Unit: % .
PROC_CPU_OTHER
CPU other.
Unit: % .
LOAD1
System Load Average - Last 1 Minute.
LOAD5
System Load Average - Last 5 Minutes.
LOAD15
System Load Average - Last 15 Minutes.
MEM_UTIL
Memory utilization
Unit: % .
REALMEM_UTIL
Memory real utilization
Unit: % .
TCP_ESTABLISHED
Established TCP connections.
Unit: count .
SWAP_TOTAL
The total configured swap space on the instance, which is used to assess the max swappable capacity.
Unit: KiB .
SWAP_FREE
The currently available swap space, which is used to evaluate how much swap is still free.
Unit: KiB .
SWAP_IN
Pages read from swap into memory, which indicates system memory pressure.
Unit: pages .
SWAP_OUT
Pages written from memory to swap, which reflects inactive data being moved to disk.
Unit: pages .
KSWAPD_STEAL
Pages successfully reclaimed by kswapd from memory, which indicates memory pressure.
Unit: pages .
KSWAPD_LHWM
Number of times memory reclaim was triggered due to low watermarks.
Unit: count .
RX_PACKETS
Packets received per second on the vNIC’s VF interface
Unit: packets .
TX_PACKETS
Packets transmitted per second on the vNIC’s VF interface
Unit: packets .
RX_DROPPED
Total inbound packet loss per second for the vNIC’s VF and Virtio interfaces.
Unit: packets .
TX_DROPPED
Total outbound packet loss per second for the vNIC’s VF and Virtio interfaces.
Unit: packets .
RX_ERRORS
Total inbound error packets per second for the vNIC’s VF and Virtio interfaces.
Unit: packets .
TX_ERRORS
Total outbound error packets per second for the vNIC’s VF and Virtio interfaces.
Unit: packets .
InstanceInfo
Information on instances.
Referenced by：DescribeInstances
instanceId
String
Instance ID.
instanceName
String
Instance name to be displayed.
zoneId
String
Availability zone ID to which the instances belong.
instanceType
String
Type of instance. eg. z2a.cpu.1
cpu
Integer
Quantity of CPU cores.
Unit: cores.
memory
Integer
Memory size.
Unit: GiB.
imageId
String
Image ID.
imageName
String
Image name.
timeZone
String
Time zone of the system.
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.
subnetId
String
Associated subnet ID of the primary vNIC.
securityGroupId
String
Associated security group ID of the primary vNIC.
enableAgent
Boolean
Whether to enable the QEMU Guest Agent (QGA).
enableAgentMonitor
Boolean
Whether to enable data collection of the QEMU Guest Agent (QGA).
enableIpForward
Boolean
Whether to enable IP forwarding.
createTime
String
Creation time.
Format: YYYY-MM-ddTHH:mm:ssZ .
expiredTime
String
Expiration time.
Format: YYYY-MM-ddTHH:mm:ssZ .
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
loadBalancerIds
Array of String
Attached load balancer IDs.
InstanceOptions
Information on options for the instance.
Referenced by：CreateZecInstances, DescribeInstances
nestedVirtualization
Boolean
No
Whether to the instance for nested virtualization.
To enable nested virtualization, you must contact Support to activate it; otherwise, the setting will be ineffective.
InstanceStatus
Status of instances. See InstanceStatusValue for more detailed information.
Referenced by：DescribeInstancesStatus
instanceId
String
Instance ID.
instanceStatus
Instance status. See InstanceStatusValue for more detailed information.
InstanceStatusValue
Status of instance.
Referenced by：DescribeInstancesStatus, DescribeInstances
DEPLOYING
Creating.
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.
RESIZING
Resizing.
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.
Unit: Mbps.
withStock
Boolean
Whether the instance model is in stock.
internetChargeTypes
Array of InternetChargeType
Network billing model. See
InternetChargeType for more details.
InternetChargeType
Network pricing model.
Referenced by：CreateNetworkInterface, CreateEips, DescribeZoneInstanceConfigInfos, InquiryPriceCreateInstance, DescribeEips, DescribeEipInternetChargeTypes, AssignNetworkInterfaceIpv6, CreateCrossRegionBandwidth, CreateZecInstances, DescribeEipPrice, DescribeNetworkInterfacePublicIPv6, InquiryPriceCreateCrossRegionBandwidth, DescribeCrossRegionBandwidth, ChangeEipInternetChargeType
ByBandwidth
Billed by the flat rate bandwidth.
ByTrafficPackage
Billed by the traffic package size purchased.
BandwidthCluster
Billed by the burstable 95th bandwidth of all compute resources in a city-based or regional bandwidth cluster with a shared commitment.
IpType
Information on IP types.
Referenced by：CreateRoute, DescribeByoipRegions, DescribeRoutes
IPv4
IPv4 address.
IPv6
IPv6 address.
Ipv6CidrInfo
Information on IPv6 CIDR block.
Referenced by：DescribeIpv6Cidrs
cidrId
String
IPv6 CIDR block ID.
regionId
String
The region ID to which the CIDR block belongs.
name
String
CIDR block name.
cidrBlock
String
CIDR block address, for example: 2400:8a00::/28.
source
The ownership of the CIDR block.
For example, CONSOLE (owned by Zenlayer) or BYOIP (customer-provided IP).
networkLineType
CIDR network type.
The public IP line type supported by this CIDR block.
subnetIds
Array of String
Set of subnet IDs.
nicIds
Array of String
Set of network interface IDs.
netmask
Integer
Subnet mask.
The length of the network prefix in CIDR notation.
poolId
String
The ID of the pool.
The public IP pool to which this CIDR block belongs.
createTime
String
The creation time of the CIDR block.
expiredTime
String
The expiration time of the CIDR block.
MarketingInfo
Information on marketing campaigns.
Referenced by：CreateCrossRegionBandwidth, CreateNetworkInterface, CreateEips, CreateZecInstances, CreateDisks, CreateCidr, InquiryPriceCreateCrossRegionBandwidth, CreateByoip
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.
MetricValue
Information on performance metric values.
Referenced by：DescribeInstanceMonitorData, DescribeDiskMonitorData
time
String
The time of a data point.
value
Float
The value of a data point.
If the value is null, it means the corresponding data could not be retrieved.
NatGateway
Information on the NAT gateway.
Referenced by：DescribeNatGateways
natGatewayId
String
The unique ID of the NAT gateway.
vpcId
String
VPC network ID to which the NAT gateway belongs.
regionId
String
Region ID.
name
String
The name of the NAT gateway.
subnetIds
Array of String
Subnet ID list to which the NAT gateway belongs.
eipIds
Array of String
Elastic IP ID list bound to the NAT gateway.
zbgId
String
Border gateway ID.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
isAllSubnets
Boolean
Whether all subnets within a region are associated with the NAT gateway.
icmpReplyEnabled
Boolean
Whether to enable ICMP echo reply or not.
securityGroupId
String
Associated security group ID of the NAT gateway.
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.
NatStatus
State of the NAT gateway.
Referenced by：DescribeNatGateways
CREATING
NAT gateway is being created.
RUNNING
NAT gateway is running.
RECYCLED
NAT gateway is in the recycle bin.
CREATE_FAILED
NAT gateway creation failed.
RELEASING
NAT gateway is being released.
NetmaskInfo
Information on CIDR block size.
Referenced by：CreateCidr, DescribeCidrPrice
netmask
Integer
Yes
CIDR block size.
Value range: [27, 32]
amount
Integer
Yes
CIDR block quantity.
Value range: [0, +)
NetworkLineType
Network type of public IP address.
Referenced by：DescribeByoipPrice, CreateEips, DescribeIpv6Cidrs, DescribeByoipRegions, DescribeEipRemoteRegions, CreateByoip, InquiryPriceCreateInstance, DescribeEips, DescribeCidrs, DescribeEipInternetChargeTypes, CreateZecInstances, DescribeEipPrice, CreateCidr, DescribeCidrPrice
PremiumBGP
Premium BGP network.
High-performance network.
CN2
China Telecom CN2 network.
LocalLine
Provided by a local ISP.
StandardBGP
Standard BGP network.
General-purpose network with cost optimization.
CMI
1-Line IP China Mobile.
CUG
1-Line IP China Unicom.
CTG
1-Line IP China Telecom.
ThreeLine
3-in-1 IP Pool.
NextHopType
Information on the next hop of a route.
Referenced by：DescribeRoutes
NIC
Network interface.
VPC
Global VPC.
NAT
NAT gateway.
ZBG
Border gateway.
NicInfo
Information of vNIC.
Referenced by：DescribeInstances, DescribeNetworkInterfaces
nicId
String
vNIC ID.
name
String
vNIC name.
regionId
String
Region ID.
publicIpList
Array of String
Public IP addresses.
privateIpList
Array of String
Private IP addresses.
primaryIpv4
String
Primary private IPv4 address.
primaryIpv6
String
Primary private IPv6 address.
If the IP stack type is IPv4, this value is null.
ipv6Cidr
String
IPv6 CIDR block.
If the IP stack type is IPv4, this value is null.
secondaryIpv4s
Array of String
Secondary private IPv4 addresses.
macAddress
String
MAC address.
instanceId
String
Instance ID.
vpcId
String
VPC ID.
subnetId
String
Subnet ID.
createTime
String
Creation time.
updateTime
String
Updating time.
securityGroupId
String
Associated security group ID of the vNIC.
NicNetworkType
Informations on network interface mode.
Referenced by：DescribeImages, CreateZecInstances, DescribeInstances, ChangeNicNetworkType
Auto
Default mode auto-adapted to image.
FailOver
Failover mode.
VirtioOnly
Virtio-net mode.
VfOnly
VFIO mode.
NicStatus
Status of vNIC.
Referenced by：DescribeInstances, DescribeNetworkInterfaces
PENDING
Creating.
AVAILABLE
Available. Not bound to any instance.
ATTACHING
Binding.
DETACHING
Unbinding.
DELETING
Deleting.
CREATE_FAILED
Creating failed.
USED
Bound.
NicType
Information on the vNIC types.
Referenced by：DescribeInstances, DescribeNetworkInterfaces
Primary
Primary network interface.
Secondary
Secondary network interface.
PolicyInfo
Informations on DDoS protection strategy.
Referenced by：DescribePolicys
policyId
String
Protection strategy ID.
policyName
String
Protection strategy name.
createTime
String
Creation time.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
PolicyRegion
Informations on regions for geo-blocking.
Referenced by：DescribePolicyRegions
regionId
String
Region ID.
regionName
String
Region name.
areaName
String
Area name.
PolicyUpdateType
Modified policy information of DDoS protection strategy.
Referenced by：ModifyPolicy
UdpReflect
Modify UDP reflection source ports.
TrafficControl
Modify source IP rate limiting.
Port
Modify port blocking rules.
BlockProtocol
Modify protocol blocking.
IpList
Modify IP allow/deny list.
BlockRegion
Modify regions in geo-blocking.
Fingerprint
Modify fingerprint filtering rules.
PoolInfo
Information on IP pools.
Referenced by：DescribePools
poolId
String
Pool ID.
regionId
String
Region ID.
name
String
Pool name.
createTime
String
Creation time.
ipv4CidrCount
Integer
The number of CIDR IPv4.
ipv6CidrCount
Integer
The number of CIDR IPv6.
PriceCategory
Information on the pricing category.
Referenced by：InquiryPriceCreateInstance
STANDARD
Standard price.
CUSTOMIZED
Fixed price.
PriceItem
Information on the price.
Referenced by：InquiryPriceModifyCrossRegionBandwidth, InquiryPriceCreateDisks, DescribeByoipPrice, InquiryPricePublicIpv6, DescribeEipPrice, InquiryPriceCreateCrossRegionBandwidth, InquiryPriceCreateNatGateway, InquiryPriceCreateInstance, DescribeCidrPrice
discount
Float
Discount.
For example, 80.0 means 20% off.
discountPrice
Float
Discount price of postpaid resources.
Only used in pay-as-you-go model. For tiered billing, the value is empty.
originalPrice
Float
Original price of prepaid resources.
Only used in subscription model. For pay-as-you-go model, the value is empty.
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.
amountUnit
String
Unit of usage,
such as Mbps , LCU , and etc.
If the value is empty, it means there is no unit.
excessUnitPrice
Float
Original unit price of overages.
excessDiscountUnitPrice
Float
Discount unit price of overages.
excessAmountUnit
String
Unit of overage usage.
If the value is empty, it means there is no unit.
PrivateIpInfo
Information on private IP address.
Referenced by：AvailableLanIp
lanIp
String
Private IP address.
nicId
String
vNIC ID.
nicName
String
vNIC name.
instanceId
String
Instance ID.
instanceName
String
Instance name.
Protocol
Informations on protocol blocking of DDoS protection strategy.
Referenced by：CreatePolicy, DescribePolicyDetail, ModifyPolicy
TCP
Block TCP traffic.
UDP
Block UDP traffic.
ICMP
Blocks all ICMP traffic.
ICMP protocol is not supported for port blocking.
PublicIpv6CidrAddress
Information on public IPv6 address.
Referenced by：DescribeNetworkInterfacePublicIPv6
ipv6CidrId
String
The ID of the IPv6 address.
ipv6Cidr
String
The IPv6 address.
primaryIpv6Address
String
The primary IPv6 address of the network interface.
bandwidth
Integer
Public bandwidth cap for IPv6 address.
Unit: Mbps.
trafficPackageSize
Float
The size of the IPv6 data transfer package.
Unit: TB.
ReflectUdpPortPolicy
Information on UDP reflection source port.
Referenced by：DescribeReflectUdpPortOptions
name
String
Reflection attack type.
port
Integer
Reflection source port.
Region
Information on regions that support BYOIP CIDR blocks.
Referenced by：DescribeByoipRegions
netmask
Integer
Supported subnet mask.
regionId
String
Supported regions.
RegionInfo
Information on regions.
Referenced by：DescribeSubnetRegions
regionId
String
Region ID.
regionName
String
Region name.
regionTitle
String
Region title.
enablePubIpv6
Boolean
Whether support public IPv6 or not.
ReplaceIp
Information of the original and target elastic IPs.
Referenced by：ReplaceEipAddress
eipId
String
No
Elastic IP ID.
ownIp
String
No
Source IP.
targetIp
String
No
Target IP.
ResourceGroupInfo
Information on resource group, including resource group name and resource group ID.
Referenced by：DescribeAutoSnapshotPolicies, DescribeVpcs, DescribeIpv6Cidrs, DescribeInstances, DescribeSnapshots
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
RouteInfo
Information on routes.
Referenced by：DescribeRoutes
vpcId
String
Global VPC ID.
vpcName
String
Global VPC name.
destinationCidrBlock
String
Destination CIDR block for IPv4 or IPv6.
For example: 10.0.1.0/24 .
cidrBlock
String
CIDR block destination address.
This field is deprecated. Please use destinationCidrBlock instead.
nextHopId
String
Next hop ID.
nextHopName
String
Next hop name.
routeId
String
Route ID.
name
String
Route name.
sourceCidrBlock
String
Source CIDR block.
This field is applicable only when the route type is RouteTypePolicy (policy-based route).
priority
Integer
Route priority.
createTime
String
Route creation time.
RouteType
Information on route types.
Referenced by：CreateRoute, DescribeRoutes
RouteTypeSubnet
Subnet route.
Subnet route is auto-generated when a subnet is created.
RouteTypeStatic
Static route.
Static route is a kind of custom route.
RouteTypePolicy
Policy-based route.
Policy-based route is a kind of custom route.
RouteTypeNatGw
NAT gateway route.
RouteTypeTransit
Dynamic route.
RoutingMode
Information on dynamic routing modes.
Referenced by：ModifyBorderGatewaysAttribute, DescribeBorderGateways, CreateBorderGateway
Regional
Regional routing. Learn routes only within the region it was created in.
Global
Global routing. Dynamically learn and distribute routes across all regions using a single VPN or Interconnect.
SecurityGroupInfo
Information on security group, including security group creation.
Referenced by：DescribeSecurityGroups
securityGroupId
String
Security group ID.
securityGroupName
String
Security group name.
scope
String
Security group deployed scope.
Currently only support Global .
createTime
String
Creation time.
Format: YYYY-MM-ddTHH:mm:ssZ .
vpcIds
Array of String
Associated global VPC ID list.
isDefault
Boolean
Whether the security group is default or not.
nicIdList
Array of String
ID list of associated vNICs.
natIdList
Array of String
ID list of associated NAT gateways.
loadBalancerIdList
Array of String
ID list of associated load balancers.
SecurityGroupRuleInfo
Information on security group rules, including inbound/outbound rules, port range, IP protocol, etc.
Referenced by：CreateSecurityGroup, DescribeSecurityGroupRule, ConfigureSecurityGroupRules
direction
String
Yes
Traffic directions.
ingress : inbound rules.
egress : outbound rules.
policy
String
Yes
Access strategy.
Available values:
accept : allows access by default.
Only accept strategy is supported for now.
priority
Integer
Yes
Priority of rules.
Available values:
[1,100].
Default value: 1.
Value range: [1, 999]
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 .
desc
String
No
Description. 255 characters in length.
SnapshotInfo
Information on snapshots.
Referenced by：DescribeSnapshots
snapshotId
String
Snapshot ID.
snapshotName
String
Snapshot name.
zoneId
String
Availability zone ID of the snapshot.
retentionTime
String
Snapshot retention time.
If no value can be retrieved, it indicates that the snapshot is retained permanently.
diskId
String
Disk ID.
createTime
String
Creation time.
diskAbility
Boolean
Whether the disk can be created by the snapshot.
SnapshotStatusValue
Information on snapshot states.
Referenced by：DescribeSnapshots
CREATING
Creating.
AVAILABLE
Creating succeeded.
FAILED
Creating failed.
ROLLING_BACK
Reverting to the snapshot.
DELETING
Deleting.
SnapshotType
Information on snapshot types.
Referenced by：DescribeSnapshots
Auto
Automatic snapshot.
Manual
Manual snapshot.
SnatEntry
Information on the SNAT rules.
Referenced by：DescribeNatGatewayDetail
snatEntryId
String
SNAT entry ID.
eipIds
Array of String
The elastic IP ID list configured in the SNAT rule.
cidrs
Array of String
CIDR block. The default value is 0.0.0.0/0 if not passed in.
cidrs and snatSubnets cannot exist simultaneously.
isAllEip
Boolean
Whether the public egress IPs are all elastic IPs bound to this NAT gateway
SnatSubnet
Information on subnets configured in the SNAT rule.
Referenced by：DescribeNatGatewayDetail
subnetId
String
Subnet ID.
cidr
String
CIDR block of the subnet.
StepPrice
Information on tiered pricing.
Referenced by：InquiryPriceCreateInstance
stepStart
Float
First price range of a tiered price.
stepEnd
Float
Last price range of a tiered price.
If the value is empty, it means the last tier.
unitPrice
Float
Original unit price of current price range.
discountUnitPrice
Float
Discount unit price of current price range.
SubnetInfo
Information on subnets
Referenced by：DescribeSubnets
subnetId
String
Subnet ID.
regionId
String
Region ID.
name
String
Subnet name.
cidrBlock
String
CIDR block of subnet.
gatewayIpAddress
String
Gateway ip address.
ipv6CidrBlock
String
IPv6 CIDR block of subnet.
ipv6GatewayIpAddress
String
IPv6 gateway ip address.
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
String
Creation time of subnet.
isDefault
Boolean
Whether is default subnet or not.
dhcpOptionsSetId
String
DHCP options set ID.
SubnetStackType
Information on the IP stack types of the vNIC.
Referenced by：CreateNetworkInterface, CreateZecInstances, CreateSubnet, DescribeInstances, ModifySubnetStackType
IPv4
IPv4 stack type only.
IPv4_IPv6
IPv4 and IPv6 stack type.
IPv6
IPv6 stack type only.
SystemDisk
Information on boot disks.
Referenced by：CreateZecInstances, DescribeInstances, InquiryPriceCreateInstance
diskSize
Integer
Yes
Boot disk size.
Unit: GiB.
Value range: [1, +)
diskId
String
No
Boot disk ID.
This parameter is currently only used as a response parameter in query operations such as DescribeInstances, and cannot be used as an input parameter in write operations like CreateInstances.
diskCategory
String
No
Disk type.
Basic NVMe SSD: Economical NVMe SSD.
Standard NVMe SSD: Standard NVMe SSD.
Default is Standard NVMe SSD.
Default value: Standard NVMe SSD
burstingEnabled
Boolean
No
Whether to enable disk bursting.
Default value: false
Tag
Information on a tag, including its key and value.
Referenced by：DescribePolicys, DescribeAutoSnapshotPolicies, DescribeImages, DescribeNatGateways, DescribeIpv6Cidrs, DescribeNetworkInterfaces, DescribeDisks, DescribeEips, DescribeCidrs, DescribeDhcpOptionsSets, DescribeVpcs, CreateZecInstances, DescribeInstances
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：CreateNetworkInterface, CreateDhcpOptionsSet, CreatePolicy, CreateEips, CreateDisks, CreateByoip, CreateVpc, CreateAutoSnapshotPolicy, CreateNatGateway, CreateZecInstances, CreateCidr, ModifyPolicy, CreateImage
Tags
Information on tags, including their keys and values.
Referenced by：DescribePolicys, DescribeDhcpOptionsSets, DescribeAutoSnapshotPolicies, DescribeVpcs, DescribeImages, DescribeNatGateways, DescribeIpv6Cidrs, DescribeInstances, DescribeDisks, DescribeEips, DescribeCidrs
TopPort
Informations on attack ports.
Referenced by：DescribeDDosEventDetail
protocol
String
Port protocol.
port
Integer
Port number.
VpcInfo
Information on global VPCs.
Referenced by：DescribeVpcs
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
String
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.
dnsZoneIds
Array of String
The DNS Zone ID associated with the VPC.
VpcRegionBandwidthStatus
Values of cross-region bandwidth states.
Referenced by：DescribeCrossRegionBandwidth
CREATING
The cross-region bandwidth is being created.
AVAILABLE
The cross-region bandwidth is available.
CHANGING
The cross-region bandwidth is being changed.
RECYCLING
The cross-region bandwidth is being recycled.
RECYCLED
The cross-region bandwidth is recycled.
DELETING
The cross-region bandwidth is being deleted.
CREATE_FAILED
The cross-region bandwidth is creating failed.
ZbgAdvertisedSubnet
Information on subnet route advertisement.
Referenced by：ModifyBorderGatewaysAttribute, DescribeBorderGateways, CreateBorderGateway
ALL
Advertise all.
NONE
Do not advertise.
PART
Advertise partial.
ZbgInfo
Information on border gateway.
Referenced by：DescribeBorderGateways
zbgId
String
Border gateway ID.
name
String
Border gateway name.
vpcId
String
VPC ID.
regionId
String
Region ID.
asn
Integer
Autonomous System Number.
interConnectCidr
String
Interconnect IP range.
createTime
String
Creation time.
natId
String
NAT gateway ID.
cloudRouterIds
Array of String
Cloud router IDs that border gateway is added into.
advertisedCidrs
Array of String
Custom IPv4 CIDR block list.
advertisedRouteIds
Array of String
ID list of the custom routes to be advertised.
ZoneInfo
Zone information, including city, etc.
Referenced by：DescribeZones
zoneId
String
Zone ID. For example, SEL-A .
regionId
String
Region ID of the zone.
zoneName
String
Zone name.
supportSecurityGroup [Deprecated]
Boolean
Support security groups or not.
Default value: true
Last updated