Skip to content

High Availability for Endpoints

Configuring Load Balancing Endpoints

WSO2 API Manager provides configuring load balancing endpoints through the API Publisher.

To configure load balancing endpoints go to the edit view of the API and navigate to the Endpoint tab and expand the Load balance and Failover Configurations.

load-balance-and-fail-over

Select the Load Balanced from the endpoint type drop-down. load-balanced

Following are the other configurations that you need to do in order to specify a load balancing endpoint.

Click on the cogwheel icon to setting up session timeout

Production Endpoints

The set of production endpoints can be specified here where the requests need to be load balanced. You can specify more than one endpoint by clicking on "+" sign and can delete the endpoints by clicking on bin icon once you added an endpoint.

Sandbox endpoints The set of sandbox endpoints can be specified here where te requests need to be load balanced. You can specify more than one endpoint by clicking on "+" sign and can delete the endpoints by clicking on bin icon.
Algorithm

The load balancing algorithm is specified here.

Click on the cogwheel icon to setting up algorithm

The default is Round Robin Algorithm which has the className of org.apache.synapse.endpoints.algorithms.RoundRobin . If you select other from the dropdown list of Algorithms you need to specify the class name of the algorithm. Class names of other algorithms can be found here .

Session Management

Click on the cogwheel icon to setting up session management

A session management method from the load balancing group. The possible values are as follows.

None - If this is selected, session management is not used.

Transport - If this is selected, session management is done on the transport level using HTTP cookies.

SOAP - If this is selected, session management is done using SOAP sessions.

Client ID - If this is selected, session management is done using an ID sent by the client.

Session Timeout The number of milliseconds after which the session would time out.

load-balanced

After completing the configuration click on save.

Configuring Failover Group of Endpoints

WSO2 API Manager provides configuring failover group endpoints through the API Publisher.

To configure failover endpoints go to the edit view of the API and navigate to the Endpoint tab and click Failover under endpoint type by expanding Load balance and Failover Configurations.

failover

At least one failover endpoint needs to be added for production and sandbox (if you have specified) Endpoints.

You can specify more than one endpoint by clicking on "+" sign and can delete the endpoints by clicking on bin icon.

failover

After completing the adding endpoints, click on save.

Top