LoadBalancer

Distribute traffic across multiple endpoints

Table 1. Supported parameters
Parameter Required Data type Details
roundRobinHttp Yes object Use round robin on a list of HTTP endpoints
weightedRandomHttp Yes object Use round robin weighted on a list of HTTP endpoints
inputMessage No string or null The name of a message that will be used to form the request. Default input message is "request".
outputMessage No string or null The name of a message that will be used to store the response data from the request. Default input message is "response".
Table 2. Nested properties inside roundRobinHttp
Parameter Required Data type Details
endpoints Yes array List of HTTP endpoints used for round robin. Must contain a minimum of 2 items
statusException No array Throw a selected set of CatchErrorConfig errors else CatchErrorConfig of type CustomError with the response code and canonical message if the response code matches any of the listed pattern entries.
verb No string or null Verb used for the HTTP endpoints
Table 3. Nested properties inside endpoints
Parameter Required Data type Details
endpoint Yes object A single HTTP endpoint. Nested properties of endpoint are same as target.
suspendTimeout No integer Suspend timeout for this HTTP endpoint. Default is 100 seconds. Value must be greater or equal to 0.0 and lesser or equal to 86400.0
Table 4. Nested properties inside statusException
Parameter Required Data type Details
pattern Yes string 3 character pattern match for HTTP status code of 0-9 or * for any. Must match regular expression: ^[0-9\*]{3}$