Create GSLB Region (API) | Dyn Help Center

Understanding How The API Works »

Creating an instance of a Global Server Load Balancing service region 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.

REST Syntax

Click to view all REST Resources

/REST/GSLBRegion/ POST — Create a region on an existing instance of the Global Server Load Balancing service (GSLB) on the zone/node indicated.

HTTP Action — POST

URI — https://api.dynect.net/REST/GSLBRegion/<zone>/<fqdn>/

Arguments — Click for More Info

Response — Click for More Info

integer task_id – The number assigned to the task to create a GSLB Region.
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 for the target failover 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 region.
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.

SOAP Syntax

Click to view all SOAP Commands

CreateGSLBRegion — Create a new region pool on an existing instance of the Global Server Load Balancing service.

Arguments — Click for More Info

string fqdn — Required. Name of node where the region will exist.
string zone — Required. Name of zone where the region will exist.
array region — Required. A list of regions
Valid Values:
US West
US Central
US East
EU West
EU Central
EU East
Asia
global
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 target region for failover.
global – If failover_mode is ‘global’, this should be empty or omitted
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.
array pool — Required. The IP Pool list for this region.

string address — Required. The IP address or FQDN of this Node IP.
string label — A descriptive string describing this IP.
string weightA number from 1-15 describing how often this record should be served. Higher means more.

NOTE: If weight is assigned a value of 0, the corresponding address will always be included in the response set. If the serve count is set to serve only 1 address, the address with the weight of 0 will be the only address served, even if other records with differing weights are included.

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 token — Required. The session identifier

Response — Click for More Info

integer task_id – The number assigned to the task to create a GSLB Region.
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. 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 which region to failover to.
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 states:
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 — Click for More Info

{
	'zone' => 'example.com',
	'fqdn' => 'somehost.example.com',
	'region_code' => 'US East'
	'serve_mode' => 'obey',
		'region_code' => 'global',
		'failover_mode' => 'ip',
		'failover_data' => '127.0.0.1',
		'serve_count' => 1,
		'pool' => [
			{
				'address' => '1.2.3.4',
				'serve_mode' => 'obey',
			},
			{
				'address' => '5.6.7.8',
				'serve_mode' => 'obey',
			},
		],
	'token' => 'asdlj34ot879834cdzjklfK',
}

<< DNS API Knowledge Base

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