SoftLayer Network LoadBalancer VirtualIpAddress (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Network_LoadBalancer_VirtualIpAddress data type. For information on the SoftLayer_Network_LoadBalancer_VirtualIpAddress service please see SoftLayer_Network_LoadBalancer_VirtualIpAddress.
Contents |
Overview
The SoftLayer_Network_LoadBalancer_VirtualIpAddress data type contains all the information relating to a specific load balancer assigned to a customer account.
Information retained on the object itself is the virtual IP address, load balancing method, and any notes that are related to the load balancer. There is also an array of SoftLayer_Network_LoadBalancer_Service objects, which represent the load balancer services, explained more fully in the SoftLayer_Network_LoadBalancer_Service documentation.
User Access
Users wishing to access the SoftLayer_Network_LoadBalancer_VirtualIpAddress type must have the Manage Load Balancers permission assigned to their account.
| 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
connectionLimit
Connection limit on this VIP. Can be upgraded through the upgradeConnectionLimit() function
- Type: integer
- Length: 22 digits
id
Unique ID for this object, used for the getObject method, and must be set if you are editing this object.
- Type: integer
loadBalancingMethod
The load balancing method that determines which server is used "next" by the load balancer. The method is stored in an abbreviated form, represented in parentheses after the full name. Methods include: Round Robin (Value "rr"): Each server is used sequentially in a circular queue Shortest Response (Value "sr"): The server with the lowest ping at the last health check gets the next request Least Connections (Value "lc"): The server with the least current connections is given the next request Persistent IP - Round Robin (Value "pi"): The same server will be returned to a request during a users session. Servers are chosen through round robin. Persistent IP - Shortest Response (Value "pi-sr"): The same server will be returned to a request during a users session. Servers are chosen through shortest response. Persistent IP - Least Connections (Value "pi-lc"): The same server will be returned to a request during a users session. Servers are chosen through least connections. Insert Cookie - Round Robin (Value "ic"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through round robin. Insert Cookie - Shortest Response (Value "ic-sr"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through shortest response. Insert Cookie - Least Connections (Value "ic-lc"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through least connections.
- Type: string
- Length: 4000 characters
loadBalancingMethodFullName
A human readable version of loadBalancingMethod, intended mainly for API users.
- Type: string
modifyDate
Date this load balancer was last modified
- Type: dateTime
notes
User-created notes on this load balancer.
- Type: string
- Length: 4000 characters
virtualIpAddress
The virtual, public-facing IP address for your load balancer. This is the address of all incoming traffic
- Type: string
- Length: 47 characters
Relational Properties
account
The account that owns this load balancer.
account can be queried by object mask.
account must be a unique value.
- Type: SoftLayer_Account
billingItem
The current billing item for the Load Balancer.
billingItem can be queried by object mask.
billingItem must be a unique value.
- Type: SoftLayer_Billing_Item
services
the services on this load balancer.
services can be queried by object mask.
Count Properties
serviceCount
A count of the services on this load balancer.
serviceCount must be a unique value.
- Type: unsigned long
