Jump to

• Request
• Response

List Path Route Sets

get

/20170115/loadBalancers/{load_balancer_id}/pathRouteSets

List all path route sets associated with the specified load balancer.

Request

Supported Media Types

• application/json

Path Parameters

• loadBalancerId(required): string
  The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route sets to retrieve.

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer. For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets. The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value. Example: `example-etag`

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

  Default Value:

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• eTag: string
  Reflects the current version of the load balancer and the resources it contains. The value only changes when the load balancer or an associated resource is created, updated, or delete For optimistic concurrency control. See `if-match`.
• 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 : schema

Type: array

Show Source

• Array of: object PathRouteSet
  A named set of path route rules. Avoid entering confidential information when you supply string values using the API.

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

Nested Schema : PathRouteSet

Type: object

A named set of path route rules. Avoid entering confidential information when you supply string values using the API.

Show Source

• name(required): string
  Minimum Length: 1

  Maximum Length: 32

  The unique name for this set of path route rules. Avoid entering confidential information.
• pathRoutes(required): array pathRoutes
  Minimum Number of Items: 0

  Maximum Number of Items: 20

  The set of path route rules.

{
    "type":"object",
    "description":"A named set of path route rules. Avoid entering confidential information when you supply string values using the API.",
    "required":[
        "name",
        "pathRoutes"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":32,
            "description":"The unique name for this set of path route rules. Avoid entering confidential information."
        },
        "pathRoutes":{
            "type":"array",
            "minItems":0,
            "maxItems":20,
            "description":"The set of path route rules.",
            "items":{
                "$ref":"#/definitions/PathRoute"
            }
        }
    },
    "x-example":"{   \"name\": \"example_path_route_set\",   \"pathRoutes\": [     {       \"path\": \"/example/video/123\",       \"pathMatchType\": {         \"matchType\": \"EXACT_MATCH\"       },       \"backendSetName\": \"example_backend_set\"     }   ] } "
}

Nested Schema : pathRoutes

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 20

The set of path route rules.

Show Source

• Array of: object PathRoute
  A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.

{
    "type":"array",
    "minItems":0,
    "maxItems":20,
    "description":"The set of path route rules.",
    "items":{
        "$ref":"#/definitions/PathRoute"
    }
}

Nested Schema : PathRoute

Type: object

A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.

Show Source

• backendSetName(required): string
  Minimum Length: 1

  Maximum Length: 32

  The name of the target backend set for requests where the incoming URI matches the specified path.
• path(required): string
  Minimum Length: 1

  Maximum Length: 2048

  The path string to match against the incoming URI path. Path strings are case-insensitive. Asterisk (*) wildcards are not supported. Regular expressions are not supported. Example: /example/video/123
• pathMatchType(required): object PathMatchType
  The type of matching to apply to incoming URIs.

{
    "type":"object",
    "description":"A \"path route rule\" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.",
    "required":[
        "path",
        "pathMatchType",
        "backendSetName"
    ],
    "properties":{
        "path":{
            "type":"string",
            "minLength":1,
            "maxLength":2048,
            "description":"The path string to match against the incoming URI path. Path strings are case-insensitive. Asterisk (*) wildcards are not supported. Regular expressions are not supported. Example: /example/video/123 "
        },
        "pathMatchType":{
            "description":"The type of matching to apply to incoming URIs.",
            "$ref":"#/definitions/PathMatchType"
        },
        "backendSetName":{
            "type":"string",
            "minLength":1,
            "maxLength":32,
            "description":"The name of the target backend set for requests where the incoming URI matches the specified path."
        }
    },
    "x-example":"{   \"path\": \"/example/video/123\",   \"pathMatchType\": {     \"matchType\": \"EXACT_MATCH\"   },   \"backendSetName\": \"example_backend_set\" } "
}

Nested Schema : PathMatchType

Type: object

The type of matching to apply to incoming URIs.

Show Source

• matchType(required): string
  Allowed Values: [ "EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH" ]

  Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI. EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path. FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path. PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path. SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.

{
    "type":"object",
    "description":"The type of matching to apply to incoming URIs.",
    "required":[
        "matchType"
    ],
    "properties":{
        "matchType":{
            "type":"string",
            "enum":[
                "EXACT_MATCH",
                "FORCE_LONGEST_PREFIX_MATCH",
                "PREFIX_MATCH",
                "SUFFIX_MATCH"
            ],
            "description":"Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI. EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path. FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path. PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path. SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path."
        }
    },
    "x-example":"{   \"matchType\": \"EXACT_MATCH\" } "
}

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

409 Response

Conflict

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

412 Response

Precondition Failed

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