Modifying a Listener

Function

This API is used to modify the listener information, including the listener name, description, and status.

URI

PUT /v1.0/{project_id}/elbaas/listeners/{listener_id}

Request

• Request parameters

  None

• Example request

  {
      "name": "lis",
      "description": "",
      "port": 9090,
      "backend_port": 9090,
      "lb_algorithm": "roundrobin"
  }

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 in UUID format.
  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. This parameter is invalid when protocol is set to TCP or UDP, which means that the parameter is unavailable or its value is set to null.
  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. 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.
  healthcheck_id	String	Specifies the health check ID.
  session_sticky	Boolean	Specifies whether to enable the sticky session feature. The feature is enabled when the value is true. This parameter is valid only when protocol is set to HTTP.
  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. The unit is minute. This parameter is valid when protocol is set to TCP and tcp_draining to true. The value ranges from 0 to 60.
  certificate_id	String	Specifies the ID of the SSL certificate for security authentication. This parameter is mandatory when protocol is set to HTTPS. Otherwise, the parameter value is null.

• Example response

  {
      "update_time": "2016-12-01 07:12:59",
      "backend_port": 9090,
      "id": "a824584fb3ba4d39ba0cf372c7cbbb67",
      "backend_protocol": "TCP",
      "sticky_session_type": null,
      "certificate_id": null,
      "description": "",
      "loadbalancer_id": "f54c65b1b5dd4a4f95b71b44796ac013",
      "create_time": "2016-12-01 07:12:43",
      "admin_state_up": false,
      "status": "ACTIVE",
      "protocol": "TCP",
      "cookie_timeout": 100,
      "port": 9092,
      "tcp_draining": true,
      "tcp_timeout": 1,
      "lb_algorithm": "roundrobin",
      "healthcheck_id": null,
      "session_sticky": true,
      "tcp_draining_timeout": 5,
      "name": "lis"
  
  }

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.