Data Types
BackendHealthStatus
Health check state of backend server.
Referenced by：DescribeBackendHealth
Alive
Healthy.
Dead
Unhealthy.
Unknown
Not detected.
Close
Health check disabled.
BackendHealthStatusDetail
Information on health check state of backend servers.
Referenced by：DescribeBackendHealth
port
Integer
Backend server port.
BackendServer
Information on backend servers.
Referenced by：DeregisterBackend, ModifyBackend, RegisterBackend
privateIpAddress
String
Yes
Private IP address of the network interface attached to the instance.
instanceId
String
No
Instance ID.
If the backend server is an elastic compute instance, you can call DescribeInstances, and find InstanceId in the response to obtain valid instance ID.
When unbinding, this field is required if an instance ID is present.
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].
Value 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].
Value range: [1, 65535]
EipNetworkType
Network type information of elastic IPs.
Referenced by：CreateLoadBalancer, InquiryPriceCreateLoadBalancer
BGPLine
BGP network.
CN2Line
China Telecom Next Carrier Network.
LocalLine
Local IP provided by a local ISP.
ChinaMobile
China Mobile network.
ChinaUnicom
China Unicom network.
ChinaTelecom
China Telecom network.
Cogent
Cogent IP network offered by Cogent Communications.
ThreeLine
3-in-1 IP Pool.
HealthCheck
Information on health check.
Referenced by：CreateListener, ModifyListener, DescribeListeners
enabled
Boolean
No
Whether to enable health check.
Default value: true
checkType
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].
Value range: [1, 65535]
checkDelayLoop
Integer
No
Health check interval.
Unit: seconds.
Optional range: [3, 30].
Default: 3.
Value range: [3, 30]
Default value: 3
checkConnTimeout
Integer
No
Health check timeout period.
Unit: seconds.
Optional range: [1, 15].
Default: 2.
Value range: [1, 15]
Default value: 2
checkRetry
Integer
No
Health check retry count.
Optional range: [1, 5].
Default: 2.
Value range: [1, 5]
Default value: 2
checkDelayTry
Integer
No
Interval between health check retries.
Unit: seconds.
Optional range: [1, 15].
Default: 2.
Value range: [1, 15]
Default value: 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].
Value range: [100, 599]
failOpen
Boolean
No
If all backends fail health checks, the load balancer will fail open and continue forwarding traffic to all servers to maintain service continuity.
HeathCheckType
Protocols for health check.
Referenced by：DescribeListeners
PING_CHECK
PING check.
TCP
TCP check.
HTTP_GET
HTTP check.
InternetChargeType
IP network billing method information.
Referenced by：CreateLoadBalancer, InquiryPriceCreateLoadBalancer
ByBandwidth
Flat rate billing method.
ByTrafficPackage
Data transfer package billing method.
BandwidthCluster
Bandwidth cluster billing method.
Listener
Information on listeners.
Referenced by：DescribeListeners
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.
listenerId
String
Listener ID.
listenerName
String
Listener name.
createTime
String
Creation time.
Format: YYYY-MM-ddTHH:mm:ssZ
persistent
Integer
Session persistence duration, in seconds.
Value range: [0, 3600]
ListenerBackend
Information on backend servers added to listeners.
Referenced by：DescribeBackends
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.
listenerPort
String
Listening port.
Use commas (,) to separate multiple ports.
Use a hyphen (-) to define a port range, e.g., 10000-10005.
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].
Value 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].
Value range: [1, 65535]
listenerId
String
Listener ID.
listenerName
String
Listener name.
ListenerBackendHealth
Information on health check state of backend servers of a load balance listener.
Referenced by：DescribeBackendHealth
instanceId
String
Instance ID.
You can obtain this value from the InstanceId field in the response of the DescribeInstances API.
privateIpAddress
String
The private IP of the vNIC attached to the instance.
listenerPort
String
Listening port.
Use commas (,) to separate multiple ports.
For port ranges, use a hyphen (-), e.g., 10000-10005.
healthStatusDetail
Array of BackendHealthStatusDetail
Health check status of the backend port.
When healthStatus is Close or Unknown, no detailed information is available.
weight
Integer
The forwarding weight of the backend server after modification.
The default value is 100 when adding a server. If not specified during modification, the weight will remain unchanged.
This parameter is not required when deleting a backend server.
Valid range: [0, 65535].
Value range: [0, 65535]
backendPort
Integer
The target port used for request forwarding and health checks.
If left empty, it follows the listener port configuration.
This parameter is not required when deleting a backend server.
Valid range: [1, 65535].
Value range: [1, 65535]
listenerId
String
Load balancer ID.
listenerName
String
Load balancer name.
ListenerProtocol
Listening protocol information of the listener.
Referenced by：CreateListener, DescribeBackendHealth, DescribeBackends, DescribeListeners
TCP
TCP protocol.
UDP
UDP protocol.
ListenerScheduler
Scheduling algorithm of the listener.
Referenced by：CreateListener, ModifyListener, DescribeListeners
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.
Referenced by：DescribeLoadBalancers
loadBalancerId
String
Load balance instance ID.
loadBalancerName
String
Load balance instance name.
vpcId
String
VPC ID to which the load balance backend server belongs.
healthCheckPrivateIps
Array of String
Health probe source private IP list.
regionId
String
Region ID.
publicIpAddress
Array of String
Public Virtual IP list of the load balancer instance.
privateIpAddress
Array of String
Private Virtual IP list of the load balancer instance.
listenerCount
Integer
Listener quantity.
createTime
String
Creation time.
Format: YYYY-MM-ddTHH:mm:ssZ
securityGroupId
String
Security group ID.
LoadBalancerInstanceStatus
State of the load balance instance.
Referenced by：DescribeLoadBalancers
CREATING
Creating.
RUNNING
Running.
RECYCLED
Recycled.
CREATE_FAILED
Creating failed.
RELEASING
Releasing.
LoadBalancerKind
Forwarding mode of the load balance listener.
Referenced by：CreateListener, ModifyListener, DescribeListeners
FNAT
Full NAT.
DR
Direct Routing.
DNAT
Destination NAT.
LoadBalancerMonitorMetricType
Information on monitor metrics of load balancers.
Referenced by：DescribeLoadBalancerMonitorData
NEW_CONNECTIONS
Concurrent connections.
The number of connections that are active and being handled simultaneously by a load balancing instance at a given time (per minutes).
CONCURRENT_CONNECTIONS
Connections Per Second (CPS).
The number of new connections that a load balancing instance can handle in one second.
HANDLED_BPS
Network Throughput.
The combined inbound and outbound bandwidth rate processed by a load balancing instance within one hour, measured in bits per second (bps).
MarketingInfo
Information on marketing campaigns.
Referenced by：CreateLoadBalancer
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 monitor metric values of load balancers.
Referenced by：DescribeLoadBalancerMonitorData
time
String
Metric value time.
value
Float
Metric value.
If the value is null, it indicates the corresponding data is unavailable.
NetworkLineType
Network type information of elastic IPs.
Referenced by：CreateLoadBalancer, InquiryPriceCreateLoadBalancer
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.
PriceCategory
Describes the price type.
Referenced by：InquiryPriceCreateLoadBalancer
STANDARD
Standard price.
CUSTOMIZED
Fixed price.
PriceItem
Pricing information.
Referenced by：InquiryPriceCreateLoadBalancer
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.
Referenced by：DescribeLoadBalancerRegions
regionId
String
Region ID.
cityName
String
Name of the city where the region is located.
cityCode
String
IATA airport code for the city.
ResourceGroupInfo
Information on resource group, including resource group name and resource group ID.
Referenced by：DescribeLoadBalancers
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
StepPrice
Describe a tier of the tiered price .
Referenced by：InquiryPriceCreateLoadBalancer
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.
Tag
Information on a tag, including its key and value.
Referenced by：CreateLoadBalancer, DescribeLoadBalancers
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：CreateLoadBalancer
Tags
Information on tags, including their keys and values.
Referenced by：DescribeLoadBalancers
Last updated