Understanding How The API Works »
Creating a new Global Server Load Balance service region pool entry 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.
REST Syntax
Click to view all REST Resources |
/REST/GSLBRegionPoolEntry/ POST — Create a new Global Server Load Balance service region pool entry on the zone/node indicated.
HTTP Action — POST
URI — https://api.dynect.net/REST/GSLBRegionPoolEntry/<zone>/<fqdn>/<region_code>/
|
Arguments — Click for More Info
- string
address — Required. The IP address or FQDN of this Node IP.
- string
label — Identifying descriptive information for this IP.
- string
weight — A number from 1-15 describing how often this record should be served. Higher values indicate more frequent service for this record.
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.
|
Response — Click for More Info
- integer
task_id – The number assigned to the task to create a GSLB Region Pool Entry.
- 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 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
fqdn — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone.
|
SOAP Syntax
Click to view all SOAP Commands |
CreateGSLBRegionPoolEntry — Create a new Global Server Load Balance service region pool entry on the zone/node indicated.
|
Arguments — Click for More Info
- string
address — Required. The IP address or FQDN of this 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
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.
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
fqdn — Required. Name of node where the region will exist.
- string
zone — Required. Name of zone where the region will exist.
- 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 Pool Entry.
- 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
fqdn — Name of node where the region exists.
- string
zone — Name of zone where the region exists.
|
Example Request — Click for More Info
{
'zone' => 'example.com',
'fqdn' => 'somehost.example.com',
'token' => 'asdlj34ot879834cdzjklfK',
'address' => '1.2.3.4',
'region_code' => 'US East'
'serve_mode' => 'obey',
}
|
<< DNS API Knowledge Base