Jump to

• Request
• Response

UpdatePathRouteSet

put

/20170115/loadBalancers/{load_balancer_id}/pathRouteSets/{path_route_set_name}

Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter path route rules in a path route set. To add a new path route rule to a path route set, the pathRoutes in the UpdatePathRouteSetDetails object must include both the new path route rule to add and the existing path route rules to retain.

Request

Supported Media Types

• application/json

Path Parameters

• loadBalancerId(required): string
  The OCID of the load balancer associated with the path route set to update.
• pathRouteSetName(required): string
  The name of the path route set to update. Example: example_path_route_set

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 from a previous GET or POST response for that resource. 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. Provide this request OCID if you need to contact Oracle about this request.

  Default Value:
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

The configuration details to update a path route set.

Root Schema : UpdatePathRouteSetDetails

Type: object

An updated set of path route rules that overwrites the existing set of rules.

Show Source

• pathRoutes(required): array pathRoutes
  Minimum Number of Items: 0

  Maximum Number of Items: 20

  The set of path route rules.

{
    "type":"object",
    "description":"An updated set of path route rules that overwrites the existing set of rules.",
    "required":[
        "pathRoutes"
    ],
    "properties":{
        "pathRoutes":{
            "type":"array",
            "minItems":"0",
            "maxItems":"20",
            "description":"The set of path route rules.",
            "items":{
                "$ref":"#/definitions/PathRoute"
            }
        }
    },
    "x-example":"{   \"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\" } "
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

The request was accepted for processing.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• opc-work-request-id: string
  The OCID of the work request.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

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..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top