SoftLayer_Network_LoadBalancer_Service::getStatus

Returns various status entries for this service as an array of SoftLayer_Container_Network_LoadBalancer_StatusEntry objects

Description

Returns an array of SoftLayer_Container_Network_LoadBalancer_StatusEntry objects. A SoftLayer_Container_Network_LoadBalancer_StatusEntry object has two variables, “Label” and “Value”

Calling this function executes a command on the physical load balancer itself, and therefore should be called infrequently. For a general idea of the load balancer service, use the “peakConnections” variable on the Type

Possible values for “Label” are:

• IP Address
• Port
• Server Status
• Load Status
• Current Connections
• Total Hits

Not all labels are guaranteed to be returned.

Parameters

None

Required Headers

• Authenticate
• SoftLayer_Network_LoadBalancer_ServiceInitParameters

Optional Headers

• None

Return Values

• SoftLayer_Container_Network_LoadBalancer_StatusEntry[]

Error Handling

• Throw the exception “Bad data received from load balancer, no status could be determined.” If no data could be retrieved from the load balancer

REST Example

curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/getStatus'