Network
SoftLayer_Network_LoadBalancer_Service

Overview

The SoftLayer_Network_LoadBalancer_Service data type contains all the information relating to a specific service (destination) on a particular load balancer.

Information retained on the object itself is the the source and destination of the service, routing type, weight, and whether or not the service is currently enabled.

Local Properties

connectionLimit

Connection limit on this service.

Type:

integer

createDate

Creation Date of this service

Type:

dateTime

destinationIpAddress

The IP Address of the real server you wish to direct traffic to. Your account must own this IP

Type:

string

destinationPort

The port on the real server to direct the traffic. This can be different than the source port. If you wish to obfuscate your HTTP traffic, you can accept requests on port 80 on the load balancer, then redirect them to port 932 on your real server.

Type:

integer

enabled

A flag (either true or false) that determines if this particular service should be enabled on the load balancer. Set to false to bring the server out of rotation without losing your configuration

Type:

boolean

healthCheck

The health check type for this service. If one is supplied, the load balancer will occasionally ping your server to determine if it is still up. Servers that are down are removed from the queue and will not be used to handle requests until their status returns to "up". The value of the health check is determined directly by what option you have selected for the routing type.

{|
  -
  HTTP
  HTTP, TCP, ICMP
  TCP
  HTTP, TCP, ICMP
  FTP
  TCP, ICMP
  DNS
  DNS, ICMP
  UDP
  None
  }

Type:

string

healthCheckURL

The URL provided here (starting with /) is what the load balancer will request in order to perform a custom HTTP health check. You must specify either "GET /location/of/file.html" or "HEAD /location/of/file.php"

Type:

string

healthResponse

The expected response from the custom HTTP health check. If the requested page contains this response, the check succeeds.

Type:

string

id

Unique ID for this object, used for the getObject method, and must be set if you are editing this object.

Type:

integer

modifyDate

Last modification date of this service

Type:

dateTime

name

Name of the load balancer service

Type:

string

notes

Holds whether this server is up or down. Does not affect load balancer configuration at all, just for the customer's informational purposes

Type:

string

peakConnections

Peak historical connections since the creation of this service. Is reset any time you make a configuration change

Type:

integer

sourcePort

The port on the load balancer that this service maps to. This is the port for incoming traffic, it needs to be shared with other services to form a group.

Type:

integer

type

The connection type of this service. Valid values are HTTP, FTP, TCP, UDP, and DNS. The value of this variable affects available values of healthCheck, listed in that variable's description

Type:

string

vipId

Unique ID for this object's parent. Probably not useful in the API, as this object will always be a child of a VirtualIpAddress anyway.

Type:

integer

weight

Weight affects the choices the load balancer makes between your services. The weight of each service is expressed as a percentage of the TOTAL CONNECTION LIMIT on the virtual IP Address. All services draw from the same pool of connections, so if you expect to have 4 times as much HTTP traffic as HTTPS, your weights for the above example routes would be 40%, 40%, 10%, 10% respectively. The weights should add up to 100% If you go over 100%, an exception will be thrown. Weights must be whole numbers, no fractions or decimals are accepted.

Type:

integer

Relational & Count Properties

Relational Properties can be queried by object mask
vip

The load balancer that this service belongs to.