Data Types

BackendServer

Information on backend servers.

Parameter Name	Type	Required	Description
instanceId	String	Yes	Instance ID. To obtain valid instance ID, you can call DescribeInstances, and find InstanceId in the response.
privateIpAddress	String	Yes	Private IP address of the network interface attached to the instance.
weight	Integer	No	Forwarding weight of the backend server. The default value is 100 when adding a server. If not specified during modification, the value will remain unchanged. This parameter is not required when deleting a server. Optional range: [0, 65535].
port	Integer	No	Target port for request forwarding and health checks. If left empty, it will follow the listener's port configuration. This parameter is not required when deleting a server. Optional range: [1, 65535].

EipNetworkType

Network type information of elastic IPs.

Value	Description
BGPLine	BGP network.
CN2Line	China Telecom Next Carrier Network.
LocalLine	Local IP provided by a local ISP.
Cogent	Cogent IP network offered by Cogent Communications.
ChinaMobile	China Mobile network.
ChinaUnicom	China Unicom network.
ChinaTelecom	China Telecom network.

HealthCheck

Information on health check.

Parameter Name	Type	Required	Description
enabled	Boolean	No	Whether to enable health check. Default value: true.
checkType	HeathCheckType	No	Health check protocols. When health check is enabled, the value is required.
checkPort	Integer	No	Health check port. Defaults to the backend server port. Unless you need a specific port, it is recommended to leave this field empty. Optional range: [1, 65535].
checkDelayLoop	Integer	No	Health check interval. Unit: seconds. Optional range: [3, 30]. Default: 3.
checkConnTimeout	Integer	No	Health check timeout period. Unit: seconds. Optional range: [1, 15]. Default: 2.
checkRetry	Integer	No	Health check retry count. Optional range: [1, 5]. Default: 2.
checkDelayTry	Integer	No	Interval between health check retries. Unit: seconds. Optional range: [1, 15]. Default: 2.
checkHttpGetUrl	String	No	Health check path. Applicable only for the HTTP_GET protocol. If specified, it must start with a forward slash (/).
checkHttpStatusCode	Integer	No	Health check status code. Applicable only for the HTTP_GET protocol. Optional range: [100, 599].

HeathCheckType

Protocols for health check.

Value	Description
PING_CHECK	PING check.
TCP	TCP check.
HTTP_GET	HTTP check.

InternetChargeType

IP network billing method information.

Value	Description
ByBandwidth	Flat rate billing method.
ByTrafficPackage	Data transfer package billing method.
BandwidthCluster	Bandwidth cluster billing method.

Listener

Information on listeners.

Parameter Name	Type	Description
listenerId	String	Listener ID.
listenerName	String	Listener name.
protocol	ListenerProtocol	Listening protocols.
port	String	Listening port. Use commas (,) to separate multiple ports. Use a hyphen (-) to define a port range, e.g., 10000-10005. If multiple consecutive individual ports are provided, they will be automatically aggregated into a port range.
healthCheck	HealthCheck	Heath check information of a listener.
scheduler	ListenerScheduler	Scheduling algorithm.
createTime	String	Creation time. Format: YYYY-MM-DDThh:mm:ssZ

ListenerBackend

Information on backend servers added to listeners.

Parameter Name	Type	Description
instanceId	String	Instance ID. To obtain valid instance ID, you can call DescribeInstances, and find InstanceId in the response.
privateIpAddress	String	Private IP address of the network interface attached to the instance.
weight	Integer	Forwarding weight of the backend server. The default value is 100 when adding a server. If not specified during modification, the value will remain unchanged. This parameter is not required when deleting a server. Optional range: [0, 65535].
backendPort	Integer	Target port for request forwarding and health checks. If left empty, it will follow the listener's port configuration. This parameter is not required when deleting a server. Optional range: [1, 65535].
listenerId	String	Listener ID.
listenerName	String	Listener name.
protocol	ListenerProtocol	Listening protocols.
listenerPort	String	Listening port. Use commas (,) to separate multiple ports. Use a hyphen (-) to define a port range, e.g., 10000-10005.

ListenerProtocol

Listening protocol information of the listener.

Value	Description
TCP	TCP protocol.
UDP	UDP protocol.

ListenerScheduler

Scheduling algorithm of the listener.

Value	Description
mh	Maglev Hashing (mh).
rr	Round Robin (rr).
wrr	Weighted Round Robin (wrr).
lc	Least Connections (lc).
wlc	Weighted Least Connections (wlc).
sh	Source Hashing (sh).
dh	Destination Hashing (dh).

LoadBalancer

Information on load balance instances.

Parameter Name	Type	Description
regionId	String	Region ID.
loadBalancerId	String	Load balance instance ID.
loadBalancerName	String	Load balance instance name.
vpcId	String	VPC ID to which the load balance backend server belongs.
status	LoadBalancerInstanceStatus	Load balance instance state.
publicIpAddress	Array of String	Virtual IP list of the load balancer instance.
listenerCount	Integer	Listener quantity.
createTime	String	Creation time. Format: YYYY-MM-DDThh:mm:ssZ

LoadBalancerInstanceStatus

State of the load balance instance.

State	Description
CREATING	Creating.
RUNNING	Running.
RECYCLED	Recycled.
CREATE_FAILED	Creating failed.
RELEASING	Releasing.

PriceItem

Pricing information.

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.

Region

Information on regions.

Parameter Name	Type	Description
regionId	String	Region ID.
cityName	String	Name of the city where the region is located.
cityCode	String	IATA airport code for the city.

StepPrice

Describe a tier of the tiered price .

Parameter Name	Type	Description
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.