SoftLayer Network LoadBalancer Service::getStatus

From SoftLayer Development Network Wiki

getStatus is a member of the SoftLayer_Network_LoadBalancer_Service service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 3.2 Optional Headers 4 Error Handling

Overview

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.

Return Type

getStatus returns the SoftLayer_Container_Network_LoadBalancer_StatusEntryArray data type.

Headers

Required Headers

getStatus requires the following headers:

• authenticate
• SoftLayer_Network_LoadBalancer_ServiceInitParameters

Optional Headers

getStatus may use the following headers:

• SoftLayer_Network_LoadBalancer_ServiceObjectMask

Error Handling

getStatus throws the following exceptions:

• SoftLayer_Exception_Public

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