CreateLoadBalancerListener

Creates a load balancer listener. For example,

CreateLoadBalancerListener loadBalancerUuid=192b3fe960d63e078ced8f59529a25ad name=Test-Listener loadBalancerPort=80

Parameters

Name	Description	Optional	Valid Value	Starting Version
loadBalancerUuid	The UUID of the load balancer listener.			0.6
name	The name of the load balancer listener.			0.6
description	The detailed description of the load balancer listener.	Yes		0.6
instancePort	The VM instance port.	Yes		0.6
loadBalancerPort	The load balancer port.			0.6
protocol	The protocol.	Yes	udp tcp http https	3.0
certificateUuid	The certificate UUID.	Yes		2.3
healthCheckProtocol	The health check protocol.	Yes	tcp udp http https none	3.9
healthCheckTarget	The health check port. The value default indicates that the backend server port is used.	Yes		5.5.38
healthCheckTimeout	The health check timeout.	Yes		5.5.38
healthCheckMethod	The health check method.	Yes	GET HEAD	3.9
healthCheckURI	The health check URI.	Yes		3.9
healthCheckHttpCode	The expected response code of the health code.	Yes		3.9
aclStatus	The access control status.	Yes	enable disable	3.9
aclUuids	The access control list.	Yes		3.9
aclType	The access control type.	Yes	white black	3.9
dataPlane	The data plane used by the listener. Default: haproxy. The value ipvs is only allowed for TCP listeners. This parameter cannot be modified after creation.	Yes	haproxy ipvs	5.5.28
forwardMode	Only for TCP listeners with dataPlane set to ipvs. Valid values: full_nat, nat, and dr. Default: full_nat. This parameter cannot be modified after creation.	Yes	full_nat nat dr	5.5.28
securityPolicyType	The TLS security policy.	Yes	tls_cipher_policy_default tls_cipher_policy_1_0 tls_cipher_policy_1_1 tls_cipher_policy_1_2 tls_cipher_policy_1_2_strict tls_cipher_policy_1_2_strict_with_1_3	4.1
httpVersions	The Load Balancer frontend network HTTP protocol version.	Yes		5.0.0
tcpProxyProtocol	The TCP Proxy Protocol agreement.	Yes		5.0.0
httpCompressAlgos	The HTTP compression algorithm.	Yes		5.0.0
resourceUuid	The resource UUID.	Yes		0.6
tagUuids	The tag UUID list.	Yes		3.4.0
systemTags	The system tags. For more information, see CreateSystemTag. The resource type LoadBalancerListenerVO.	Yes		0.6
userTags	The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO.	Yes		0.6

Note:

When you create a load balancer listener in ZStack Cloud, you can set seven layers of health check parameters by adding the healthCheckParameter option to SystemTags.
- Format of the healthCheckParameter option: healthCheckParameter::{parameter}. Here, the parameter can be healthCheckParameter::method:uri:expect-result.
- Example: healthCheckParameter::GET:/healthstatus.html:http_2xx
When you create a load balancer listener in ZStack Cloud, you can set the access control status of the listener by adding the accessControlStatus option to SystemTags.
- Format of the accessControlStatus option: accessControlStatus::{status}
- Example: accessControlStatus::enable
When you create a load balancer listener in ZStack Cloud, you can set whether to enable the session persistence and specify the session persistence mode by adding the sessionPersistence option to SystemTags.
- Format of the sessionPersistenceoption: sessionPersistence::{%s}.. The value of %s can be disable/iphash/insert/rewrite.
- Example: sessionPersistence::insert.
When you create a load balancer listener in ZStack Cloud, you can specify the session persistence time by adding the sessionIdleTimeout option to SystemTags.
- Format of the sessionIdleTimeoutoption: sessionIdleTimeout::{%s}. Here, %s is the session persistence time. Valid value: 30-3600. Unit:second.
- Example: sessionIdleTimeout::60
When you create a load balancer listener in ZStack Cloud, you can set the rewritten cookie name by adding the cookieName option to SystemTags.
- Format of the validRegexValues::{%s}. Here, %s is the cookie name. The name must be 1 to 20 characters and can contain uppercase or lowercase letters, digits, hyphens (-), and underscores (_).
- Example: cookieName::zstack-cookie.
When you create a load balancer listener in ZStack Cloud, you can set whether to enable http redirect by adding the httpRedirectHttps option to SystemTags.
- Format of the httpRedirectHttps::{%s}. Here, the value of %s can be disable/enable.
- Example: httpRedirectHttps::enable
When you create a load balancer listener in ZStack Cloud, you can set redirect port by adding redirectPort option to SystemTags.
- Format of the redirectPort::{%s}. Here, the number range of %s can be 1-65535.
- Example: redirectPort::80
When you create a load balancer listener in ZStack Cloud, you can set redirect status code by adding statusCode optional to SystemTags.
- Format of the statusCode::{%s}. Here, the value of %s can be 301/302/303/307/308.
- Example: statusCode::302

PreviousRefreshLoadBalancer NextDeleteLoadBalancerListener