path_route_sets

Creates, updates, deletes, gets or lists a path_route_sets resource.

Overview

Name	path_route_sets
Type	Resource
Id	oci.load_balancer.path_route_sets

Fields

The following fields are returned by SELECT queries:

get

The path route set information is being retrieved.

Name	Datatype	Description
name	string	The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
pathRoutes	array	The set of path route rules.

list

A named set of path route rules. For more information, see<br />[Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm).<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.<br />

Name	Datatype	Description
name	string	The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
pathRoutes	array	The set of path route rules.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	loadBalancerId, pathRouteSetName, region	opc-request-id	Gets the specified path route set's configuration information.
list	select	loadBalancerId, region	opc-request-id	Lists all path route sets associated with the specified load balancer.
create	insert	loadBalancerId, region, name, pathRoutes	opc-request-id, opc-retry-token	Adds a path route set to a load balancer. For more information, see<br />[Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm).<br />
update	update	loadBalancerId, pathRouteSetName, region, pathRoutes	opc-request-id, opc-retry-token	Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter<br />path route rules in a path route set.<br /><br />To add a new path route rule to a path route set, the pathRoutes in the<br />[UpdatePathRouteSetDetails](#/en/loadbalancer/20170115/requests/UpdatePathRouteSetDetails) object must include<br />both the new path route rule to add and the existing path route rules to retain.<br />
delete	delete	loadBalancerId, pathRouteSetName, region	opc-request-id	Deletes a path route set from the specified load balancer.<br /><br />To delete a path route rule from a path route set, use the<br />[UpdatePathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/UpdatePathRouteSet) operation.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to delete.
pathRouteSetName	string	The name of the path route set to delete. Example: example_path_route_set
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
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.
opc-retry-token	string	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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

SELECT examples

get

Gets the specified path route set's configuration information.

SELECT
name,
pathRoutes
FROM oci.load_balancer.path_route_sets
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND pathRouteSetName = '{{ pathRouteSetName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

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

SELECT
name,
pathRoutes
FROM oci.load_balancer.path_route_sets
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples

create

Adds a path route set to a load balancer. For more information, see<br />[Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm).<br />

INSERT INTO oci.load_balancer.path_route_sets (
name,
pathRoutes,
loadBalancerId,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ name }}' /* required */,
'{{ pathRoutes }}' /* required */,
'{{ loadBalancerId }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
;

Manifest

# Description fields are for documentation purposes
- name: path_route_sets
props:
  - name: loadBalancerId
    value: "{{ loadBalancerId }}"
    description: Required parameter for the path_route_sets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the path_route_sets resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name for this set of path route rules. It must be unique and it cannot be changed. Avoid entering
      confidential information.
      Example: `example_path_route_set`
  - name: pathRoutes
    description: |
      The set of path route rules.
    value:
      - backendSetName: "{{ backendSetName }}"
        path: "{{ path }}"
        pathMatchType:
          matchType: "{{ matchType }}"
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

UPDATE examples

update

Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter<br />path route rules in a path route set.<br /><br />To add a new path route rule to a path route set, the pathRoutes in the<br />[UpdatePathRouteSetDetails](#/en/loadbalancer/20170115/requests/UpdatePathRouteSetDetails) object must include<br />both the new path route rule to add and the existing path route rules to retain.<br />

UPDATE oci.load_balancer.path_route_sets
SET 
pathRoutes = '{{ pathRoutes }}'
WHERE 
loadBalancerId = '{{ loadBalancerId }}' --required
AND pathRouteSetName = '{{ pathRouteSetName }}' --required
AND region = '{{ region }}' --required
AND pathRoutes = '{{ pathRoutes }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}';

DELETE examples

delete

Deletes a path route set from the specified load balancer.<br /><br />To delete a path route rule from a path route set, use the<br />[UpdatePathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/UpdatePathRouteSet) operation.<br />

DELETE FROM oci.load_balancer.path_route_sets
WHERE loadBalancerId = '{{ loadBalancerId }}' --required
AND pathRouteSetName = '{{ pathRouteSetName }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
;