SoftLayer Network LoadBalancer Service (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Network_LoadBalancer_Service data type. For information on the SoftLayer_Network_LoadBalancer_Service service please see SoftLayer_Network_LoadBalancer_Service.
Contents |
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.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
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
- Length: 47 characters
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
- Length: 22 digits
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.
| Type | Valid Health Checks |
|---|---|
| HTTP | HTTP, TCP, ICMP |
| TCP | HTTP, TCP, ICMP |
| FTP | TCP, ICMP |
| DNS | DNS, ICMP |
| UDP | None |
- Type: string
- Length: 5 characters
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
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
- Length: 4000 characters
peakConnections
Peak historical connections since the creation of this service. Is reset any time you make a configuration change
- Type: integer
- Length: 22 digits
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
- Length: 22 digits
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
- Length: 5 characters
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
- Length: 22 digits
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
- Length: 22 digits
Relational Properties
vip
The load balancer that this service belongs to.
vip can be queried by object mask.
vip must be a unique value.
