CreateLoadBalancerListener

Creates a load balancer listener. For example,
CreateLoadBalancerListener name=lblistener loadBalancerUuid=bad56001c1f24cefa085fa9cf83f6424\
loadBalancerPort=22 instancePort=23

Parameters

Name Description Optional Valid Value Starting Version
loadBalancerUuid The UUID of the load balancer listener. 0.6
certificateUuid 2.3
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
  • tcp
  • http
  • https
  • udp
 0.6
resourceUuid The resource UUID. Yes 0.6
instancePort Yes 3.9.0
healthCheckProtocol The health check protocol. Yes
  • tcp
  • udp
  • http
 3.9.0
healthCheckMethod The health check method. Yes
  • GET
  • HEAD
 3.9.0
healthCheckURI The health check URI. Yes 3.9.0
healthCheckHttpCode The expected response code of the health code. Yes 3.9.0
aclStatus The access control status. Yes
  • enable
  • disable
 3.9.0
aclUuids The access control list. Yes 3.9.0
aclType The access control type. Yes
  • white
  • black
 3.9.0
tagUuids The tag UUID list. Yes 3.9.0
userTags The user tags. For more information, see CreateUserTag. The resource type is LoadBalancerListenerVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type LoadBalancerListenerVO. Yes 0.6
timeout Yes
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}