Arguments:
GetOneDSFRuleset — Click for More Info
- string
service_id — Required. ID of the Traffic Director (DSF) Service.
- string
dsf_ruleset_id — Required. ID of the Ruleset.
- string
pending_changes — Indicates whether pending changes will be returned.
Valid values:
Y — Return all published objects plus pending changes along with the change type (add/modify/remove).
N — Return only published objects.
- string
token — Required. The session identifier.
GetDSFRulesets — Click for More Info
- string
service_id — Required. ID of the Traffic Director (DSF) Service.
- string
label — Label of the Ruleset. Can be wild carded.
NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.
- string
criteria_type — A set of rules describing what traffic is applied to the Response Pool.
- string
criteria — A comma separated string of search keywords (Ex: “US,CA”). Can be wild carded.
NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.
- string
ordering — Index of the Ruleset.
string token — Required. The session identifier.
|
Response:
GetOneDSFRuleset — Click for More Info
- hash
data
- string
dsf_ruleset_id — Identifier for the Ruleset.
- string
label — A label for the Ruleset.
- string
criteria_type — A set of rules describing what traffic is applied to the Response Pool.
Valid values:
always – Always serve. Use to create a catch-all ruleset, which resolves all queries regardless of requestor’s IP address.
geoip – Use the location of the requestor’s IP address to determine where to send the traffic.
- string
criteria — Dependent on criteria_type.
Valid values:
- hash
geoip — A hash where each element contains a list of ISO-3166 two letter codes to represent the names of countries and their subdivisions, one of the predefined groups, or one of the legacy regions.
- array
country — A list of ISO-3166 two letter codes representing Countries
- array
region — A list of ISO-3166 two letter codes representing Regions
- array
province — A list of ISO-3166 two letter codes representing Provinces
- string
ordering — Index of the Ruleset.
- string
eligible — Indicates whether or not the Response Pool can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
response_pools — A list of Response Pools that are contained within the Ruleset.
- string
dsf_response_pool_id — Identifier for the Response Pool.
- string
label — A label for the Response Pool.
- 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
core_set_count — If fewer than this number of core record sets are eligible, status will be set to fail. Defaults to 0.
- string
eligible — Indicates whether or not the Response Pool can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
rs_chains — A list of Record Set Failover Chains that are defined for this 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
dsf_monitor_id — The id of the monitoring object.
- 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 DSF 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.
- array
rulesets — A list of Rulesets that contain this Response Pool.
- string
status — The status of the pool indicated by any attached monitors.
- string
last_monitored — Epoch timestamp of the last time the Response Pool was monitored.
GetDSFRulesets — Click for More Info
- array
data
- string
dsf_ruleset_id — Identifier for the Ruleset.
- string
label — A label for the Ruleset.
- string
criteria_type — A set of rules describing what traffic is applied to the response pool.
Valid values:
always – Always serve
geoip – Use the location of the requestor’s IP address to determine where to send the traffic.
- string
criteria — Dependent on criteria_type.
Valid values:
- hash
geoip — A hash where each element contains a list of ISO-3166 two letter codes to represent the names of countries and their subdivisions, one of the predefined groups, or one of the legacy regions.
- array
country — A list of ISO-3166 two letter codes representing Countries
- array
region — A list of ISO-3166 two letter codes representing Regions
- array
province — A list of ISO-3166 two letter codes representing Provinces
- string
ordering — Index of the Ruleset.
- string
eligible — Indicates whether or not the Ruleset can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
response_pools — A list of Response Pools that are contained within the Ruleset.
- string
dsf_response_pool_id — Identifier for the Response Pool.
- string
label — A label for the Response Pool.
- 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
core_set_count — If fewer than this number of core record sets are eligible, status will be set to fail. Defaults to 0.
- string
eligible — Indicates whether or not the Response Pool can be served.
- string
pending_change — Indicates whether or not the response has any changes pending.
- array
rs_chains — A list of Record Set Failover Chains that are defined for this 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
dsf_monitor_id — The id of the monitoring object.
- 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.
- array
rulesets — A list of Rulesets that contain this Response Pool.
- string
status — The status of the pool indicated by any attached monitors.
- string
last_monitored — Epoch timestamp of the last time the Response Pool was monitored.
|