For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Types

AssociateSubnetInstance

Add an instance into a subnet.

Referenced by:AssociateSubnetInstances

Parameter Name
Type
Required
Description

instanceId

String

Yes

Instance ID.

privateIpAddress

String

No

Private IPv4 address.

The value should be in the range of subnet CIDR block. If the value is not passed in, any available private IP addresses will be assigned to the instance randomly.

AvailableIpv4Resource

Available IPv4 CIDR blocks.

Referenced by:DescribeAvailableIpv4Resources

Parameter Name
Type
Description

zoneId

String

Zone ID to which the CIDR block belongs.

netmask

Integer

Netmask.

sellStatus

Status for sale.

SELL : available for sale, stock > 10. SELL_SHORTAGE : available for sale, stock SOLD_OUT : sold out.

cidrType

CIDR block type.

AvailableIpv6Resource

Available IPv6 CIDR blocks.

Referenced by:DescribeAvailableIpv6Resources

Parameter Name
Type
Description

zoneId

String

Zone ID to which the CIDR block belongs.

sellStatus

Status for sale.

SELL : available for sale, stock > 10. SELL_SHORTAGE : available for sale, stock SOLD_OUT : sold out.

AvailableResource

Information on instance resources for sale. Describe what kinds of instance models are available for sale in the specified zones.

Referenced by:DescribeAvailableResources

Parameter Name
Type
Description

zoneId

String

Zone ID

sellStatus

Status for sale.

SELL : available for sale, stock > 10. SELL_SHORTAGE : available for sale, stock SOLD_OUT : sold out.

internetChargeTypes

Network pricing model.

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.

BackendInfo

Information on load balance backend servers.

Referenced by:DescribeLoadBalancers, DescribeBackends

Parameter Name
Type
Description

listenerId

String

Listener ID.

backendId

String

Backend server ID.

backendName

String

Backend server name.

status

String

Backend server state.

port

String

Backend port.

weight

Integer

Backend server weight.

instanceId

String

Instance ID.

instanceType

Instance type.

instanceName

String

Instance name.

createTime

String

Creation time.

Use UTC time according to the ISO8601 standard. Format: YYYY-MM-ddTHH:mm:ssZ .

ChargePrepaid

Details of the monthly subscription, including the purchase period, auto-renewal, etc.

Referenced by:CreateLoadBalancer, InquiryPriceCreateEipAddress, CreateInstances, InquiryPriceCreateIpv4Block, AllocateEipAddresses, InquiryPriceCreateInstance, CreateIpv4Block

Parameter Name
Type
Required
Description

period

Integer

Yes

Period of subscription.

Unit: month.

Value range: [1, +)

ChargeType

Information on pricing model.

Referenced by:DescribeAvailableResources, DescribeLoadBalancerSpecs, InquiryPriceCreateEipAddress, DescribeAvailableIpv4Resources, InquiryPriceCreateIpv4Block, DescribeEipAvailableResources, DescribeCidrBlocks, InquiryPriceCreateInstance, CreateIpv4Block, CreateLoadBalancer, DescribeLoadBalancerZones, CreateInstances, DescribeInstances, AllocateEipAddresses, DescribeEipAddresses

Value
Description

PREPAID

Subscription.

POSTPAID

Pay-as-you-go.

CidrBlockInfo

Information on CIDR blocks.

Referenced by:DescribeCidrBlocks

Parameter Name
Type
Description

cidrBlockId

String

ID of CIDR block.

cidrBlockType

Type of CIDR block. The optional values are as follows:

IPv4 IPv6

cidrType

CIDR block type.

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

Status of CIDR block .

chargeType

Pricing model.

PREPAID: monthly subscription.

POSTPAID: pay-as-you-go.

createTime

String

Creation time.

Format: YYYY-MM-ddTHH:mm:ssZ .

expireTime

String

Expiration time.

Format: YYYY-MM-ddTHH:mm:ssZ .

resourceGroupId

String

Resource group ID.

