Layer7 API Management

Loadbalancer Status Service - V1.0.xml 

11-17-2017 02:25 AM

Service Description: Load Balancer Status Service



Service name: Load Balancer Status Service

Version: 1.0

Date: 02 Nov 2017

Short description: Sends back a status response configured for each node in the cluster so the load balancer behavior can be controlled from the gateway.


Use Case

To meet availability and/or performance requirements, the CA API Gateway can be implemented in a cluster with multiple gateway nodes. As part of the cluster setup, an external load balancer must be configured to direct traffic to the different nodes in the cluster.


In general, a load balancer will check each node for health in combination with a manual configuration to decide if it should send traffic to a node. Most load balancers recognize 3 statuses: healthy, drain and unavailable, which can be either manually configured by the load balancer administrator or automatically triggered by the load balancer based on node status. A healthy node can receive traffic, drain means that existing session can be completed but no new sessions should be sent to a node while an unavailable node should not receive any traffic from the load balancer.


Because the load balancer is usually not maintained by the API Gateway administrators, it will require involvement of an additional person, the load balancer administrator, when doing maintenance with downtime on the cluster nodes. However, if a load balancer supports determining node status based on the content of a http response from each node, a service can be used to control the status on the load balancer. This way an API Gateway administrator can do maintenance on cluster nodes without the need to involve the load balancer administrator.



This service can be used to provide a http response for a health check from a load balancer. By default, it will return a http 200 response code with a plain text message which can be either OK, DRAIN or OFFLINE, depending on the setting which was selected in the policy.



The full documentation with implementation instructions can be found here: Loadbalancer Status Service - V1.0.pdf

0 Favorited
1 Files
zip file
Loadbalancer Status Service -   1 KB   1 version
Uploaded - 05-29-2019

Tags and Keywords


08-21-2018 01:31 PM

That's perfect, thank you so much Michiel. :-)

08-21-2018 04:21 AM

Hi Dustin,


Thanks for the note. I had actually posted the documentation as a separate document here Loadbalancer Status Service - V1.0.pdf, but never linked to it from here. I have only linked to both from one post Load Balancer Status Service. I have just updated this and the documentation post to include links to the related content. I hope it will be more useful this way.




08-20-2018 10:59 AM

Hi MichielHelder,


I'm just running back through some items that have been added to our policy repository for easy access by users, and I realized this one doesn't have much context to it. I think this would be much more helpful to the community if it had a summary for it which could contain information such as what problem this service policy attempts to solve or assist with, brief notes on how to utilize it, etc. It's fair to call out too that comments are in the policy, if applicable.


Would you mind updating this document to reflect the additional details? This would make it much easier for users searching for a solution to a problem in the community, as they will hopefully be able to find it sooner. It'd be a huge help if you can kindly add the additional information to this document.


Thank you, Michiel.

Related Entries and Links

No Related Resource entered.