Get one or more Load Balance pool resources using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
Understanding How The API Works »
NOTE: The Load Balance Service is deprecated. Legacy users of the service should contact Concierge for any questions on adding a Load Balance service to your zone. All other users should use the GSLB service instead. |
REST Syntax
Click to view all REST Resources |
/REST/LoadBalancePoolEntry/ GET — Retrieve one or more Load Balance service pool entries.
HTTP Action — GET
URIs:
Get One Pool Entry — https://api.dynect.net/REST/LoadBalancePoolEntry/<zone>/<fqdn>/<address>
Get all Pool Entries — https://api.dynect.net/REST/LoadBalancePoolEntry/<zone>/<fqdn>/
|
Arguments:
Get One Pool Entry — No Arguments.
Get all Pool Entries — string detail — A boolean indicating whether or not to return the full details or a list of service resources.
Valid values:
Y — The details of each service are specified.
N — The list of service resources is returned. Default
|
Response:
Get One Pool Entry — Click for More Info
- string
address — The IP address or FQDN of the Node IP
- string
label — A descriptive string describing this IP
- string
weight — A number from 1-15 describing how often this record should be served. Higher means more
- string
serve_mode — Sets the behavior of this particular record.
Valid values:
always – Always serve this IP address
obey – Serve this address based upon its monitoring status
remove – Serve this address based upon its monitoring status. However, if it goes down, don’t automatically bring it back up when monitoring reports it up.
no – Never serve this IP address
- string
status — The current state of the Node IP.
Valid values:
unk – The state of the IP address is not yet known
up – The IP address is up
down – The IP address is down
- array
log — Recent monitoring logs for this IP.
- string
status — The state of the Node IP at the time of the log entry.
Valid values:
unk – The state of the IP address is not yet known
up – The IP address is up
down – The IP address is down
- string
message — If status is ‘down’, an error message explaining the failure
- string
time — The time or probe interval that this log entry was generated at.
- string
site_code — The airport code of the monitoring site that generated this log entry.
- string
fqdn — Name of node where the service will exist.
- string
zone — Name of the zone where the service will exist.
Get all Pool Entries — array of Individual Load Balance service pool resources.
|
SOAP Syntax
Click to view all SOAP Commands |
GetOneLoadBalancePoolEntry — Retrieves an entry from the identified Load Balancing service pool.
GetLoadBalancePoolEntries — Retrieves all entries from the identified Load Balancing service pool.
|
Arguments:
GetOneLoadBalancePoolEntry:
- string
address — Required. The IP address or FQDN of the Node IP
- string
fqdn — Required. Name of node where the service exists.
- string
token — Required. The session identifier.
- string
zone — Required. Name of the zone where the service exists.
GetLoadBalancePoolEntries:
- string
fqdn — Required. Name of node where the service exists.
- string
token — Required. The session identifier.
- string
zone — Required. Name of the zone where the service exists.
|
Response:
GetOneLoadBalancePoolEntry — Click for More Info
- hash
data
- string
address — The IP address or FQDN of the Node IP
- string
label — A descriptive string describing this IP
- string
weight — A number from 1-15 describing how often this record should be served. Higher means more
- string
serve_mode — Sets the behavior of this particular record.
Valid values:
always – Always serve this IP address
obey – Serve this address based upon its monitoring status
remove – Serve this address based upon its monitoring status. However, if it goes down, don’t automatically bring it back up when monitoring reports it up.
no – Never serve this IP address
- string
status — The current state of the Node IP.
Valid values:
unk – The state of the IP address is not yet known
up – The IP address is up
down – The IP address is down
- array
log — Recent monitoring logs for this IP.
- string
status — The state of the Node IP at the time of the log entry.
Valid values:
unk – The state of the IP address is not yet known
up – The IP address is up
down – The IP address is down
- string
message — If status is ‘down’, an error message explaining the failure
- string
time — The time or probe interval that this log entry was generated at.
- string
site_code — The airport code of the monitoring site that generated this log entry.
- string
fqdn — Name of node where the service will exist.
- string
zone — Name of the zone where the service will exist.
GetLoadBalancePoolEntries — Click for More Info
- array
data
- string
address — The IP address or FQDN of the Node IP
- string
label — A descriptive string describing this IP
- string
weight — A number from 1-15 describing how often this record should be served. Higher means more
- string
serve_mode — Sets the behavior of this particular record.
Valid values:
always – Always serve this IP address
obey – Serve this address based upon its monitoring status
remove – Serve this address based upon its monitoring status. However, if it goes down, don’t automatically bring it back up when monitoring reports it up.
no – Never serve this IP address
- string
status — The current state of the Node IP.
Valid values:
unk – The state of the IP address is not yet known
up – The IP address is up
down – The IP address is down
- array
log — Recent monitoring logs for this IP.
- string
status — The state of the Node IP at the time of the log entry.
Valid values:
unk – The state of the IP address is not yet known
up – The IP address is up
down – The IP address is down
- string
message — If status is ‘down’, an error message explaining the failure
- string
time — The time or probe interval that this log entry was generated at.
- string
site_code — The airport code of the monitoring site that generated this log entry.
- string
fqdn — Name of node where the service will exist.
- string
zone — Name of the zone where the service will exist.
|
Example Request (GetOneLoadBalancePoolEntry) — Click for More Info
{
'zone' => 'example.com',
'fqdn' => 'somehost.example.com',
'token' => 'asdlj34ot879834cdzjklfK',
'address' => '1.2.3.4',
}
Example Request (GetLoadBalancePoolEntries) — Click for More Info
{
'zone' => 'example.com',
'fqdn' => 'somehost.example.com',
'token' => 'asdlj34ot879834cdzjklfK',
}
|
<< DNS API Knowledge Base