resourceGroupName

String

Resource group name.

tags

Bound tags.

CidrBlockIp

Information on CIDR IPs on the CIDR block.

Referenced by:DescribeCidrBlockIps

Parameter Name
Type
Description

cidrBlockId

String

ID of CIDR block.

cidrBlockType

Type of CIDR block. The optional values are as follows:

IPv4 IPv6

ip

String

IP address.

instanceId

String

List of instance IDs.

status

Status of IPs .

CidrBlockIpStatus

Status of CIDR block IPs.

Referenced by:DescribeCidrBlockIps

Value
Description

BINDING

Binding.

UNBINDING

Unbinding.

BOUND

Bound.

AVAILABLE

Available.

CidrBlockStatus

Status of CIDR blocks.

Referenced by:DescribeCidrBlocks

Value
Description

CREATING

Creating.

CREATE_FAILED

Creating failed.

RECYCLING

Recycling.

RECYCLE

Recycled.

AVAILABLE

Available.

CidrBlockType

The type of the CIDR block.

Referenced by:DescribeAvailableIpv4Resources, InquiryPriceCreateIpv4Block, DescribeCidrBlocks, DescribeInstanceAvailableCidrBlock, CreateIpv4Block

Value
Description

BGP

BGP IP.

Local

Local IP.

CustomRaid

RAID levels and disk serial number for custom RAID settings.

Referenced by:CreateInstances

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.

Disk

Information on disks.

Referenced by:DescribeInstanceTypes

Parameter Name
Type
Description

diskSize

Integer

Disk size.

Unit: GB.

diskCount

Integer

Quantity of disks of the size.

EipAddress

Information on elastic IPs.

Referenced by:DescribeEipAddresses

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.

netmask

Integer

IP netmask.

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

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 .

Note:

The value is empty for pay-as-you-go resources.

resourceGroupId

String

Resource group ID.

resourceGroupName

String

Resource group name.

eipStatus

String

Status of elastic IP .

tags

Bound tags.

EipAvailable

Available elastic IPs for sale in specified zones.

Referenced by:DescribeEipAvailableResources

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 SOLD_OUT : sold out.

netmask

Integer

IP netmask.

EipStatus

Status of elastic IPs.

Referenced by:DescribeEipAddresses

Value
Description

CREATING

Creating.

CREATE_FAILED

Creating failed.

ASSOCIATING

Assigning.

UNASSOCIATING

Unassigning.

ASSOCIATED

Assigned.

AVAILABLE

Available.

RECYCLING

Recycling.

RECYCLE

Recycled.

HealthCheck

Information on load balance health check.

Referenced by:CreateListener, ModifyListenerAttribute, DescribeLoadBalancers

Parameter Name
Type
Required
Description

checkEnabled

Boolean

No

Whether to enable health check.

checkType

String

No

Health check protocols.

checkConnectTimeout

Integer

No

Health check timeout period.

checkRetry

Integer

No

Health check retry count.

checkDelayBeforeRetry

Integer

No

Interval between health check retries.

checkIntervalTime

Integer

No

Health check interval.

checkPort

Integer

No

Health check port.

httpVersion

String

No

Health check HTTP protocol version.

httpCheckPath

String

No

Health check HTTP request path.

httpCheckDigest

Integer

No

Health check HTTP digest

httpCode

Integer

No

Health check HTTP status code

miscCheckPath

String

No

Health check MISC request path.

miscTimeout

Integer

No

Health check MISC timeout.

ImageInfo

Information on images.

Referenced by:DescribeImages

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

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

Operating system type.

The optional values are as follows:

Windows Linux

ImageType

Image type

Referenced by:DescribeImages

Value
Description

PUBLIC_IMAGE

System image.

CUSTOM_IMAGE

Custom image.

InstanceAvailableCidrBlock

Available CIDR blocks for instances.

Referenced by:DescribeInstanceAvailableCidrBlock

Parameter Name
Type
Description

cidrBlockId

String

