Retrieving one or all GSLB service region 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 »
REST Syntax
Click to view all REST Resources |
REST/GSLBRegionPoolEntry/ GET — Retrieves information for one or all GSLB region pool resources from the zone or node indicated.
HTTP Action — GET
URIs:
Get one GSLB Region Pool Entry: https://api.dynect.net/REST/GSLBRegionPoolEntry/<zone>/<fqdn>/<region_code>/<address>/
Get all GSLB Region Pool Entries: https://api.dynect.net/REST/GSLBRegionPoolEntry/<zone>/<fqdn>/<region_code>/ |
Arguments:
Get one GSLB Region Pool Entry: No Arguments.
Get all GSLB Region 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 — (default) The list of service resources is returned. |
Response:
Get one GSLB Region Pool Entry — Click for More Info
- string
address — The IP address or FQDN of this Node IP.
- string
region_code — Name of the region.
Valid values:
US West
US Central
US East
EU West
EU Central
EU East
Asia
global
- 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 when this log entry was generated.
- string
site_code — The airport code of the monitoring site that generated this log entry.
- string
fqdn — Name of the node where the service exists.
- string
zone — Name of the zone where the service exists.
Get all GSLB Region Pool Entries: array — Individual GSLB service region pool resources. |
SOAP Syntax
Click to view all SOAP Commands |
GetOneGSLBRegionPoolEntry — Retrieve a single entry from a Global Server Load Balancing service region pool.
GetGSLBRegionPoolEntries — Retrieve all entries from a GSLB service region pool. |
Arguments:
GetOneGSLBRegionPoolEntry — Click for More Info
string address — Required. The IP address or FQDN of the node IP.
string region_code — Required. Name of the region.
Valid values:
US West
US Central
US East
EU West
EU Central
EU East
Asia
global
string fqdn — Required. Name of the node where the service exists.
string token — Required. The session identifier.
string zone — Required. Name of the zone where the service exists.
GetGSLBRegionPoolEntries — Click for More Info
string region_code — Required. Name of the region.
Valid values:
US West
US Central
US East
EU West
EU Central
EU East
Asia
global
string fqdn — Required. Name of the node where the service exists.
string token — Required. The session identifier.
string zone — Required. Name of the zone where the service exists.
|
Response:
GetOneGSLBRegionPoolEntry — Click for More Info
- hash
data
- string
address The IP address or FQDN of this Node IP.
- string
region_code — Name of the region.
Valid values:
US West
US Central
US East
EU West
EU Central
EU East
Asia
global
- 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 when this log entry was generated.
- string
site_code — The airport code of the monitoring site that generated this log entry.
- string
zone — Name of the zone where the service exists.
- string
fqdn — Name of the node where the service exists.
GetGSLBRegionPoolEntries — Click for More Info
- array
data
- string
address The IP address or FQDN of this Node IP.
- string
region_code — Name of the region.
Valid values:
US West
US Central
US East
EU West
EU Central
EU East
Asia
global
- 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 when this log entry was generated.
- string
site_code — The airport code of the monitoring site that generated this log entry.
- string
zone — Name of the zone where the service exists.
- string
fqdn — Name of the node where the service exists.
|
Example Request (GetOneGSLBRegionPoolEntry) — Click for More Info
{
'zone' => 'example.com',
'fqdn' => 'example.com',
'token' => 'asdlj34ot879834cdzjklfK',
'region_code' => 'US East',
'address' => '1.2.3.4',
}
|
Example Request (GetGSLBRegionPoolEntries) — Click for More Info
{
'zone' => 'example.com',
'fqdn' => 'example.com',
'token' => 'asdlj34ot879834cdzjklfK',
'region_code' => 'US East',
}
|
<< DNS API Knowledge Base