Load Balancer Functions

CHANGE_LOAD_BALANCER_COMPARTMENT Function

Moves a load balancer into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_load_balancer_compartment (
  load_balancer_id varchar2,
  change_load_balancer_compartment_details dbms_cloud_oci_load_balancer_change_load_balancer_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_change_load_balancer_compartment_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer to move.
`change_load_balancer_compartment_details`	(required) The configuration details for moving a load balancer to a different compartment.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BACKEND Function

Adds a backend server to a backend set.

Syntax

FUNCTION create_backend (
  create_backend_details dbms_cloud_oci_load_balancer_create_backend_details_t,
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_backend_response_t;

Parameters

Parameter	Description
`create_backend_details`	(required) The details to add a backend server to a backend set.
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set and servers.
`backend_set_name`	(required) The name of the backend set to add the backend server to. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BACKEND_SET Function

Adds a backend set to a load balancer.

Syntax

FUNCTION create_backend_set (
  create_backend_set_details dbms_cloud_oci_load_balancer_create_backend_set_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_backend_set_response_t;

Parameters

Parameter	Description
`create_backend_set_details`	(required) The details for adding a backend set.
`load_balancer_id`	(required) The OCID of the load balancer on which to add a backend set.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CERTIFICATE Function

Creates an asynchronous request to add an SSL certificate bundle.

Syntax

FUNCTION create_certificate (
  create_certificate_details dbms_cloud_oci_load_balancer_create_certificate_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_certificate_response_t;

Parameters

Parameter	Description
`create_certificate_details`	(required) The details of the certificate bundle to add.
`load_balancer_id`	(required) The OCID of the load balancer on which to add the certificate bundle.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_HOSTNAME Function

Adds a hostname resource to the specified load balancer. For more information, see Managing Request Routing.

Syntax

FUNCTION create_hostname (
  create_hostname_details dbms_cloud_oci_load_balancer_create_hostname_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_hostname_response_t;

Parameters

Parameter	Description
`create_hostname_details`	(required) The details of the hostname resource to add to the specified load balancer.
`load_balancer_id`	(required) The OCID of the load balancer to add the hostname to.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_LISTENER Function

Adds a listener to a load balancer.

Syntax

FUNCTION create_listener (
  create_listener_details dbms_cloud_oci_load_balancer_create_listener_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_listener_response_t;

Parameters

Parameter	Description
`create_listener_details`	(required) Details to add a listener.
`load_balancer_id`	(required) The OCID of the load balancer on which to add a listener.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_LOAD_BALANCER Function

Creates a new load balancer in the specified compartment. For general information about load balancers, see Overview of the Load Balancing Service. For the purposes of access control, you must provide the OCID of the compartment where you want the load balancer to reside. Notice that the load balancer doesn't have to be in the same compartment as the VCN or backend set. If you're not sure which compartment to use, put the load balancer in the same compartment as the VCN. For information about access control and compartments, see Overview of the IAM Service. You must specify a display name for the load balancer. It does not have to be unique, and you can change it. For information about Availability Domains, see Regions and Availability Domains. To get a list of Availability Domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers. After you send your request, the new object's state will temporarily be PROVISIONING. Before using the object, first make sure its state has changed to RUNNING. When you create a load balancer, the system assigns an IP address. To get the IP address, use the GET_LOAD_BALANCER Function operation.

Syntax

FUNCTION create_load_balancer (
  create_load_balancer_details dbms_cloud_oci_load_balancer_create_load_balancer_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_load_balancer_response_t;

Parameters

Parameter	Description
`create_load_balancer_details`	(required) The configuration details for creating a load balancer.
`opc_request_id`	(optional) 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`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PATH_ROUTE_SET Function

Adds a path route set to a load balancer. For more information, see Managing Request Routing.

Syntax

FUNCTION create_path_route_set (
  create_path_route_set_details dbms_cloud_oci_load_balancer_create_path_route_set_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_path_route_set_response_t;

Parameters

Parameter	Description
`create_path_route_set_details`	(required) The details of the path route set to add.
`load_balancer_id`	(required) The OCID of the load balancer to add the path route set to.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ROUTING_POLICY Function

Adds a routing policy to a load balancer. For more information, see Managing Request Routing.

Syntax

FUNCTION create_routing_policy (
  create_routing_policy_details dbms_cloud_oci_load_balancer_create_routing_policy_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_routing_policy_response_t;

Parameters

Parameter	Description
`create_routing_policy_details`	(required) The details of the routing policy rules to add.
`load_balancer_id`	(required) The OCID of the load balancer to add the routing policy rule list to.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_RULE_SET Function

Creates a new rule set associated with the specified load balancer. For more information, see Managing Rule Sets.

Syntax

FUNCTION create_rule_set (
  load_balancer_id varchar2,
  create_rule_set_details dbms_cloud_oci_load_balancer_create_rule_set_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_rule_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`create_rule_set_details`	(required) The configuration details for the rule set to create.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SSL_CIPHER_SUITE Function

Creates a custom SSL cipher suite.

Syntax

FUNCTION create_ssl_cipher_suite (
  create_ssl_cipher_suite_details dbms_cloud_oci_load_balancer_create_ssl_cipher_suite_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_create_ssl_cipher_suite_response_t;

Parameters

Parameter	Description
`create_ssl_cipher_suite_details`	(required) The details of the SSL cipher suite to add.
`load_balancer_id`	(required) The OCID of the associated load balancer.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BACKEND Function

Removes a backend server from a given load balancer and backend set.

Syntax

FUNCTION delete_backend (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  backend_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_backend_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set and server.
`backend_set_name`	(required) The name of the backend set associated with the backend server. Example: `example_backend_set`
`backend_name`	(required) The IP address and port of the backend server to remove. Example: `10.0.0.3:8080`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BACKEND_SET Function

Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the load balancer. Before you can delete a backend set, you must remove it from any active listeners.

Syntax

FUNCTION delete_backend_set (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_backend_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set.
`backend_set_name`	(required) The name of the backend set to delete. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CERTIFICATE Function

Deletes an SSL certificate bundle from a load balancer.

Syntax

FUNCTION delete_certificate (
  load_balancer_id varchar2,
  certificate_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_certificate_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the certificate bundle to be deleted.
`certificate_name`	(required) The name of the certificate bundle to delete. Example: `example_certificate_bundle`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_HOSTNAME Function

Deletes a hostname resource from the specified load balancer.

Syntax

FUNCTION delete_hostname (
  load_balancer_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_hostname_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the hostname to delete.
`name`	(required) The name of the hostname resource to delete. Example: `example_hostname_001`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_LISTENER Function

Deletes a listener from a load balancer.

Syntax

FUNCTION delete_listener (
  load_balancer_id varchar2,
  listener_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_listener_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the listener to delete.
`listener_name`	(required) The name of the listener to delete. Example: `example_listener`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_LOAD_BALANCER Function

Stops a load balancer and removes it from service.

Syntax

FUNCTION delete_load_balancer (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_load_balancer_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer to delete.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PATH_ROUTE_SET Function

Deletes a path route set from the specified load balancer. To delete a path route rule from a path route set, use the UPDATE_PATH_ROUTE_SET Function operation.

Syntax

FUNCTION delete_path_route_set (
  load_balancer_id varchar2,
  path_route_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_path_route_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the path route set to delete.
`path_route_set_name`	(required) The name of the path route set to delete. Example: `example_path_route_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ROUTING_POLICY Function

Deletes a routing policy from the specified load balancer. To delete a routing rule from a routing policy, use the UPDATE_ROUTING_POLICY Function operation.

Syntax

FUNCTION delete_routing_policy (
  load_balancer_id varchar2,
  routing_policy_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_routing_policy_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the routing policy to delete.
`routing_policy_name`	(required) The name of the routing policy to delete. Example: `example_routing_policy`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_RULE_SET Function

Deletes a rule set from the specified load balancer. To delete a rule from a rule set, use the UPDATE_RULE_SET Function operation.

Syntax

FUNCTION delete_rule_set (
  load_balancer_id varchar2,
  rule_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_rule_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`rule_set_name`	(required) The name of the rule set to delete. Example: `example_rule_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SSL_CIPHER_SUITE Function

Deletes an SSL cipher suite from a load balancer.

Syntax

FUNCTION delete_ssl_cipher_suite (
  load_balancer_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_delete_ssl_cipher_suite_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the associated load balancer.
`name`	(required) The name of the SSL cipher suite to delete. example: `example_cipher_suite`
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BACKEND Function

Gets the specified backend server's configuration information.

Syntax

FUNCTION get_backend (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  backend_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_backend_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set and server.
`backend_set_name`	(required) The name of the backend set that includes the backend server. Example: `example_backend_set`
`backend_name`	(required) The IP address and port of the backend server to retrieve. Example: `10.0.0.3:8080`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BACKEND_HEALTH Function

Gets the current health status of the specified backend server.

Syntax

FUNCTION get_backend_health (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  backend_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_backend_health_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend server health status to be retrieved.
`backend_set_name`	(required) The name of the backend set associated with the backend server to retrieve the health status for. Example: `example_backend_set`
`backend_name`	(required) The IP address and port of the backend server to retrieve the health status for. Example: `10.0.0.3:8080`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BACKEND_SET Function

Gets the specified backend set's configuration information.

Syntax

FUNCTION get_backend_set (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_backend_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`backend_set_name`	(required) The name of the backend set to retrieve. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BACKEND_SET_HEALTH Function

Gets the health status for the specified backend set.

Syntax

FUNCTION get_backend_set_health (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_backend_set_health_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set health status to be retrieved.
`backend_set_name`	(required) The name of the backend set to retrieve the health status for. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_HEALTH_CHECKER Function

Gets the health check policy information for a given load balancer and backend set.

Syntax

FUNCTION get_health_checker (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_health_checker_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the health check policy to be retrieved.
`backend_set_name`	(required) The name of the backend set associated with the health check policy to be retrieved. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_HOSTNAME Function

Gets the specified hostname resource's configuration information.

Syntax

FUNCTION get_hostname (
  load_balancer_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_hostname_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`name`	(required) The name of the hostname resource to retrieve. Example: `example_hostname_001`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_LOAD_BALANCER Function

Gets the specified load balancer's configuration information.

Syntax

FUNCTION get_load_balancer (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_load_balancer_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer to retrieve.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_LOAD_BALANCER_HEALTH Function

Gets the health status for the specified load balancer.

Syntax

FUNCTION get_load_balancer_health (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_load_balancer_health_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer to return health status for.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PATH_ROUTE_SET Function

Gets the specified path route set's configuration information.

Syntax

FUNCTION get_path_route_set (
  load_balancer_id varchar2,
  path_route_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_path_route_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`path_route_set_name`	(required) The name of the path route set to retrieve. Example: `example_path_route_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ROUTING_POLICY Function

Gets the specified routing policy.

Syntax

FUNCTION get_routing_policy (
  load_balancer_id varchar2,
  routing_policy_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_routing_policy_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`routing_policy_name`	(required) The name of the routing policy to retrieve. Example: `example_routing_policy`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RULE_SET Function

Gets the specified set of rules.

Syntax

FUNCTION get_rule_set (
  load_balancer_id varchar2,
  rule_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_rule_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`rule_set_name`	(required) The name of the rule set to retrieve. Example: `example_rule_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SSL_CIPHER_SUITE Function

Gets the specified SSL cipher suite's configuration information.

Syntax

FUNCTION get_ssl_cipher_suite (
  load_balancer_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_ssl_cipher_suite_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the associated load balancer.
`name`	(required) The name of the SSL cipher suite to retrieve. example: `example_cipher_suite`
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the details of a work request.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request to retrieve.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BACKEND_SETS Function

Lists all backend sets associated with a given load balancer.

Syntax

FUNCTION list_backend_sets (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_backend_sets_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend sets to retrieve.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BACKENDS Function

Lists the backend servers for a given load balancer and backend set.

Syntax

FUNCTION list_backends (
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_backends_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set and servers.
`backend_set_name`	(required) The name of the backend set associated with the backend servers. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CERTIFICATES Function

Lists all SSL certificates bundles associated with a given load balancer.

Syntax

FUNCTION list_certificates (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_certificates_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the certificate bundles to be listed.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_HOSTNAMES Function

Lists all hostname resources associated with the specified load balancer.

Syntax

FUNCTION list_hostnames (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_hostnames_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the hostnames to retrieve.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_LISTENER_RULES Function

Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes the rules in the following order: * Access control rules * Allow method rules * Request header rules * Response header rules

Syntax

FUNCTION list_listener_rules (
  load_balancer_id varchar2,
  listener_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_listener_rules_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the listener.
`listener_name`	(required) The name of the listener the rules are associated with.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_LOAD_BALANCER_HEALTHS Function

Lists the summary health statuses for all load balancers in the specified compartment.

Syntax

FUNCTION list_load_balancer_healths (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_load_balancer_healths_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the load balancers to return health status information for.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination. Example: `3`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_LOAD_BALANCERS Function

Lists all load balancers in the specified compartment.

Syntax

FUNCTION list_load_balancers (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  detail varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_load_balancers_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the load balancers to list.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination. Example: `3`
`detail`	(optional) The level of detail to return for each result. Can be `full` or `simple`. Example: `full`
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the given display name exactly. Example: `example_load_balancer`
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PATH_ROUTE_SETS Function

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

Syntax

FUNCTION list_path_route_sets (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_path_route_sets_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the path route sets to retrieve.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_POLICIES Function

Lists the available load balancer policies.

Syntax

FUNCTION list_policies (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the load balancer policies to list.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination. Example: `3`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROTOCOLS Function

Lists all supported traffic protocols.

Syntax

FUNCTION list_protocols (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_protocols_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the load balancer protocols to list.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination. Example: `3`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ROUTING_POLICIES Function

Lists all routing policies associated with the specified load balancer.

Syntax

FUNCTION list_routing_policies (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_routing_policies_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the routing policies.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination. Example: `3`
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RULE_SETS Function

Lists all rule sets associated with the specified load balancer.

Syntax

FUNCTION list_rule_sets (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_rule_sets_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SSL_CIPHER_SUITES Function

Lists all SSL cipher suites associated with the specified load balancer.

Syntax

FUNCTION list_ssl_cipher_suites (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_ssl_cipher_suites_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the associated load balancer.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SHAPES Function

Lists the valid load balancer shapes.

Syntax

FUNCTION list_shapes (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_shapes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the load balancer shapes to list.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination. Example: `3`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests for a given load balancer.

Syntax

FUNCTION list_work_requests (
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_list_work_requests_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer associated with the work requests to retrieve.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination. Example: `3`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BACKEND Function

Updates the configuration of a backend server within the specified backend set.

Syntax

FUNCTION update_backend (
  update_backend_details dbms_cloud_oci_load_balancer_update_backend_details_t,
  load_balancer_id varchar2,
  backend_set_name varchar2,
  backend_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_backend_response_t;

Parameters

Parameter	Description
`update_backend_details`	(required) Details for updating a backend server.
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set and server.
`backend_set_name`	(required) The name of the backend set associated with the backend server. Example: `example_backend_set`
`backend_name`	(required) The IP address and port of the backend server to update. Example: `10.0.0.3:8080`
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BACKEND_SET Function

Updates a backend set.

Syntax

FUNCTION update_backend_set (
  update_backend_set_details dbms_cloud_oci_load_balancer_update_backend_set_details_t,
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_backend_set_response_t;

Parameters

Parameter	Description
`update_backend_set_details`	(required) The details to update a backend set.
`load_balancer_id`	(required) The OCID of the load balancer associated with the backend set.
`backend_set_name`	(required) The name of the backend set to update. Example: `example_backend_set`
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_HEALTH_CHECKER Function

Updates the health check policy for a given load balancer and backend set.

Syntax

FUNCTION update_health_checker (
  health_checker dbms_cloud_oci_load_balancer_update_health_checker_details_t,
  load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_health_checker_response_t;

Parameters

Parameter	Description
`health_checker`	(required) The health check policy configuration details.
`load_balancer_id`	(required) The OCID of the load balancer associated with the health check policy to be updated.
`backend_set_name`	(required) The name of the backend set associated with the health check policy to be retrieved. Example: `example_backend_set`
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_HOSTNAME Function

Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a virtual hostname.

Syntax

FUNCTION update_hostname (
  update_hostname_details dbms_cloud_oci_load_balancer_update_hostname_details_t,
  load_balancer_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_hostname_response_t;

Parameters

Parameter	Description
`update_hostname_details`	(required) The configuration details to update a virtual hostname.
`load_balancer_id`	(required) The OCID of the load balancer associated with the virtual hostname to update.
`name`	(required) The name of the hostname resource to update. Example: `example_hostname_001`
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_LISTENER Function

Updates a listener for a given load balancer.

Syntax

FUNCTION update_listener (
  update_listener_details dbms_cloud_oci_load_balancer_update_listener_details_t,
  load_balancer_id varchar2,
  listener_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_listener_response_t;

Parameters

Parameter	Description
`update_listener_details`	(required) Details to update a listener.
`load_balancer_id`	(required) The OCID of the load balancer associated with the listener to update.
`listener_name`	(required) The name of the listener to update. Example: `example_listener`
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_LOAD_BALANCER Function

Updates a load balancer's configuration.

Syntax

FUNCTION update_load_balancer (
  update_load_balancer_details dbms_cloud_oci_load_balancer_update_load_balancer_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_load_balancer_response_t;

Parameters

Parameter	Description
`update_load_balancer_details`	(required) The details for updating a load balancer's configuration.
`load_balancer_id`	(required) The OCID of the load balancer to update.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_LOAD_BALANCER_SHAPE Function

Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the LB. The service will try to perform this operation in the least disruptive way to existing connections, but there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller bandwidth.

Syntax

FUNCTION update_load_balancer_shape (
  load_balancer_id varchar2,
  update_load_balancer_shape_details dbms_cloud_oci_load_balancer_update_load_balancer_shape_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_load_balancer_shape_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the load balancer whose shape will be updated.
`update_load_balancer_shape_details`	(required) The details for updating a load balancer's shape. This contains the new, desired shape.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_NETWORK_SECURITY_GROUPS Function

Updates the network security groups associated with the specified load balancer.

Syntax

FUNCTION update_network_security_groups (
  update_network_security_groups_details dbms_cloud_oci_load_balancer_update_network_security_groups_details_t,
  load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_network_security_groups_response_t;

Parameters

Parameter	Description
`update_network_security_groups_details`	(required) The details for updating the NSGs associated with the specified load balancer.
`load_balancer_id`	(required) The OCID of the load balancer to update the NSGs for.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PATH_ROUTE_SET Function

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 UPDATE_PATH_ROUTE_SET_DETAILS Function object must include both the new path route rule to add and the existing path route rules to retain.

Syntax

FUNCTION update_path_route_set (
  update_path_route_set_details dbms_cloud_oci_load_balancer_update_path_route_set_details_t,
  load_balancer_id varchar2,
  path_route_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_path_route_set_response_t;

Parameters

Parameter	Description
`update_path_route_set_details`	(required) The configuration details to update a path route set.
`load_balancer_id`	(required) The OCID of the load balancer associated with the path route set to update.
`path_route_set_name`	(required) The name of the path route set to update. Example: `example_path_route_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ROUTING_POLICY Function

Overwrites an existing routing policy on the specified load balancer. Use this operation to add, delete, or alter routing policy rules in a routing policy. To add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain.

Syntax

FUNCTION update_routing_policy (
  update_routing_policy_details dbms_cloud_oci_load_balancer_update_routing_policy_details_t,
  load_balancer_id varchar2,
  routing_policy_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_routing_policy_response_t;

Parameters

Parameter	Description
`update_routing_policy_details`	(required) The configuration details needed to update a routing policy.
`load_balancer_id`	(required) The OCID of the load balancer associated with the routing policy to update.
`routing_policy_name`	(required) The name of the routing policy to update. Example: `example_routing_policy_name`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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`
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_RULE_SET Function

Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter the rules in a rule set. To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.

Syntax

FUNCTION update_rule_set (
  load_balancer_id varchar2,
  rule_set_name varchar2,
  update_rule_set_details dbms_cloud_oci_load_balancer_update_rule_set_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_rule_set_response_t;

Parameters

Parameter	Description
`load_balancer_id`	(required) The OCID of the specified load balancer.
`rule_set_name`	(required) The name of the rule set to update. Example: `example_rule_set`
`update_rule_set_details`	(required) The configuration details to update a set of rules.
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SSL_CIPHER_SUITE Function

Updates an existing SSL cipher suite for the specified load balancer.

Syntax

FUNCTION update_ssl_cipher_suite (
  update_ssl_cipher_suite_details dbms_cloud_oci_load_balancer_update_ssl_cipher_suite_details_t,
  load_balancer_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lb_load_balancer_update_ssl_cipher_suite_response_t;

Parameters

Parameter	Description
`update_ssl_cipher_suite_details`	(required) The configuration details to update an SSL cipher suite.
`load_balancer_id`	(required) The OCID of the associated load balancer.
`name`	(required) The name of the SSL cipher suite to update. example: `example_cipher_suite`
`opc_request_id`	(optional) 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`	(optional) 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).
`if_match`	(optional) 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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_LOAD_BALANCER_COMPARTMENT Function 🔗

CREATE_BACKEND Function 🔗

CREATE_BACKEND_SET Function 🔗

CREATE_CERTIFICATE Function 🔗

CREATE_HOSTNAME Function 🔗

CREATE_LISTENER Function 🔗

CREATE_LOAD_BALANCER Function 🔗

CREATE_PATH_ROUTE_SET Function 🔗

CREATE_ROUTING_POLICY Function 🔗

CREATE_RULE_SET Function 🔗

CREATE_SSL_CIPHER_SUITE Function 🔗

DELETE_BACKEND Function 🔗

DELETE_BACKEND_SET Function 🔗

DELETE_CERTIFICATE Function 🔗

DELETE_HOSTNAME Function 🔗

DELETE_LISTENER Function 🔗

DELETE_LOAD_BALANCER Function 🔗

DELETE_PATH_ROUTE_SET Function 🔗

DELETE_ROUTING_POLICY Function 🔗

DELETE_RULE_SET Function 🔗

DELETE_SSL_CIPHER_SUITE Function 🔗

GET_BACKEND Function 🔗

GET_BACKEND_HEALTH Function 🔗

GET_BACKEND_SET Function 🔗

GET_BACKEND_SET_HEALTH Function 🔗

GET_HEALTH_CHECKER Function 🔗

GET_HOSTNAME Function 🔗

GET_LOAD_BALANCER Function 🔗

GET_LOAD_BALANCER_HEALTH Function 🔗

GET_PATH_ROUTE_SET Function 🔗

GET_ROUTING_POLICY Function 🔗

GET_RULE_SET Function 🔗

GET_SSL_CIPHER_SUITE Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_BACKEND_SETS Function 🔗

LIST_BACKENDS Function 🔗

LIST_CERTIFICATES Function 🔗

LIST_HOSTNAMES Function 🔗

LIST_LISTENER_RULES Function 🔗

LIST_LOAD_BALANCER_HEALTHS Function 🔗

LIST_LOAD_BALANCERS Function 🔗

LIST_PATH_ROUTE_SETS Function 🔗

LIST_POLICIES Function 🔗

LIST_PROTOCOLS Function 🔗

LIST_ROUTING_POLICIES Function 🔗

LIST_RULE_SETS Function 🔗

LIST_SSL_CIPHER_SUITES Function 🔗

LIST_SHAPES Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_BACKEND Function 🔗

UPDATE_BACKEND_SET Function 🔗

UPDATE_HEALTH_CHECKER Function 🔗

UPDATE_HOSTNAME Function 🔗

UPDATE_LISTENER Function 🔗

UPDATE_LOAD_BALANCER Function 🔗

UPDATE_LOAD_BALANCER_SHAPE Function 🔗

UPDATE_NETWORK_SECURITY_GROUPS Function 🔗

UPDATE_PATH_ROUTE_SET Function 🔗

UPDATE_ROUTING_POLICY Function 🔗

UPDATE_RULE_SET Function 🔗

UPDATE_SSL_CIPHER_SUITE Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_LOAD_BALANCER_COMPARTMENT Function

CREATE_BACKEND Function

CREATE_BACKEND_SET Function

CREATE_CERTIFICATE Function

CREATE_HOSTNAME Function

CREATE_LISTENER Function

CREATE_LOAD_BALANCER Function

CREATE_PATH_ROUTE_SET Function

CREATE_ROUTING_POLICY Function

CREATE_RULE_SET Function

CREATE_SSL_CIPHER_SUITE Function

DELETE_BACKEND Function

DELETE_BACKEND_SET Function

DELETE_CERTIFICATE Function

DELETE_HOSTNAME Function

DELETE_LISTENER Function

DELETE_LOAD_BALANCER Function

DELETE_PATH_ROUTE_SET Function

DELETE_ROUTING_POLICY Function

DELETE_RULE_SET Function

DELETE_SSL_CIPHER_SUITE Function

GET_BACKEND Function

GET_BACKEND_HEALTH Function

GET_BACKEND_SET Function

GET_BACKEND_SET_HEALTH Function

GET_HEALTH_CHECKER Function

GET_HOSTNAME Function

GET_LOAD_BALANCER Function

GET_LOAD_BALANCER_HEALTH Function

GET_PATH_ROUTE_SET Function

GET_ROUTING_POLICY Function

GET_RULE_SET Function

GET_SSL_CIPHER_SUITE Function

GET_WORK_REQUEST Function

LIST_BACKEND_SETS Function

LIST_BACKENDS Function

LIST_CERTIFICATES Function

LIST_HOSTNAMES Function

LIST_LISTENER_RULES Function

LIST_LOAD_BALANCER_HEALTHS Function

LIST_LOAD_BALANCERS Function

LIST_PATH_ROUTE_SETS Function

LIST_POLICIES Function

LIST_PROTOCOLS Function

LIST_ROUTING_POLICIES Function

LIST_RULE_SETS Function

LIST_SSL_CIPHER_SUITES Function

LIST_SHAPES Function

LIST_WORK_REQUESTS Function

UPDATE_BACKEND Function

UPDATE_BACKEND_SET Function

UPDATE_HEALTH_CHECKER Function

UPDATE_HOSTNAME Function

UPDATE_LISTENER Function

UPDATE_LOAD_BALANCER Function

UPDATE_LOAD_BALANCER_SHAPE Function

UPDATE_NETWORK_SECURITY_GROUPS Function

UPDATE_PATH_ROUTE_SET Function

UPDATE_ROUTING_POLICY Function

UPDATE_RULE_SET Function

UPDATE_SSL_CIPHER_SUITE Function