ID of CIDR block.

zoneId

String

Zone ID to which the CIDR block belongs.

cidrBlockType

CIDR block type.

cidrType

CIDR block type.

cidrBlock

String

CIDR block.

availableIps

Array of String

List of available IPs.

availableIpCount

Integer

Quantity of available IPs.

InstanceAvailableEip

Information on elastic IPs.

Referenced by:DescribeInstanceAvailableEipResources

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.

netmask

Integer

IP netmask.

InstanceDiskInfo

Information on disks.

Referenced by:DescribeInstanceTypes

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.

InstanceHealth

Server hardware health information.

Referenced by:DescribeInstancesMonitorHealth

Parameter Name
Type
Description

instanceId

String

Instance ID.

cpuStatus

String

CPU health state.

OK : Normal state. WARNING : Abnormal state. UNKNOWN : State detected failed.

diskStatus

String

Disk health state.

OK : Normal state. WARNING : Abnormal state. UNKNOWN : State detected failed.

ipmiPing

String

IPMI IP health state.

OK : ICMP detected normal. CRITICAL : ICMP detected failed. UNKNOWN : State detected failed.

ipmiStatus

String

IPMI health state.

OK : ICMP detected normal. WARNING : Abnormal state. UNKNOWN : State detected failed.

memoryStatus

String

Memory health state.

OK : Normal state. WARNING : Abnormal state. UNKNOWN : State detected failed.

psuStatus

String

Power supply health state.

OK : Normal state. WARNING : Abnormal state. UNKNOWN : State detected failed.

wanPortStatus

String

Server's public network interface connection state.

OK : Normal state. WARNING : Abnormal state. UNKNOWN : State detected failed.

fanStatus

String

Fan state.

OK : Normal state. WARNING : Abnormal state. UNKNOWN : State detected failed.

serverBrand

String

Server supplier brand.

serverModel

String

Server supplier model.

cpuTemp

Integer

Temperature of a single CPU in Supermicro blade servers.

The range is from 0 to 100. The unit is ℃.

Note that a value of 0 is generally not retrievable, and a value of 100 signifies an exceptionally high temperature.

cpu0Temp

Integer

CPU0 temperature. The range is from 0 to 100. The unit is ℃. If the value is empty, it means the temperature is not retrievable.

cpu1Temp

Integer

CPU1 temperature. The range is from 0 to 100. The unit is ℃. If the value is empty, it means the temperature is not retrievable.

cpu2Temp

Integer

CPU2 temperature. The range is from 0 to 100. The unit is ℃. If the value is empty, it means the temperature is not retrievable.

inletTemp

Integer

Temperature of the air or environment surrounding the server equipment in a data center or server room.

tempUnit

String

Temperature unit.

Only Celsius is supported, that is ℃.

InstanceInfo

Information on instances.

Referenced by:DescribeInstances

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.

instanceType

Instance model configuration info.

imageId

String

Image ID.

imageName

String

Image name.

ipxeUrl

String

iPXE URL.

instanceChargeType

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

Network pricing model.

period

Integer

Period of instance subscription.

Unit:month.

For postpaid instances,the value is empty.

primaryPublicIpAddress

String

Instance primary IP address.

primaryPublicIPv6Address

String

Instance primary IPv6 address.

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

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.

instanceStatus

Status of instances.

trafficPackageSize

Float

Traffic package size purchased.

Unit:TB.

raidConfig

Disk array configuration.

partitions

Array of Partition

Partition configuration.

nic

NIC configuration.

autoRenew

Boolean

Whether to enable auto-renewal.

keyId

String

SSH key pair ID.

The value may be null,indicating that there is no valid value.

tags

Bound tags.

enableGatewayMode

Boolean

Whether to enable Gateway Mode.

InstanceProductType

Instance type.

Referenced by:DescribeLoadBalancers, DescribeBackends, RegisterBackend

Value
Description

BM

Bare Metal

VM

Virtual machine.

InstanceStatus

Status of instance.

