Understanding How The API Works »
Creating a new Record Set Failover Chain 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.
NOTE: Total number of records in a single Response Pool may not be more than 255.
WARNING: Dyn recommends setting an explicit fallback record entry in all Traffic Director services to ensure a query is always answered with a record. See TD Best Practices – Fallback Entry for more information on setting up a fall back entry.
REST Syntax
Click to view all REST Resources |
/REST/DSFRecordSetFailoverChain/ POST — Create a new Record Set Failover Chain.
HTTP Action — POST
URIs — https://api.dynect.net/REST/DSFRecordSetFailoverChain/<service_id>/<dsf_response_pool_id>/ |
Arguments — Click for More Info
|
Response — Click for More Info
|
SOAP Syntax
Click to view all SOAP Commands |
CreateDSFRecordSetFailoverChain — Creates a new Record Set within a Record Set Failover Chain or Response Pool. |
Arguments — Click for More Info
|
Response — Click for More Info
- string
dsf_record_set_failover_chain_id — Identifier for the Record Set Failover Chain.
- string
dsf_response_pool_id — Identifier for the Response Pool where the Record Set Failover Chain belongs.
- string
service_id — Identifier for the service where the Record Set Failover Chain belongs.
- string
label — A label for the Record Set Failover Chain
- string
core — If True, identifies the Record Set Failover Chain as a core Record Chain.
- array
record_sets — A non-detailed list of Record Sets contained in the chain.
- string
service_id — Identifier for the Traffic Director Service.
- string
dsf_record_set_id — Identifier for the Record Set.
- string
dsf_monitor_id — The id of the monitoring object.
- string
label — A label for the Record Set.
Click for Record Set fields.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- string
ttl_derived — The actual TTL used for Records within this Record Set.
- string
automation — Defines how eligible can be changed in response to monitoring.
Valid values:
auto — Sets the serve_mode field to ‘Monitor & Obey’. Default.
auto_down — Sets the serve_mode field to ‘Monitor & Remove’.
manual — Couples with eligible value to determine other serve_mode field values.
- string
serve_count — How many Records to serve out of this Record Set.
- string
fail_count — The number of Records that must not be okay before the Record Set becomes ineligible.
- string
trouble_count — The number of Records that must not be okay before the Record Set becomes in trouble.
- string
eligible — Indicates whether or not the Record Set can be served.
Valid values:
false — When automation is set to manual, sets the serve_mode field to ‘Do Not Serve’.
true — Default. When automation is set to manual, the Record Set can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
records — A list of Records contained within the Record Set
|
Example Request — Click for More Info
{
'service_id' => 'fv298...', # ID shortened...
'dsf_response_pool_id' => '4ae3n...', # ID shortened...
'label' => 'Example Record Set Failover Chain',
'core' => 'true',
'record_sets' => [{
'label' => 'US East - AAAA',
'rdata_class' => 'AAAA',
'ttl' => '3600',
'records' => [{
'label' => 'USEast007',
'weight' => '5',
'automation' => 'auto',
'endpoints' => ['127.1.5.1','176.2.66.7'],
'endpoint_up_count' => '1',
'master_line' => '2001:0db8:85a3:0000:0000:8a2e:0370:7334',
}],
},{
'dsf_record_set_id' => '0bi5k...', # ID shortened...,
},{
'failover' => 'failover.com',
}],
'token' => 'asdlj34ot879834cdzjklfK'
}
|
<< DNS API Knowledge Base