Get GSLB Regions (API) | Dyn Help Center

Retrieving one or all GSLB service regions 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.

In order for monitoring to occur on your account, please make sure the IP addresses included here (https://manage.dynect.net/help/agents.html) can reach all your network endpoints. The web page requires you to log-on to Dyn’s Managed DNS.

Understanding How The API Works »

REST Syntax

Click to view all REST Resources

REST/GSLBRegion/ GET — Retrieves information for one or all GSLB regions from the zone or node indicated.

HTTP Action — GET

URIs:

Get one GSLB Region — https://api.dynect.net/REST/GSLBRegion/<zone>/<fqdn>/<region_code>/

Get all GSLB Regions — https://api.dynect.net/REST/GSLBRegion/<zone>/<fqdn>/

Arguments:

Get one GSLB Region — No Arguments.

Get all GSLB Regions —

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 — Click for More Info

string serve_count — How many records will be returned in each DNS response.
string min_healthy — If this many addresses aren’t ‘ok’, the service will go into failover; Defaults to 1.
string failover_mode — How the region should failover. Defaults to global.
Valid values:
ip – Failover to a particular IP.
cname – Failover to a particular CNAME.
region – Failover to a particular region.
global – Failover to the global IP address pool.
string failover_data — Dependent upon failover_mode.
ip – If failover_mode is ‘ip’, this should be an IP address.
cname – If failover_mode is ‘cname’, this should be a CNAME.
region – If failover_mode is ‘region’, this should be a region_code of the failover target region.
global – If failover_mode is ‘global’, this should be empty or omitted.
string region_code — Name of the region.
Valid values:
US West
US Central
US East
EU West
EU Central
EU East
Asia
global
array pool — The IP Pool list for this region.
- string address — The IP address or FQDN of this 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 when this log entry was generated.
  - string site_code — The airport code of the monitoring site that generated this log entry.
string status — The current state of the region.
Valid values:
unk – The service state is not yet known.
ok – There are no problems with the service.
trouble – One or more node_ips are reporting down.
failover – The number of okay node_ips has fallen below failover_count. The service has failed over.

Get all GSLBs: array — Individual GSLB service region resources.

SOAP Syntax

Click to view all SOAP Commands

GetOneGSLBRegion — Retrieve information from a Global Server Load Balancing service for a single region.

GetGSLBRegions — Retrieve information from a GSLB service region pool.

Arguments:

GetOneGSLBRegion — Click for More Info

GetGSLBRegions:

string zone — Required. Name of the zone where the service exists.
string fqdn — Required. Name of the node where the service exists.
string token — Required. The session identifier.

Response:

GetOneGSLBRegion — Click for More Info

hash data
- string serve_count — How many records will be returned in each DNS response.
- string min_healthy — If this many addresses aren’t ‘ok’, the service will go into failover; Defaults to 1.
- string failover_mode — How the region should failover.
  Valid values:
  ip – Failover to a particular IP.
  cname – Failover to a particular CNAME.
  region – Failover to a particular region.
  global – Failover to the global IP address pool Default.
- string failover_data — Dependent upon failover_mode.
  ip – If failover_mode is ‘ip’, this should be an IP address.
  cname – If failover_mode is ‘cname’, this should be a CNAME.
  region – If failover_mode is ‘region’, this should be a region_code of the failover target region.
  global – If failover_mode is ‘global’, this should be empty or omitted.
- string region_code — Name of the region.
  Valid values:
  US West
  US Central
  US East
  EU West
  EU Central
  EU East
  Asia
  global
- array pool — The IP Pool list for this region.
  - string address The IP address or FQDN of this 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 when this log entry was generated.
    - string site_code — The airport code of the monitoring site that generated this log entry.
- string status — The current state of the region.
  Valid values:
  unk – The service state is not yet known.
  ok – There are no problems with the service.
  trouble – One or more node_ips are reporting down.
  failover – The number of okay node_ips has fallen below failover_count. The service has failed over.

GetGSLBRegions — Click for More Info

array data
- string serve_count — How many records will be returned in each DNS response.
- string min_healthy — If this many addresses aren’t ‘ok’, the service will go into failover; Defaults to 1.
- string failover_mode — How the region should failover.
  Valid values:
  ip – Failover to a particular IP.
  cname – Failover to a particular CNAME.
  region – Failover to a particular region.
  global – Failover to the global IP address pool Default.
- string failover_data — Dependent upon failover_mode.
  ip – If failover_mode is ‘ip’, this should be an IP address.
  cname – If failover_mode is ‘cname’, this should be a CNAME.
  region – If failover_mode is ‘region’, this should be a region_code of the failover target region.
  global – If failover_mode is ‘global’, this should be empty or omitted.
- string region_code — Name of the region.
  Valid values:
  US West
  US Central
  US East
  EU West
  EU Central
  EU East
  Asia
  global
- array pool — The IP Pool list for this region.
  - string address The IP address or FQDN of this 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 when this log entry was generated.
    - string site_code — The airport code of the monitoring site that generated this log entry.
- string status — The current state of the region.
  Valid values:
  unk – The service state is not yet known.
  ok – There are no problems with the service.
  trouble – One or more node_ips are reporting down.
  failover – The number of okay node_ips has fallen below failover_count. The service has failed over.

Example Request (GetOneGSLBRegion) — Click for More Info

{
	'zone' => 'example.com',
	'fqdn' => 'somehost.example.com',
	'region_code' => 'US East',
	'token' => 'asdlj34ot879834cdzjklfK',
}

Example Request (GetGSLBRegions) — Click for More Info

{
	'zone' => 'example.com',
	'fqdn' => 'somehost.example.com',
	'token' => 'asdlj34ot879834cdzjklfK',
}

<< DNS API Knowledge Base

REST Syntax	Associated API Topics
SOAP Syntax	Create GSLB Region (API)
	Update GSLB Region (API)
	Delete GSLB Region (API)