Referenced by:DescribeInstances

Value
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.

InstanceTrafficData

Instance bandwidth data.

Referenced by:DescribeInstanceTraffic, DescribeManagedInstanceTraffic

Parameter Name
Type
Description

internetRX

Integer

Inbound bandwidth. Unit: bps.

internetTX

Integer

Outbound bandwidth. Unit: bps.

time

String

Data time.

Format: YYYY-MM-ddTHH:mm:ssZ .

InstanceType

Information on instance models, including CPU, memory, subnet supported or not, etc.

Referenced by:DescribeInstances, DescribeInstanceTypes

Parameter Name
Type
Description

imageIds

Array of String

Image ID supported. Hint: only accessible in DescribeInstanceType .

instanceTypeId

String

Instance model ID.

description

String

Model description, including memory size, disk, etc.

cpuCoreCount

Integer

Quantity of CPUs.

cpuDetail

String

Details of CPU.

cpuCores

Integer

Quantity of CPU cores.

cpuThreads

Integer

CPU threads.

baseFrequency

String

CPU base frequency.

memorySize

Integer

Memory size.

Unit: GB.

maximumBandwidth

Integer

Outbound bandwidth cap.

Unit: Mbps.

supportRaids

Array of Integer

RAID level supported.

supportSubnet

Boolean

Subnet supported or not.

isHA

Boolean

High availability supported or not.

diskInfo

Disk size.

Unit: GB.

vpuVendor

String

VPU vendor

vpuCard

String

VPU Model. Example: T1U

vpuCount

Integer

VPU count.

InternetChargeType

Network pricing model.

Referenced by:DescribeAvailableResources, CreateInstances, DescribeInstances, InquiryPriceCreateInstance

Value
Description

ByBandwidth

Billed by the flat rate bandwidth.

ByTrafficPackage

Billed by the traffic package size purchased.

ByInstanceBandwidth95

Burstable 95th billing.

ByClusterBandwidth95

Billed by the burstable 95th bandwidth of instances in a city-based bandwidth cluster.

ByBandwidthCluster

Billed by the burstable 95th bandwidth of all compute resources in a city-based or regional bandwidth cluster with a shared commitment.

IpBindParam

Status of CIDR block IPs assigned to instances.

Referenced by:BindCidrBlockIps

Parameter Name
Type
Required
Description

instanceId

String

Yes

Instance ID.

ip

String

Yes

CIDR block IP.

To obtain the CIDR block IP, you can call DescribeInstanceAvailableCidrBlock and look for availableIps in the response.

IpType

Information on IP type.

Referenced by:DescribeCidrBlockIps, DescribeCidrBlocks, DescribeInstanceAvailableCidrBlock, CreateByoip

Value
Description

IPV4

IPv4.

IPV6

IPv6.

LbKind

Forwarding mode.

Referenced by:CreateListener, ModifyListenerAttribute, DescribeLoadBalancers

Value
Description

DR

Direct Routing.

FNAT

Global Network Address Translation.

ListenerInfo

Information on load balance listeners.

Referenced by:DescribeLoadBalancers, DescribeListeners

Parameter Name
Type
Description

loadBalancerId

String

Load balance instance ID.

listenerId

String

Listener ID.

listenerName

String

Listener name.

status

String

State of a listener.

port

String

Listening port.

protocol

String

Listening protocol.

backendProtocol

String

Backend forwarding protocol.

scheduler

String

Scheduling algorithm.

kind

Forwarding mode.

healthCheck

Heath check information of a listener.

notify

Alarm.

createTime

String

Creation time.

Use UTC time according to the ISO8601 standard. Format: YYYY-MM-ddTHH:mm:ssZ .

LoadBalancerInfo

Information on load balance instances.

Referenced by:DescribeLoadBalancers

Parameter Name
Type
Description

loadBalancerId

String

Load balance instance ID.

zoneId

String

Zone ID of a load balancer.

loadBalancerName

String

Load balance instance name.

