Network
SoftLayer_Network_LoadBalancer_Global_Host

Overview

The SoftLayer_Network_LoadBalancer_Global_Host data type represents a single host that belongs to a global load balancer account's load balancing pool.

The destination IP address of a host must be one that belongs to your SoftLayer customer account, or to a datacenter load balancer virtual ip that belongs to your SoftLayer customer account. The destination IP address and port of a global load balancer host is a required field and must exist during creation and can not be removed. The acceptable values for the health check type are 'none', 'http', and 'tcp'. The status property is updated in 5 minute intervals and the hits property is updated in 10 minute intervals.

The order of the host is only important if you are using the 'failover' load balance method, and the weight is only important if you are using the 'weighted round robin' load balance method.

Local Properties

destinationIp

The IP address of the host that will be returned by the global load balancers in response to a dns request.

Type:

string

destinationPort

The port of the host that will be used for health checks.

Type:

integer

enabled

Whether the host is enabled or not. The value can be '0' for disabled, or '1' for enabled.

Type:

integer

healthCheck

The health check type of a host. Valid values include 'none', 'http', and 'tcp'.

Type:

string

hits

The number of times the host was selected by the load balance method.

Type:

float

id

The unique identifier of a global load balancer host.

Type:

integer

loadBalanceOrder

The order of this host within the load balance pool. This is only significant if the load balance method is set to failover.

Type:

integer

location

The location of a host in a datacenter.serverRoom format.

Type:

string

status

The health status of a host. The status can be either 'UP', 'DOWN', or null which could mean that the health check type is set to 'none' or an update to the ip, port, or health check type was recently done and the host is waiting for the new status.

Type:

string

weight

The load balance weight of a host. The total weight of all hosts in the load balancing pool must not exceed 100.

Type:

integer

Relational & Count Properties

Relational Properties can be queried by object mask
loadBalancerAccount

The global load balancer account a host belongs to.