Jump to

• Request
• Response

Get a list of all steering policies in the specified compartment

get

/20180115/steeringPolicies

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  The displayName of a resource.

  Default Value: none
• displayNameContains: string
  Minimum Length: 1

  Maximum Length: 255

  The partial displayName of a resource. The result matches any resource whose name (case-insensitive) contains the provided value.
• healthCheckMonitorId: string
  Search by health check monitor OCID. The result matches any resource whose health check monitor OCID matches the provided value.
• id: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of a resource.
• lifecycleState: string
  The state of a resource.

  Default Value: ACTIVE
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: 0
• scope: string
  Specifies to operate only on resources that have a matching DNS scope.

  Allowed Values: [ "GLOBAL", "PRIVATE" ]
• sortBy: string
  The field by which to sort steering policies. If unspecified, defaults to timeCreated.

  Default Value: timeCreated

  Allowed Values: [ "displayName", "timeCreated", "template" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]
• template: string
  Search by steering template type. The result matches any resource whose template type matches the provided value.
• timeCreatedGreaterThanOrEqualTo: string(date-time)
  An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created on or after the indicated time.
• timeCreatedLessThan: string(date-time)
  An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created before the indicated time.

Header Parameters

• opc-request-id: string
  Minimum Length: 1

  Maximum Length: 98

  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response containing a list of steering policy objects.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• opc-total-items: integer
  The total number of items that match the query.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SteeringPolicySummary
  A DNS steering policy. Avoid entering confidential information when you supply string values using the API.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SteeringPolicySummary"
    }
}

Nested Schema : SteeringPolicySummary

Type: object

A DNS steering policy. Avoid entering confidential information when you supply string values using the API.

Show Source

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the steering policy.
• definedTags(required): object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name for the steering policy. Does not need to be unique and can be changed. Avoid entering confidential information.
• freeformTags(required): object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• healthCheckMonitorId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with 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.
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the resource.
• lifecycleState(required): string
  Allowed Values: [ "ACTIVE", "CREATING", "DELETED", "DELETING" ]

  The current state of the resource.
• self(required): string(url)
  The canonical absolute URL of the resource.
• template(required): string
  Allowed Values: [ "FAILOVER", "LOAD_BALANCE", "ROUTE_BY_GEO", "ROUTE_BY_ASN", "ROUTE_BY_IP", "CUSTOM" ]

  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 FAILOVER template determines answers by filtering the policy's answers using the FILTER rule first, then the following rules in succession: HEALTH, PRIORITY, and LIMIT. This gives the domain dynamic failover capability. Note: You are strongly recommended to use a template other than CUSTOM when creating a steering policy. All templates require the rule order to begin with an unconditional FILTER rule that keeps answers contingent upon answer.isDisabled != true, except for CUSTOM. A defined HEALTH rule must follow the FILTER rule if the policy references a healthCheckMonitorId. The last rule of a template must must be a LIMIT rule. Template Types: 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. LOAD_BALANCE - Distributes web traffic to specified endpoints based on defined weights. ROUTE_BY_GEO - Answers DNS queries based on the query's geographic location. ROUTE_BY_ASN - Answers DNS queries based on the query's originating ASN. ROUTE_BY_IP - Answers DNS queries based on the query's IP address. CUSTOM - Allows a customized configuration of rules.
• timeCreated(required): string(date-time)
  The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z
• ttl(required): integer(int32)
  Minimum Value: 1

  Maximum Value: 604800

  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.

{
    "description":"A DNS steering policy. Avoid entering confidential information when you supply string values using the API.",
    "type":"object",
    "required":[
        "compartmentId",
        "displayName",
        "ttl",
        "template",
        "freeformTags",
        "definedTags",
        "self",
        "id",
        "timeCreated",
        "lifecycleState"
    ],
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the steering policy.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name for the steering policy. Does not need to be unique and can be changed. Avoid entering confidential information.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "ttl":{
            "description":"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.",
            "type":"integer",
            "format":"int32",
            "minimum":1,
            "maximum":604800
        },
        "healthCheckMonitorId":{
            "description":"The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with 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.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "template":{
            "description":"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 FAILOVER template determines answers by filtering the policy's answers using the FILTER rule first, then the following rules in succession: HEALTH, PRIORITY, and LIMIT. This gives the domain dynamic failover capability. Note: You are strongly recommended to use a template other than CUSTOM when creating a steering policy. All templates require the rule order to begin with an unconditional FILTER rule that keeps answers contingent upon answer.isDisabled != true, except for CUSTOM. A defined HEALTH rule must follow the FILTER rule if the policy references a healthCheckMonitorId. The last rule of a template must must be a LIMIT rule. Template Types: 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. LOAD_BALANCE - Distributes web traffic to specified endpoints based on defined weights. ROUTE_BY_GEO - Answers DNS queries based on the query's geographic location. ROUTE_BY_ASN - Answers DNS queries based on the query's originating ASN. ROUTE_BY_IP - Answers DNS queries based on the query's IP address. CUSTOM - Allows a customized configuration of rules.",
            "type":"string",
            "enum":[
                "FAILOVER",
                "LOAD_BALANCE",
                "ROUTE_BY_GEO",
                "ROUTE_BY_ASN",
                "ROUTE_BY_IP",
                "CUSTOM"
            ]
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  **Example:** `{\"CostCenter\": \"42\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer, and boolean types are supported. "
                }
            }
        },
        "self":{
            "description":"The canonical absolute URL of the resource.",
            "type":"string",
            "format":"url"
        },
        "id":{
            "description":"The OCID of the resource.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2016-07-22T17:23:59:60Z ",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the resource.",
            "type":"string",
            "enum":[
                "ACTIVE",
                "CREATING",
                "DELETED",
                "DELETING"
            ]
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}`

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  **Example:** `{\"CostCenter\": \"42\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer, and boolean types are supported. "
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer, and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  **Example:** `{\"CostCenter\": \"42\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer, and boolean types are supported. "
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer, and boolean types are supported.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top