specName

String

Specification name.

Default value: Unlimited LoadBalancer

vipList

Virtual IP list of a load balancer.

chargeType

String

Pricing model.

period

Integer

Billing cycle.

createTime

String

Creation time.

Use UTC time according to the ISO8601 standard. Format: YYYY-MM-ddTHH:mm:ssZ .

expiredTime

String

Expiration time.

status

String

State of a load balancer.

resourceGroupId

String

Resource group ID.

resourceGroupName

String

Resource group name.

masterIp

String

Primary IP.

backupIp

String

Secondary IP.

ipType

String

IPv4.

bandwidth

Integer

Bandwidth.

Default value: 0

isWorking

Boolean

Whether the load balancer is active or not.

listenerList

Array of ListenerInfo

Listener set.

backendList

Array of BackendInfo

Backend server set.

tags

Bound tags.

LoadBalancerIp

Information on load balancer virtual IPs (VIPs).

Referenced by:DescribeLoadBalancers

Parameter Name
Type
Description

vipId

String

VIP ID.

ipAddress

String

VIP address.

type

String

VIP type.

Available values: DEFAULT , EXTRA

status

String

VIP state.

LoadBalancerSpec

Information on load balancer specifications.

Referenced by:DescribeLoadBalancerSpecs

Parameter Name
Type
Description

specName

String

Specification name.

maxConnection

Integer

Max connections.

cps

Integer

Connections Per Second (CPS).

qps

Integer

Queries Per Second (QPS).

ManagedInstanceInfo

Information on managed instances.

Referenced by:DescribeManagedInstances

Parameter Name
Type
Description

instanceId

String

Instance ID.

instanceName

String

Instance name.

facName

String

Location name.

ips

Array of String

Public IP list.

lanIps

Array of String

Private IP list.

createTime

String

Creation time.

MarketingInfo

Information on marketing campaigns.

Referenced by:CreateLoadBalancer, CreateInstances, AllocateEipAddresses, CreateIpv4Block

Parameter Name
Type
Required
Description

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.

Nic

NIC configuration, including public and private NIC names settings.

Referenced by:ReinstallInstance, CreateInstances, DescribeInstances

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.

Notify

Information on load balance health check alarm.

Referenced by:CreateListener, ModifyListenerAttribute, DescribeLoadBalancers

Parameter Name
Type
Required
Description

enable

Boolean

No

Whether to enable health check alarm.

apiAddress

String

No

Alarm address.

OsType

Operating system type.

Referenced by:DescribeImages

Value
Description

windows

Windows.

linux

Linux.

Partition

Partition configuration information, including file type, partition size, etc.

Referenced by:ReinstallInstance, CreateInstances, DescribeInstances

Parameter Name
Type
Required
Description

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".

fsType

String

Yes

File type of partition.

Linux: ext2 , ext3 , ext4 , ext type is needed.

Windows: NTFS .

size

Integer

Yes

Partition size.

Unit: GiB.

Value range: [1, +)

PriceCategory

Information on price type.

Referenced by:InquiryPriceCreateInstance

Value
Description

STANDARD

Standard price.

CUSTOMIZED

Fixed price.

PriceItem

Information on the price.

Referenced by:InquiryPriceInstanceBandwidth, InquiryPriceInstanceTrafficPackage, InquiryPriceCreateEipAddress, InquiryPriceCreateIpv4Block, InquiryPriceCreateInstance

Parameter Name
Type
Description

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.

category

The price category

RaidConfig

Disk RAID configuration, including custom RAID settings.

Referenced by:ReinstallInstance, CreateInstances, DescribeInstances

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.

SellStatus

Information in sale status.

Referenced by:DescribeAvailableResources, DescribeAvailableIpv4Resources, DescribeAvailableIpv6Resources

Value
Description

SOLD_OUT

Sold out.

SELL_SHORTAGE

Available for sale, stock <= 10.

SELL

Available for sale, stock > 10.

StepPrice

