Retrieving one or all existing Real Time Traffic Management(RTTM) service region pool entries in 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/RTTMRegionPoolEntry/ GET — Retrieves one or all RTTM service region pool entries in the zone/node indicated.
HTTP Action — GET
URIs:
Get one RTTM Region Pool Entry — https://api.dynect.net/REST/RTTMRegionPoolEntry/<zone>/<fqdn>/<region_code>/<address>/
Get RTTM Region Pool Entries — https://api.dynect.net/REST/RTTMRegionPoolEntry/<zone>/<fqdn>/<region_code>/
|
| Arguments:
Get one RTTM Region Pool Entry — No Arguments.
Get RTTM Region Pool Entries —
string detail — A boolean indicating whether or not to return the full details or a list of service resources. Default = N
Valid values:
Y — The details of each service are specified.
N — The list of service resources is returned.
|
| Response:
Get one RTTM Region Pool Entry — Click for More Info
- string
address — The IPv4 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 identifying this IP.
- string
weight — A number from 1-15 describing how often this record should be served. The higher the number, the more often the address is served.
- 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 — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone.
Get all RTTM Region Pool Entries — array — Individual Real Time Traffic Management service region pool resources.
|
SOAP Syntax
| Click to view all SOAP Commands |
|
GetOneRTTMRegionPoolEntry — Retrieve an existing entry in a Real Time Traffic Management service region pool.
GetRTTMRegionPoolEntries — Retrieve all existing entries in the Real Time Traffic Management service region pool.
|
| Arguments:
GetOneRTTMRegionPoolEntry — Click for More Info
- string
address — Required. The IPv4 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 node where the service exists.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the service exists.
GetRTTMRegionPoolEntries — 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 node where the service exists.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where the service exists.
|
| Response:
GetOneRTTMRegionPoolEntry — Click for More Info
- hash
data
- string
address — The IPv4 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 identifying this IP.
- string
weight — A number from 1-15 describing how often this record should be served. The higher the number, the more often the address is served.
- 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 — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone.
GetRTTMRegionPoolEntries — Click for More Info
- array
data
- string
address — The IPv4 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 identifying this IP.
- string
weight — A number from 1-15 describing how often this record should be served. The higher the number, the more often the address is served.
- 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 — Fully qualified domain name of a node in the zone.
- string
zone — Name of the zone.
|
Example Request (GetOneRTTMRegionPoolEntry) — Click for More Info
{
'zone' => 'example.com',
'fqdn' => 'somehost.example.com',
'token' => 'asdlj34ot879834cdzjklfK',
'region_code' => 'US East',
'address' => '1.2.3.4',
}
|
Example Request (GetRTTMRegionPoolEntries) — Click for More Info
{
'zone' => 'example.com',
'fqdn' => 'somehost.example.com',
'token' => 'asdlj34ot879834cdzjklfK',
'region_code' => 'US East',
}
|
<< DNS API Knowledge Base
