Removing a 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.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/DSFRecordSetFailoverChain/ DELETE — Deletes the specified Record Set Failover Chain.
HTTP Action — DELETE
URIs — https://api.dynect.net/REST/DSFRecordSetFailoverChain/<service_id>/<dsf_record_set_failover_chain_id>/
|
Arguments:
string publish — Indicates whether to remove the Record Set Failover Chain immediately or to remove it during the next zone publish.
Valid values:
Y — Delete the Record Set Failover Chain immediately.
N — Delete the Record Set Failover Chain at next zone publish.
string notes — A custom note field. All content in the string is added to the Zone Notes for the zones attached to this service when the zone is published. Only used when publish = Y
|
Response — Click for More Info
- string
dsf_response_pool_id — Identifier for the Response Pool.
- 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 Traffic Director (DSF) 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 (DSF) Service.
- string
dsf_record_set_id — Identifier for the Record Set.
- string
label — A label for the Record Set.
- 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.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
records — A list of Records contained within the Record Set
- string
dsf_record_id — Identifier for the Record.
- string
service_id — The id of a Traffic Director (DSF) service.
- string
label — A label for the Record
- string
master_line — Master line for the Record
- string
weight — Weight for the Record. Defaults to 1.
Valid values for A or AAAA records: 1 – 15.
Valid values for CNAME records: 1 – 255.
- 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.
- array
endpoints — The individual address(es) for a record. Multiple addresses are added as an array [ addr, addr ]. Endpoints are monitored if automation is set to auto or auto_down and there is a monitor attached to the service.
- array
endpoint_up_count — Number of endpoints that must be up for the Record status to be ‘up’.
- string
eligible — Indicates whether or not the Record can be served.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- hash
rdata — RData that comprises the Record.
- string
status — The status of the pool indicated by any attached monitors
- string
response_time — Time it took to receive a response from the endpoints
- string
torpidity — Performance indicator for the Record. Lower is better.
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
- string
pending_change — Indicates whether or not the object will be added, updated, or deleted.
- string
status — The status of the pool indicated by any attached monitors
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
string pending_change — Indicates whether or not the response has any changes pending.
|
SOAP Syntax
Click to view all SOAP Commands |
DeleteOneDSFRecordSetFailoverChain — Removes the specified Record Set Failover Chain.
|
Arguments — Click for More Info
- string
service_id — Required. Identifier for the Traffic Director (DSF) service where the Record Set Failover Chain belongs.
- string
dsf_record_set_failover_chain_id — Required. The Record Set Failover Chain identifier.
- string
publish — Indicates whether to remove the Record Set Failover Chain immediately or to remove it during the next zone publish.
Valid values:
Y — Delete the Record Set Failover Chain immediately.
N — Delete the Record Set Failover Chain at next zone publish.
- string
notes — A custom note field. All content in the string is added to the Zone Notes for the zones attached to this service when the zone is published. Only used when publish = Y
- string
token — Required. The session identifier.
|
Response — Click for More Info
hash data
- string
dsf_response_pool_id — Identifier for the Response Pool.
- 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 Traffic Director (DSF) 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 (DSF) Service.
- string
dsf_record_set_id — Identifier for the Record Set.
- string
label — A label for the Record Set.
- 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.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
records — A list of Records contained within the Record Set
- string
dsf_record_id — Identifier for the Record.
- string
service_id — The id of a Traffic Director (DSF) service.
- string
label — A label for the Record
- string
master_line — Master line for the Record
- string
weight — Weight for the Record. Defaults to 1.
Valid values for A or AAAA records: 1 – 15.
Valid values for CNAME records: 1 – 255.
- 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.
- array
endpoints — The individual address(es) for a record. Multiple addresses are added as an array [ addr, addr ]. Endpoints are monitored if automation is set to auto or auto_down and there is a monitor attached to the service.
- array
endpoint_up_count — Number of endpoints that must be up for the Record status to be ‘up’.
- string
eligible — Indicates whether or not the Record can be served.
- string
rdata_class — The type of rdata represented by this Record Set.
- string
ttl — Default TTL used for Records within this Record Set.
- hash
rdata — RData that comprises the Record.
- string
status — The status of the pool indicated by any attached monitors
- string
response_time — Time it took to receive a response from the endpoints
- string
torpidity — Performance indicator for the Record. Lower is better.
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
- string
pending_change — Indicates whether or not the object will be added, updated, or deleted.
- string
status — The status of the pool indicated by any attached monitors
- string
last_monitored — Epoch timestamp of the last time the Record Set was monitored
string pending_change — Indicates whether or not the response has any changes pending.
|
Example Request — Click for More Info
{
'service_id' => 'fv298...', # ID shortened...
'dsf_record_set_failover_chain_id' => '4ae3n...', # ID shortened...
'publish' => 'Y'
'token' => 'asdlj34ot879834cdzjklfK'
}
|
<< DNS API Knowledge Base