Tiered price of postpaid billing. Describe a tier of the price.

Referenced by:InquiryPriceCreateInstance

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.

SubnetInfo

Information on subnets.

Referenced by:DescribeSubnets

Parameter Name
Type
Description

subnetId

String

Subnet ID.

subnetName

String

Subnet name.

zoneId

String

Zone ID to which the subnet belongs.

availableIpCount

Integer

Quantity of available IPs in subnet.

cidrBlock

String

CIDR block of subnet.

subnetStatus

String

Status of subnet .

createTime

String

Creation time.

Use UTC time according to the ISO8601 standard. Format: YYYY-MM-ddTHH:mm:ssZ .

vpcSubnetStatus

String

Status of subnets in VPC .

vpcId

String

VPC ID.

vpcName

String

VPC name.

resourceGroupId

String

Resource group ID.

resourceGroupName

String

Resource group name.

subnetInstanceSet

Information about instances in the subnet.

SubnetInstance

Information on instances in subnet.

Referenced by:DescribeSubnets

Parameter Name
Type
Description

instanceId

String

Instance ID.

privateIpAddress

String

Private IP address.

privateIpStatus

String

Status of private IP address.

SubnetStatus

Status of subnet.

Referenced by:DescribeSubnets

Value
Description

CREATING

Creating.

CREATE_FAILED

Creating failed.

AVAILABLE

Available.

DELETING

Deleting.

Tag

Information on a tag, including its key and value.

Referenced by:DescribeVpcs, CreateInstances, DescribeInstances, DescribeLoadBalancers, DescribeCidrBlocks, DescribeEipAddresses

Parameter Name
Type
Required
Description

key

String

Yes

Tag key. Length limit: 1 to 128 characters.

value

String

No

Tag value. Length limit: 1 to 128 characters.

TagAssociation

Information on tags bound to resources, including their keys and values.

Referenced by:CreateVpc, CreateLoadBalancer, CreateIpv6Block, CreateInstances, AllocateEipAddresses, CreateIpv4Block

Parameter Name
Type
Required
Description

tags

Array of Tag

Yes

List of tags.

Tags

Information on tags, including their keys and values.

Referenced by:DescribeVpcs, DescribeInstances, DescribeLoadBalancers, DescribeCidrBlocks, DescribeEipAddresses

Parameter Name
Type
Description

tags

Array of Tag

List of tags.

VpcInfo

Information on VPCs.

Referenced by:DescribeVpcs

Parameter Name
Type
Description

vpcId

String

VPC ID.

vpcRegionId

String

Availability region ID of VPC.

vpcRegionName

String

Availability region name of VPC.

vpcName

String

VPC name.

cidrBlock

String

CIDR block of VPC.

createTime

String

Creation time.

Format: YYYY-MM-ddTHH:mm:ssZ .

vpcStatus

String

Status of VPC .

resourceGroupId

String

Resource group ID.

resourceGroupName

String

Resource group name.

tags

Bound tags.

VpcRegionInfo

Information on availability region of VPC.

Referenced by:DescribeVpcAvailableRegions

Parameter Name
Type
Description

vpcRegionId

String

Availability region ID of VPC.

vpcRegionName

String

Availability region name of VPC.

zoneIds

Array of String

List if zone IDs.

VpcStatus

Status of VPC.

Referenced by:DescribeVpcs

Value
Description

CREATING

Creating.

CREATE_FAILED

Creating failed.

AVAILABLE

Available.

DELETING

Deleting.

Zone

Zone information, including city, etc.

Referenced by:DescribeZones

Parameter Name
Type
Description

zoneId

String

Zone ID. For example, SEL-A .

zoneName

String

Zone name.

cityName

String

City name of the zone.

areaName

String

Region name of the zone.

isCloudRouterAvailable

Boolean

Whether the zone supports Layer 3 cloud router.

Default value: false

isByoipEnabled

Boolean

Indicate whether the availability zone support BYO IP addressing or not.

Default value: false

Last updated