Adding a Listener

Function

This API is used to add a listener to a load balancer.

URI

POST /v1.0/{project_id}/elbaas/listeners

Request

• Request parameters

  None

• Example request

  {
      "name": "listener1",
      "description": "",
      "loadbalancer_id": "0b07acf06d243925bc24a0ac7445267a",
      "protocol": "HTTP",
      "port": 88,
      "backend_protocol": "HTTP",
      "backend_port": 80,
      "lb_algorithm": "roundrobin",
      "session_sticky": true,
      "sticky_session_type": "insert",
      "cookie_timeout": 100,
      "tcp_draining": true,
      "tcp_draining_timeout": 5
  }

Response

• Response parameters

  Table 2 Parameter description

  Parameter	Type	Description
  update_time	String	Specifies the time when the listener was updated.
  backend_port	Integer	Specifies the port used by backend ECSs.
  id	String	Specifies the listener ID.
  backend_protocol	String	Specifies the protocol used by backend ECSs.
  sticky_session_type	String	Specifies where the cookie is from. The only value is insert, indicating that the cookie is inserted by the load balancer. This parameter is valid when protocol is set to HTTP and session_sticky to true.
  description	String	Provides supplementary information about the listener.
  loadbalancer_id	String	Specifies the load balancer ID.
  create_time	String	Specifies the time when the listener was created.
  status	String	Specifies the listener status. The value can be ACTIVE, PENDING_CREATE, or ERROR.
  protocol	String	Specifies the protocol used for load balancing at Layer 4 or Layer 7.
  port	Integer	Specifies the port used by the listener.
  cookie_timeout	Integer	Specifies the cookie timeout duration in the unit of minute. This parameter is valid when session_sticky is set to true and sticky_session_type to insert. The value ranges from 1 to 1440.
  admin_state_up	Boolean	Specifies the administrative status of the load balancer. Two options are available: false: The load balancer is disabled. true: The load balancer is running properly.
  session_sticky	Boolean	Specifies whether to enable the sticky session feature. The feature is enabled when the value is true.
  lb_algorithm	String	Specifies the load balancing algorithm.
  name	String	Specifies the listener name.
  tcp_draining	Boolean	Specifies whether to maintain TCP connections to a backend ECS that has been removed. This parameter is valid when protocol is set to TCP. The value can be true or false.
  tcp_draining_timeout	Integer	Specifies the timeout duration for maintaining TCP connections to a backend ECS that has been removed in the unit of minute. This parameter is valid when protocol is set to TCP and tcp_draining to true. The value ranges from 0 to 60.
  ssl_protocols	String	Specifies the supported SSL/TLS protocol version. This parameter is available only when protocol is set to HTTPS.
  ssl_ciphers	String	Specifies the cipher suite of an encryption protocol. This parameter is available only when protocol is set to HTTPS.
  certificate_id	String	Specifies the default certificate ID. This parameter is available only when protocol is set to HTTPS.

Status Code

• Normal

  200

• Error

  Status Code	Message	Description
  400	badRequest	Request error.
  401	unauthorized	Authentication failed.
  403	userDisabled	You do not have the permission to perform the operation.
  404	Not Found	The requested page does not exist.
  500	authFault	System error.
  503	serviceUnavailable	The service is unavailable.