Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SteeringPolicySummary

A DNS steering policy.

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

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the steering policy.

definedTags

definedTags: 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"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: string

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

freeformTags

freeformTags: 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"}}

Type declaration

  • [key: string]: string

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.

id

id: string

The OCID of the resource.

lifecycleState

lifecycleState: LifecycleState

The current state of the resource.

self

self: string

The canonical absolute URL of the resource.

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.

timeCreated

timeCreated: Date

The date and time the resource was created, expressed in RFC 3339 timestamp format.

*Example:** {@code 2016-07-22T17:23:59:60Z}

ttl

ttl: 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