Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateSteeringPolicyDetails

The body for updating a steering policy. New rules and answers provided in the request will replace the existing rules and answers in the policy.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

Optional answers

The set of all answers that can potentially issue from the steering policy.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {"Operations": {"CostCenter": "42"}}}

Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional displayName

displayName: undefined | string

A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {"Department": "Finance"}}

Example: {@code {"Department": "Finance"}}

Optional healthCheckMonitorId

healthCheckMonitorId: undefined | string

The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with {@code rdata} matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with {@code rdata} not matching any monitored endpoint will be assumed healthy.

Note: To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see Managing Health Checks.

Note: To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see Managing Health Checks.

Optional rules

The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.

The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response.

The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response.

Optional template

template: Template

A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management's rules in a different order to produce the desired results when answering DNS queries.

Example: The {@code FAILOVER} template determines answers by filtering the policy's answers using the {@code FILTER} rule first, then the following rules in succession: {@code HEALTH}, {@code PRIORITY}, and {@code LIMIT}. This gives the domain dynamic failover capability.

It is strongly recommended to use a template other than {@code CUSTOM} when creating a steering policy.

All templates require the rule order to begin with an unconditional {@code FILTER} rule that keeps answers contingent upon {@code answer.isDisabled != true}, except for {@code CUSTOM}. A defined {@code HEALTH} rule must follow the {@code FILTER} rule if the policy references a {@code healthCheckMonitorId}. The last rule of a template must must be a {@code LIMIT} rule. For more information about templates and code examples, see Traffic Management API Guide.

*Template Types**

{@code FAILOVER} - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy.

  • {@code LOAD_BALANCE} - Distributes web traffic to specified endpoints based on defined weights.

  • {@code ROUTE_BY_GEO} - Answers DNS queries based on the query's geographic location. For a list of geographic locations to route by, see Traffic Management Geographic Locations.

  • {@code ROUTE_BY_ASN} - Answers DNS queries based on the query's originating ASN.

  • {@code ROUTE_BY_IP} - Answers DNS queries based on the query's IP address.

  • {@code CUSTOM} - Allows a customized configuration of rules.

Example: The {@code FAILOVER} template determines answers by filtering the policy's answers using the {@code FILTER} rule first, then the following rules in succession: {@code HEALTH}, {@code PRIORITY}, and {@code LIMIT}. This gives the domain dynamic failover capability.

It is strongly recommended to use a template other than {@code CUSTOM} when creating a steering policy.

All templates require the rule order to begin with an unconditional {@code FILTER} rule that keeps answers contingent upon {@code answer.isDisabled != true}, except for {@code CUSTOM}. A defined {@code HEALTH} rule must follow the {@code FILTER} rule if the policy references a {@code healthCheckMonitorId}. The last rule of a template must must be a {@code LIMIT} rule. For more information about templates and code examples, see Traffic Management API Guide.

*Template Types**

{@code FAILOVER} - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy.

  • {@code LOAD_BALANCE} - Distributes web traffic to specified endpoints based on defined weights.

  • {@code ROUTE_BY_GEO} - Answers DNS queries based on the query's geographic location. For a list of geographic locations to route by, see Traffic Management Geographic Locations.

  • {@code ROUTE_BY_ASN} - Answers DNS queries based on the query's originating ASN.

  • {@code ROUTE_BY_IP} - Answers DNS queries based on the query's IP address.

  • {@code CUSTOM} - Allows a customized configuration of rules.

Optional ttl

ttl: undefined | number

The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj