Private IP address of the network interface attached to the instance.
When the ipStackType of the load balancer instance is IPv6, fill in the IPv6 address (either public or private) on the network interface of the instance. In this case, instanceId must be specified as well; specifying the IP address alone is not supported.
Instance ID.
If a ZEC instance is used as the backend server, the value can be obtained from the instanceId field in the response of DescribeInstances.
When unbinding, this field is required for backend servers that have an instance ID.
| | weight | Integer | No |Forwarding weight of the backend server after modification.
The default value is 100 when adding a server. If not specified during modification, the value remains unchanged.
This parameter is not required when deleting a server.
Value range: \[0, 65535]
| | port | Integer | No |Target port for request forwarding and health checks.
If left empty, it will follow the listener port configuration.
This parameter is not required when deleting a server.
When the listener forwarding mode is DR, or the listener uses all ports (0) or multiple ports, specifying a target port is not supported; the target port must match the listener port.
Value range: \[1, 65535]
| ## BandwidthPriceResponseItem Bandwidth price details. Referenced by：InquiryPriceCreateLoadBalancer | Parameter Name | Type | Description | | -------------- | ----------------------- | ------------------------------------------- | | trafficType | String | Traffic direction type. | | price | [PriceItem](#priceitem) | Bandwidth price for this traffic direction. | ## EipNetworkType Network line information of the elastic IP. For details, see also `NetworkLineType`. Referenced by：CreateLoadBalancer, InquiryPriceCreateLoadBalancer | Value | Description | | -------------------- | ------------------------------------------------------- | | BGPLine | BGP line. | | CN2Line | CN2 line optimized for traffic to the Chinese mainland. | | 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. | | PathBasedBandwidthIP | Path-based bandwidth IP. | ## HealthCheck Information on health check. Referenced by：CreateListener, ModifyListener, DescribeListeners | Parameter Name | Type | Required | Description | | ------------------- | --------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | enabled | Boolean | No |Whether to enable health check.
Default value: true
| | checkType | [HeathCheckType](#heathchecktype) | No |Protocol used for health check.
This field is required when health check is enabled.
| | checkPort | Integer | No |Health check port.
If not specified, the port of the backend server is used. Generally, it does not need to be specified.
When the listener port is all ports (0) or a port range, and the health check type is TCP or HTTP\_GET, this field is required.
Value range: \[1, 65535]
| | checkDelayLoop | Integer | No |Interval between health checks.
Unit: seconds.
Value range: \[3, 30]
Default value: 3
| | checkConnTimeout | Integer | No |Connection timeout of the health check.
Unit: seconds.
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.
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 | Value | Description | | ----------- | ----------------------- | | PING\_CHECK | Ping check. | | TCP | TCP check. | | HTTP\_GET | HTTP GET request check. | ## InternetChargeType IP network billing method information. Referenced by：CreateLoadBalancer, AssignLoadBalancerIpv6, InquiryPriceCreateLoadBalancer | Value | Description | | ---------------- | ------------------------------------- | | ByBandwidth | Flat rate billing method. | | ByTrafficPackage | Data transfer package billing method. | | BandwidthCluster | Bandwidth cluster billing method. | ## Listener Information on listeners. Referenced by：DescribeListeners | Parameter Name | Type | Description | | -------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | port | String |Listening port.
Multiple ports are separated by commas (,).
A port range is connected with -, for example: 10000-10005.
Valid port values range from 0 to 65535, where 0 indicates all ports.
If multiple consecutive individual ports are passed, they are automatically aggregated into a port range.
| | listenerId | String | Load balancer listener ID. | | listenerName | String | Listener name. | | ipStackType | [LoadBalancerIpStackType](#loadbalanceripstacktype) |IP stack type of the load balancer instance that the listener belongs to.
A listener itself does not have a stack type. The value comes from the load balancer instance that it belongs to.
| | protocol | [ListenerProtocol](#listenerprotocol) | Listening protocols. | | healthCheck | [HealthCheck](#healthcheck) | Heath check information of a listener. | | scheduler | [ListenerScheduler](#listenerscheduler) | Scheduling algorithm of the listener. | | kind | [LoadBalancerKind](#loadbalancerkind) | Forwarding mode. | | createTime | String |Creation time.
The time is in ISO 8601 format and in UTC, in the form of YYYY-MM-ddTHH🇲🇲ssZ.
| | persistent | Integer |Session persistence duration, in seconds.
Mutually exclusive with algoOpts (advanced scheduling-algorithm option) — when this listener has algoOpts enabled, this field is always empty/0.
Value range: \[0, +)
| | algoOpts | [ListenerAlgoOpts](#listeneralgoopts) |Advanced scheduling-algorithm option.
Only has a value when the forwarding mode (kind) is DR and the scheduling algorithm (scheduler) is mh; when disabled, this field is empty — query interfaces never return None.
Once enabled, it is mutually exclusive with session persistence (persistent).
Idle timeout period. Unit: seconds.
Value range: \[60, +)
| ## ListenerAlgoOpts Describes advanced options for the listener's scheduling algorithm. Referenced by：CreateListener, ModifyListener, DescribeListeners | Value | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | StatelessForwarding |MH stateless forwarding (One-Packet Scheduling).
When enabled, the load balancer does not maintain a connection tracking table and selects a backend for each packet in real time based on MH hashing, which improves anti-DDoS capability and forwarding performance. It is only available when the forwarding mode is DR and the scheduling algorithm is MH. Adding or removing backend nodes, or changes in their health status, may interrupt some connections.
| | None |Explicitly disables the advanced scheduling algorithm options.
Only used in Create/Modify request semantics: passing this value clears the enabled advanced options, while omitting the field leaves them unchanged.
Query APIs (such as Describe) never return this value; a disabled state is always represented by an empty field.
| ## ListenerBackend Information on backend servers added to listeners. Referenced by：DescribeBackends | Parameter Name | Type | Description | | ---------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | instanceId | String |Instance ID.
It can be obtained from the instanceId field in the response of DescribeInstances.
| | privateIpAddress | String |Private IP address of the network interface attached to the instance.
When the ipStackType of the load balancer instance is IPv6, the IPv6 address on the network interface of the instance is returned.
Listening port.
Multiple ports are separated by commas (,).
A port range is connected with -, for example: 10000-10005.
Forwarding weight of the backend server after modification.
The default value is 100 when adding a server. If not specified during modification, the value remains unchanged.
This parameter is not required when deleting a server.
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 | Load balancer listener ID. | | listenerName | String | Listener name. | | protocol | [ListenerProtocol](#listenerprotocol) | Listening protocols. | ## ListenerBackendHealth Information on health check state of backend servers of a load balance listener. Referenced by：DescribeBackendHealth | Parameter Name | Type | Description | | ------------------ | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | instanceId | String |Instance ID.
It can be obtained from the instanceId field in the response of DescribeInstances.
| | privateIpAddress | String |The private IP of the vNIC attached to the instance.
When the ipStackType of the load balancer instance is IPv6, the IPv6 address on the vNIC of the instance is returned.
Listening port.
Multiple ports are separated by commas (,).
A port range is connected with -, for example: 10000-10005.
Health check status of the backend port.
When healthStatus is Close or Unknown, no detailed information is available.
| | weight | Integer |Forwarding weight of the backend server after modification.
The default value is 100 when adding a server. If not specified during modification, the value remains unchanged.
This parameter is not required when deleting a server.
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 listener ID. | | listenerName | String | Load balancer name. | | protocol | [ListenerProtocol](#listenerprotocol) | Listener protocol. | ## ListenerProtocol Listening protocol information of the listener. Referenced by：CreateListener, DescribeBackendHealth, DescribeBackends, DescribeListeners | Value | Description | | ----- | ------------- | | TCP | TCP protocol. | | UDP | UDP protocol. | ## ListenerScheduler Describes the scheduling algorithm of the listener. Referenced by：CreateListener, ModifyListener, DescribeListeners | 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. Referenced by：DescribeLoadBalancers | Parameter Name | Type | Description | | --------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | loadBalancerId | String | Load balance instance ID. | | loadBalancerName | String | Load balance instance name. | | vpcId | String | ID of the VPC to which the backend servers of the load balancer belong. | | status | [LoadBalancerInstanceStatus](#loadbalancerinstancestatus) | Load balance instance state. | | healthCheckPrivateIps | Array of String | Health probe source private IP list. | | regionId | String | Region ID. | | subnetId | String |ID of the subnet to which the load balancer instance belongs.
The private IPs for health check are allocated from this subnet. When ipStackType is IPv6, the public IPv6 block is also allocated from this subnet.
This field is empty for instances created without a specified subnet.
| | ipStackType | [LoadBalancerIpStackType](#loadbalanceripstacktype) |IP stack type.
A load balancer instance supports only a single stack, that is, IPv4 or IPv6.
List of public VIPs of the load balancer instance.
The IPv4 type returns a single address (such as 128.0.0.1), while the IPv6 type returns a block with a mask (such as 2001:db8::/96) instead of a single address within the block.
Total number of backend servers added to all listeners of the load balancer.
Counted by the private IP of the backend servers; multiple private IPs of the same server are counted separately.
| | createTime | String |Creation time.
The time is in ISO 8601 format and in UTC, in the form of YYYY-MM-ddTHH🇲🇲ssZ.
| | resourceGroup | [ResourceGroupInfo](#resourcegroupinfo) | Resource group information. | | tags | [Tags](#tags) | Tags bound to resources. | | securityGroupId | String | Security group ID. | ## LoadBalancerInstanceStatus State of the load balance instance. Referenced by：DescribeLoadBalancers | Value | Description | | -------------- | ---------------- | | CREATING | Creating. | | RUNNING | Running. | | RECYCLED | Recycled. | | CREATE\_FAILED | Creating failed. | | RELEASING | Releasing. | ## LoadBalancerIpStackType Values of the IP stack type of load balancer instances. Referenced by：CreateLoadBalancer, DescribeLoadBalancers, DescribeListeners, InquiryPriceCreateLoadBalancer | Value | Description | | ----- | ----------- | | IPv4 | IPv4 only. | | IPv6 | IPv6 only. | ## LoadBalancerKind Forwarding mode of the load balance listener. Referenced by：CreateListener, ModifyListener, DescribeListeners | Value | Description | | ----- | ---------------- | | FNAT | Full NAT. | | DR | Direct Routing. | | DNAT | Destination NAT. | ## LoadBalancerMonitorMetricType Information on monitor metrics of load balancers. Referenced by：DescribeLoadBalancerMonitorData | Value | Description | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | NEW\_CONNECTIONS |Connections Per Second (CPS).
The number of new connections that a load balancing instance can handle in one second.
| | CONCURRENT\_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).
| | HANDLED\_BPS |Network throughput.
The sum of the inbound and outbound bandwidth rates processed by the load balancer instance within one hour. Unit: bps.
| ## MarketingInfo Information on marketing campaigns. Referenced by：CreateLoadBalancer | 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.
| ## MetricValue Information on monitor metric values of load balancers. Referenced by：DescribeLoadBalancerMonitorData | Parameter Name | Type | Description | | -------------- | ------ | ---------------------------------------------------------------------------------------------------- | | 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 | Value | Description | | -------------------- | ----------------------------------------------------------------------- | | PremiumBGP |Premium BGP.
High-performance network.
| | CN2 | China Telecom CN2 network. | | PathBasedBandwidthIP | Path-based bandwidth IP. | | LocalLine | Provided by a local ISP. | | StandardBGP |Standard BGP.
General-purpose network with optimized cost.
| | CMI | 1-Line IP China Mobile. | | CUG | 1-Line IP China Unicom. | | CTG | 1-Line IP China Telecom. | ## PriceCategory Describes the price type. Referenced by：InquiryPriceCreateLoadBalancer | Value | Description | | ---------- | --------------- | | STANDARD | Standard price. | | CUSTOMIZED | Fixed price. | ## PriceItem Pricing information. Referenced by：InquiryPriceCreateLoadBalancer | 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](#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 | [PriceCategory](#pricecategory) | The category to which the price belongs. | ## RateLimitMode Rate limit mode of the QoS policy group. Referenced by：AssignLoadBalancerIpv6 | Value | Description | | ------ | -------------------------------------------------------------------- | | LOOSE | Loose mode: short-time bursts exceeding the limit are allowed. | | STRICT | Strict mode: the limit is strictly enforced and no burst is allowed. | ## Region Information on regions. Referenced by：DescribeLoadBalancerRegions | Parameter Name | Type | Description | | -------------- | ------ | --------------------------------------------- | | regionId | String | Region available for purchase. | | 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 | Parameter Name | Type | Description | | ----------------- | ------ | -------------------- | | resourceGroupId | String | Resource group ID. | | resourceGroupName | String | Resource group name. | ## StepPrice Describe a tier of the tiered price . Referenced by：InquiryPriceCreateLoadBalancer | 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. | ## Tag Information on a tag, including its key and value. Referenced by：CreateLoadBalancer, DescribeLoadBalancers | Parameter Name | Type | Required | Description | | -------------- | ------ | -------- | -------------------------------------------- | | 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 | Parameter Name | Type | Required | Description | | -------------- | -------------------- | -------- | ------------- | | tags | Array of [Tag](#tag) | Yes | List of tags. | ## Tags Information on tags, including their keys and values. Referenced by：DescribeLoadBalancers | Parameter Name | Type | Description | | -------------- | -------------------- | ------------- | | tags | Array of [Tag](#tag) | List of tags. |