Docs
ulb
Network Load Balancer NLB
Operation Guide
Listeners
Listeners Management

Listener Management

Creating a TCP Listener

  1. Login to the Network Load Balancer NLB console.

  2. At the top bar of the navigation, choose the region the NLB instance belongs to.

  3. Choose one of the following ways to open the listener config.

    • On the Instance list page, click Listener Management in the Actions column of the target instance.
    • On the Instance list page, click the target instance ID or details. On the Listener Management tab, click Add.
  4. On the Create Listener page, complete the following configurations and then click Confirm.

ConfigurationDescription
ProtocolChoose a load balancing protocol, this example selects the UDP protocol
PortSupports full port listening and single port listening
Full Port
Choose whether to turn on the full port function. After enabling the full port function, you only need to enter the port range, and NLB can listen to all ports of the listening port range, and directly forward the requests received on the listening port to the corresponding port of the backend server.
Listening Port
Enter the listening port, the listening port for receiving requests and forwarding them to the backend server
Load Balancing AlgorithmChoose a load balancing algorithm
1. Round-robin: After receiving new TCP connections, it is given to each backend service node in turn
2. Weighted round-robin: After receiving a new TCP connection, it will be distributed to each service node according to the different weights you specify for the backend service nodes
3. Original address hashing: Choose backend service nodes based on the source and destination IPs, using the results of consistent hashing algorithm
4. Least Connections: After receiving new TCP connections, it will count the number of connections from the CLB to the backend service nodes in real time, choose the service node with the smallest number of connections to establish a new connection and send data
5. Weighted least connections: According to the weighting set for each backend server, polling is done, and at the same time the number of connections of the backend server is taken into account
Service Session PersistenceChoose whether to open or close session persistence. By default, NLB will distribute each client request to different backend servers separately. Once you activate the session persistence function, session persistence can enable requests from the same client to be forwarded to the same backend server, making it easier for backend servers to maintain status information and provide continuous services to clients
Node Health CheckThis article selects the TCP protocol and only supports port check. Perform health check using the backend server’s port. After enabling full port forwarding, you must specify a specific port for the health check port
Listener NameDefine the name of the listener
DescriptionCustomize the remark information of the listener

Creating a UDP Listener

  1. Login to the Network Load Balancer NLB console.
  2. At the top bar of the navigation, choose the region the NLB instance belongs to.
  3. Choose one of the following ways to open the listener config.
    • On the Instance list page, click Listener Management in the Actions column of the target instance.
    • On the Instance list page, click the target instance ID or details. On the Listener Management tab, click Add.
  4. On the Create Listener page, complete the following configurations and then click Confirm.
ConfigurationDescription
ProtocolChoose a load balancing protocol, this example selects the UDP protocol
PortSupports full port listening and single port listening
Full Port
Supports full port listening and single port listening, decide whether to enable the full port feature. After enabling the full port function, you only need to enter the port range, and NLB can listen to all ports of the listening port range, and directly forward the requests received on the listening port to the corresponding port of the backend server.
Listening Port
Enter the listening port, the listening port for receiving requests and forwarding them to the backend server
Load Balancing AlgorithmChoose a load balancing algorithm
1. Round-robin: After receiving new UDP connections, it is given to each backend service node in turn
2. Weighted round-robin: After receiving a new UDP connection, it will be distributed to each service node according to the different weights you specify for the backend service nodes.
3. Original address hashing: Choose backend service nodes based on the source and destination IPs, using the results of consistent hashing algorithm
4. Least Connections: After receiving new UDP connections, it will count the number of connections from the CLB to the backend service nodes in real time, choose the service node with the smallest number of connections to establish a new connection and send data.
5. Weighted least connections: According to the weighting set for each backend server, polling is done, and at the same time the number of connections of the backend server
Service Session PersistenceChoose whether to open or close session persistence. By default, NLB will distribute each client request to different backend servers separately. Once you have started the session persistence function, session persistence can enable requests from the same client to be forwarded to the same backend server, making it easier for the backend server to maintain status information and provide continuous services
Node Health CheckThis article selects the UDP protocol
Port check: Use the backend server’s port to conduct a health check. After enabling full port forwarding, you must specify a specific port for health check port
Ping check: Detect backend node connectivity using Ping.
UDP check: Send UDP request message to the service node, and judge whether the node is normal according to the set message
Listener NameCustomize the listener’s name
DescriptionCustomize the remark information of the listener

Modifying Listener

  1. Login to the Application Load Balancer NLB console.
  2. In the top navigation bar, choose the region the NLB instance belongs to.
  3. On the NLB list page, find the target NLB instance, click on the instance ID to enter the instance details page.
  4. Click Listener Management, find the target listener, choose one of the following methods to modify listener basic information.
    1. Click the target listener, in the Listener Details tab’s Basic Information area, click Change Configuration.
    2. In the left side listener list, choose the listener that needs to be edited, click the edit button on the top right corner to enter the editing page.
  5. In the Edit Listener pop-up window, you can modify the listener configuration information according to business needs, then click Confirm to complete the modification of the listener.

Deleting Listener

  1. Login to the Application Load Balancer NLB console.
  2. In the top menu bar, choose the region the NLB instance belongs to.
  3. On the NLB Instance page, find the target NLB instance, click on the instance ID.
  4. Click on the Listener Management tab, find the target listener, then choose Delete in the upper right corner.
  5. In the pop-up delete listener window, click Confirm.