Load Balancer
Load Balancer
Document
- Documentation
Load BalancerNetwork Load Balancer (NLB)User GuideListenersAdding a listener
Copy page
Download PDFListeners
Adding a listener
Copy pageDownload PDFAdding a listener
Scenarios
After an NLB instance is created, at least one listener must be configured to forward traffic from the client to the backend server.
Action notes
- Within the same NLB instance, TLS and TCP listeners cannot share the same port. However, both can coexist on the same port with a UDP listener.
- TCP and TLS listeners must be associated with TCP server groups, while UDP listeners require UDP server groups.
- To associate a TLS listener with a server group, the server group must meet the following requirements:
- Full port forwarding is not enabled.
- Backend protocol: TCP.
- IP version: IPv4.
Procedures
- Log in to the NLB console.
- In the top menu bar, select the target project and region.
- Click Edit listener to the right of the target NLB instance.
- Click Add listener and configure the listener as shown in the table below.
- ParametersNotesExampleListener nameEnter the listener name. If left blank, it defaults to Protocol-port, such as TCP-80.listener01Listener protocolTCPListener portEnter the listening port. The range is 1 to 65535.
- Single port listener: Enter a single port. When the listener receives a TCP request to this port, it replaces the destination IP address and port in the request with the backend server's IP address and port before forwarding to the backend server.
- Full port listening: Enter a port range. When the listener receives a TCP request on this port, it replaces the destination IP in the request with the backend server's IP address before forwarding to the backend server.
80TimeoutSet the timeout period. If no data is transferred over the connection within the timeout period, it will be automatically disabled.For TCP listeners, the timeout period ranges from 10 to 900 seconds, with a default value of 900 seconds.900 secondsNew connection rate limitWhether to enable the new connection rate limiting switch.After enabling, enter the rate limit value:- Value range: 0~1000000. 0 means no rate limit.
- When new connections captured by the listener exceed the configured threshold, excess connections will be discarded and not forwarded to the backend server.
tipThis feature is currently in Beta stage. For trial requests, please contact your account manager.30000Max connectionsWhether to enable the concurrent connection rate limiting switch.After enabling, enter the rate limit value:- Value range: 0~10000000. 0 means no rate limit.
- When concurrent connections captured by the listener exceed the configured threshold, excess connections will be discarded and not forwarded to the backend server.
tipThis feature is currently in Beta stage. For trial requests, please contact your account manager.300000TagA tag consists of a key-value pair and is used for categorizing and searching resources. Learn moreClick the Add icon, input the Tag key and Tag value, and add a tag for the listener.- Tag key: listener-key
- Tag value: listener-test
- Click Next and select a TCP protocol server group.
- Click Next to confirm the configuration information.
- Click Confirm to complete the action.
- Log in to the NLB console.
- In the top menu bar, select the target project and region.
- Click Edit listener to the right of the target NLB instance.
- Click Add listener and configure the listener as shown in the table below.
- ParametersNotesExampleListener nameEnter the listener name. If left blank, it defaults to Protocol-port, such as UDP-88.listener01Listener protocolUDPListener portEnter the listening port. The range is 1 to 65535.
- Single port listener: Enter a single port. When the listener receives a UDP request to this port, it replaces the destination IP address and port in the request with the backend server's IP address and port before forwarding to the backend server.
- Full port listening: Enter a port range. When the listener receives a UDP request on this port, it replaces the destination IP in the request with the backend server's IP address before forwarding to the backend server.
88TimeoutSet the timeout period. If no data is transferred over the connection within the timeout period, it will be automatically disabled.The timeout period for the UDP listener ranges from 10 to 120 seconds, with a default value of 20 seconds.20 secondsNew connection rate limitWhether to enable the new connection rate limiting switch.After enabling, enter the rate limit value:- Value range: 0~1000000. 0 means no rate limit.
- When new connections captured by the listener exceed the configured threshold, excess connections will be discarded and not forwarded to the backend server.
tipThis feature is currently in Beta stage. For trial requests, please contact your account manager.30000Max connectionsWhether to enable the concurrent connection rate limiting switch.After enabling, enter the rate limit value:- Value range: 0~10000000. 0 means no rate limit.
- When concurrent connections captured by the listener exceed the configured threshold, excess connections will be discarded and not forwarded to the backend server.
tipThis feature is currently in Beta stage. For trial requests, please contact your account manager.300000TagClick the Add icon, input the tag key and tag value, and add a tag for the listener.- Tag key: udplistener-key
- Tag value: udplistener-test
- Click Next and select the UDP protocol server group.
- Click Next to confirm the configuration information.
- Click Confirm to complete the action.
- Log in to the NLB console.
- In the top menu bar, select the target project and region.
- Click Edit listener to the right of the target NLB instance.
- Click Add listener and configure the parameters based on the table below.
- ParametersNotesExampleListener nameEnter the listener name. If left blank, it defaults to Protocol-port, such as TLS-80.listener01Listener protocolTLSListener portEnter the listening port. The range is 1 to 65535.
- Single port listener: Enter a single port. When the listener receives a TLS request on this port, it replaces the destination IP and port in the request with the backend server's IP address and port, then forwards the request to the backend server.
- Full port listening: Enter a port range. When the listener receives a TLS request on this port, it replaces the destination IP in the request with the backend server's IP address before forwarding to the backend server.
80TimeoutSet the timeout period. If no data is transferred over the connection within the timeout period, it will be automatically disabled.The timeout period for a TLS listener ranges from 10 to 900 seconds, with a default value of 900 seconds.900 secondsNew connection rate limitWhether to enable the new connection rate limiting switch.After enabling, enter the rate limit value:- Value range: 0~1000000. 0 means no rate limit.
- When new connections captured by the listener exceed the configured threshold, excess connections will be discarded and not forwarded to the backend server.
tipThis feature is currently in Beta stage. For trial requests, please contact your account manager.30000Max connectionsWhether to enable the concurrent connection rate limiting switch.After enabling, enter the rate limit value:- Value range: 0~10000000. 0 means no rate limit.
- When concurrent connections captured by the listener exceed the configured threshold, excess connections will be discarded and not forwarded to the backend server.
tipThis feature is currently in Beta stage. For trial requests, please contact your account manager.300000TagClick the Add icon, input the tag key and tag value, and add a tag for the listener.- Tag key: listener-key
- Tag value: listener-test
- Click Next to configure the SSL certificate.
-
- Click Next and select a TCP protocol server group.
- Click Next to confirm the configuration information.
- Click Confirm to complete the action.
What to do next
- Resolve your own domain name to the NLB domain name via CNAME, and access the NLB service through your own domain name.
- For listeners with health check enabled, confirm that their health status is Normal on the details page.
- If the health check status is Normal, the NLB configuration is complete. You can obtain the IP address of the NLB instance on the Availability Zone tab of the NLB instance details page to Verify NLB service capabilities.
- When the health check status is not Normal, please see the following for troubleshooting:
- When the health check status is No target, please Add backend servers to the server group associated with the listener.
- When the health check status is Exception, please Troubleshoot the root cause of the abnormalities.
Related documents
Last updated: 2026.08.06 14:31:17
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
