Network Load Balancer Functions

CHANGE_NETWORK_LOAD_BALANCER_COMPARTMENT Function

Moves a network 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_network_load_balancer_compartment (
  network_load_balancer_id varchar2,
  change_network_load_balancer_compartment_details dbms_cloud_oci_network_load_balancer_change_network_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_nlb_network_load_balancer_change_network_load_balancer_compartment_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`change_network_load_balancer_compartment_details`	(required) The configuration details for moving a network load balancer to a different compartment.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 (
  network_load_balancer_id varchar2,
  create_backend_details dbms_cloud_oci_network_load_balancer_create_backend_details_t,
  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_nlb_network_load_balancer_create_backend_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`create_backend_details`	(required) The details to add a backend server to a backend set.
`backend_set_name`	(required) The name of the backend set to which to add the backend server. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer.

Syntax

FUNCTION create_backend_set (
  network_load_balancer_id varchar2,
  create_backend_set_details dbms_cloud_oci_network_load_balancer_create_backend_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_nlb_network_load_balancer_create_backend_set_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`create_backend_set_details`	(required) The details for adding a backend set.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer.

Syntax

FUNCTION create_listener (
  network_load_balancer_id varchar2,
  create_listener_details dbms_cloud_oci_network_load_balancer_create_listener_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_nlb_network_load_balancer_create_listener_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`create_listener_details`	(required) Details to add a listener.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCER Function

Creates a network load balancer.

Syntax

FUNCTION create_network_load_balancer (
  create_network_load_balancer_details dbms_cloud_oci_network_load_balancer_create_network_load_balancer_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_create_network_load_balancer_response_t;

Parameters

Parameter	Description
`create_network_load_balancer_details`	(required) Details for the new network load balancer.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer and backend set.

Syntax

FUNCTION delete_backend (
  network_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_nlb_network_load_balancer_delete_backend_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`backend_set_name`	(required) The name of the backend set associated with the backend server. Example: `example_backend_set`
`backend_name`	(required) The name of the backend server to remove. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer. Before you can delete a backend set, you must remove it from any active listeners.

Syntax

FUNCTION delete_backend_set (
  network_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_nlb_network_load_balancer_delete_backend_set_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`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 must contact Oracle about a particular request, then provide the request identifier.
`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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer.

Syntax

FUNCTION delete_listener (
  network_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_nlb_network_load_balancer_delete_listener_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`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 must contact Oracle about a particular request, then provide the request identifier.
`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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCER Function

Deletes a network load balancer resource by identifier.

Syntax

FUNCTION delete_network_load_balancer (
  network_load_balancer_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_delete_network_load_balancer_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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

Retrieves the configuration information for the specified backend server.

Syntax

FUNCTION get_backend (
  network_load_balancer_id varchar2,
  backend_set_name varchar2,
  backend_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_get_backend_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`backend_set_name`	(required) The name of the backend set that includes the backend server. Example: `example_backend_set`
`backend_name`	(required) The name of the backend server to retrieve. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. 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://network-load-balancer-api.{region}.oci.{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

Retrieves the current health status of the specified backend server.

Syntax

FUNCTION get_backend_health (
  network_load_balancer_id varchar2,
  backend_set_name varchar2,
  backend_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_get_backend_health_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`backend_set_name`	(required) The name of the backend set associated with the backend server for which to retrieve the health status. Example: `example_backend_set`
`backend_name`	(required) The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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

Retrieves the configuration information for the specified backend set.

Syntax

FUNCTION get_backend_set (
  network_load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_get_backend_set_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`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 must contact Oracle about a particular request, then provide the request identifier.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. 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://network-load-balancer-api.{region}.oci.{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

Retrieves the health status for the specified backend set.

Syntax

FUNCTION get_backend_set_health (
  network_load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_get_backend_set_health_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`backend_set_name`	(required) The name of the backend set for which to retrieve the health status. Example: `example_backend_set`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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

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

Syntax

FUNCTION get_health_checker (
  network_load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_get_health_checker_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`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 must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. 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://network-load-balancer-api.{region}.oci.{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_LISTENER Function

Retrieves listener properties associated with a given network load balancer and listener name.

Syntax

FUNCTION get_listener (
  network_load_balancer_id varchar2,
  listener_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_get_listener_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`listener_name`	(required) The name of the listener to get. Example: `example_listener`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. 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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCER Function

Retrieves network load balancer configuration information by identifier.

Syntax

FUNCTION get_network_load_balancer (
  network_load_balancer_id varchar2,
  if_none_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_get_network_load_balancer_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. Example: `example-etag`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCER_HEALTH Function

Retrieves the health status for the specified network load balancer.

Syntax

FUNCTION get_network_load_balancer_health (
  network_load_balancer_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_nlb_network_load_balancer_get_network_load_balancer_health_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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

Retrieves the details of the work request with the given identifier.

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_nlb_network_load_balancer_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The identifier of the asynchronous request.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer.

Syntax

FUNCTION list_backend_sets (
  network_load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_list_backend_sets_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. Example: `example-etag`
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`sort_order`	(optional) The sort order to use, either 'asc' (ascending) or 'desc' (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: 'timeCreated', 'displayName'
`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://network-load-balancer-api.{region}.oci.{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 network load balancer and backend set.

Syntax

FUNCTION list_backends (
  network_load_balancer_id varchar2,
  backend_set_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_list_backends_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`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 must contact Oracle about a particular request, then provide the request identifier.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. Example: `example-etag`
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`sort_order`	(optional) The sort order to use, either 'asc' (ascending) or 'desc' (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: 'timeCreated', 'displayName'
`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://network-load-balancer-api.{region}.oci.{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_LISTENERS Function

Lists all listeners associated with a given network load balancer.

Syntax

FUNCTION list_listeners (
  network_load_balancer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_list_listeners_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`if_none_match`	(optional) The system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code `304 (Not Modified)`. Example: `example-etag`
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`sort_order`	(optional) The sort order to use, either 'asc' (ascending) or 'desc' (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: 'timeCreated', 'displayName'
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCER_HEALTHS Function

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

Syntax

FUNCTION list_network_load_balancer_healths (
  compartment_id varchar2,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  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_nlb_network_load_balancer_list_network_load_balancer_healths_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the network load balancers to list.
`sort_order`	(optional) The sort order to use, either 'asc' (ascending) or 'desc' (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCERS Function

Returns a list of network load balancers.

Syntax

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

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the network load balancers to list.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`sort_order`	(optional) The sort order to use, either 'asc' (ascending) or 'desc' (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCERS_POLICIES Function

Lists the available network load balancer policies.

Syntax

FUNCTION list_network_load_balancers_policies (
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_list_network_load_balancers_policies_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`sort_order`	(optional) The sort order to use, either 'asc' (ascending) or 'desc' (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: 'timeCreated', 'displayName'
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCERS_PROTOCOLS Function

This API has been deprecated so it won't return the updated list of supported protocls. Lists all supported traffic protocols.

Syntax

FUNCTION list_network_load_balancers_protocols (
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_list_network_load_balancers_protocols_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`sort_order`	(optional) The sort order to use, either 'asc' (ascending) or 'desc' (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. Allowed values are: 'timeCreated', 'displayName'
`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://network-load-balancer-api.{region}.oci.{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_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The identifier of the asynchronous request.
`compartment_id`	(required) The OCID of the compartment containing the network load balancers to list.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`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.
`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://network-load-balancer-api.{region}.oci.{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_REQUEST_LOGS Function

Returns a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The identifier of the asynchronous request.
`compartment_id`	(required) The OCID of the compartment containing the network load balancers to list.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`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.
`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://network-load-balancer-api.{region}.oci.{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 all work requests.

Syntax

FUNCTION list_work_requests (
  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_nlb_network_load_balancer_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the network load balancers to list.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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.
`page`	(optional) The page token representing the page from which to start retrieving results. 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.
`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://network-load-balancer-api.{region}.oci.{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 (
  network_load_balancer_id varchar2,
  update_backend_details dbms_cloud_oci_network_load_balancer_update_backend_details_t,
  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_nlb_network_load_balancer_update_backend_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`update_backend_details`	(required) Details for updating a backend server.
`backend_set_name`	(required) The name of the backend set associated with the backend server. Example: `example_backend_set`
`backend_name`	(required) The name of the backend server to update. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 (
  network_load_balancer_id varchar2,
  update_backend_set_details dbms_cloud_oci_network_load_balancer_update_backend_set_details_t,
  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_nlb_network_load_balancer_update_backend_set_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`update_backend_set_details`	(required) The details to update a 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 must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer and backend set.

Syntax

FUNCTION update_health_checker (
  network_load_balancer_id varchar2,
  update_health_checker_details dbms_cloud_oci_network_load_balancer_update_health_checker_details_t,
  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_nlb_network_load_balancer_update_health_checker_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`update_health_checker_details`	(required) The health check policy configuration details.
`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 must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer.

Syntax

FUNCTION update_listener (
  network_load_balancer_id varchar2,
  update_listener_details dbms_cloud_oci_network_load_balancer_update_listener_details_t,
  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_nlb_network_load_balancer_update_listener_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`update_listener_details`	(required) Details to update a listener.
`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 must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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_LOAD_BALANCER Function

Updates the network load balancer

Syntax

FUNCTION update_network_load_balancer (
  network_load_balancer_id varchar2,
  update_network_load_balancer_details dbms_cloud_oci_network_load_balancer_update_network_load_balancer_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_nlb_network_load_balancer_update_network_load_balancer_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`update_network_load_balancer_details`	(required) The information to be updated.
`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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`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://network-load-balancer-api.{region}.oci.{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 network load balancer.

Syntax

FUNCTION update_network_security_groups (
  network_load_balancer_id varchar2,
  update_network_security_groups_details dbms_cloud_oci_network_load_balancer_update_network_security_groups_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_nlb_network_load_balancer_update_network_security_groups_response_t;

Parameters

Parameter	Description
`network_load_balancer_id`	(required) The OCID of the network load balancer to update.
`update_network_security_groups_details`	(required) The details for updating the network security groups associated with the specified network load balancer.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the current etag value of the resource.
`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://network-load-balancer-api.{region}.oci.{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_NETWORK_LOAD_BALANCER_COMPARTMENT Function 🔗

CREATE_BACKEND Function 🔗

CREATE_BACKEND_SET Function 🔗

CREATE_LISTENER Function 🔗

CREATE_NETWORK_LOAD_BALANCER Function 🔗

DELETE_BACKEND Function 🔗

DELETE_BACKEND_SET Function 🔗

DELETE_LISTENER Function 🔗

DELETE_NETWORK_LOAD_BALANCER Function 🔗

GET_BACKEND Function 🔗

GET_BACKEND_HEALTH Function 🔗

GET_BACKEND_SET Function 🔗

GET_BACKEND_SET_HEALTH Function 🔗

GET_HEALTH_CHECKER Function 🔗

GET_LISTENER Function 🔗

GET_NETWORK_LOAD_BALANCER Function 🔗

GET_NETWORK_LOAD_BALANCER_HEALTH Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_BACKEND_SETS Function 🔗

LIST_BACKENDS Function 🔗

LIST_LISTENERS Function 🔗

LIST_NETWORK_LOAD_BALANCER_HEALTHS Function 🔗

LIST_NETWORK_LOAD_BALANCERS Function 🔗

LIST_NETWORK_LOAD_BALANCERS_POLICIES Function 🔗

LIST_NETWORK_LOAD_BALANCERS_PROTOCOLS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_BACKEND Function 🔗

UPDATE_BACKEND_SET Function 🔗

UPDATE_HEALTH_CHECKER Function 🔗

UPDATE_LISTENER Function 🔗

UPDATE_NETWORK_LOAD_BALANCER Function 🔗

UPDATE_NETWORK_SECURITY_GROUPS Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_NETWORK_LOAD_BALANCER_COMPARTMENT Function

CREATE_BACKEND Function

CREATE_BACKEND_SET Function

CREATE_LISTENER Function

CREATE_NETWORK_LOAD_BALANCER Function

DELETE_BACKEND Function

DELETE_BACKEND_SET Function

DELETE_LISTENER Function

DELETE_NETWORK_LOAD_BALANCER Function

GET_BACKEND Function

GET_BACKEND_HEALTH Function

GET_BACKEND_SET Function

GET_BACKEND_SET_HEALTH Function

GET_HEALTH_CHECKER Function

GET_LISTENER Function

GET_NETWORK_LOAD_BALANCER Function

GET_NETWORK_LOAD_BALANCER_HEALTH Function

GET_WORK_REQUEST Function

LIST_BACKEND_SETS Function

LIST_BACKENDS Function

LIST_LISTENERS Function

LIST_NETWORK_LOAD_BALANCER_HEALTHS Function

LIST_NETWORK_LOAD_BALANCERS Function

LIST_NETWORK_LOAD_BALANCERS_POLICIES Function

LIST_NETWORK_LOAD_BALANCERS_PROTOCOLS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_BACKEND Function

UPDATE_BACKEND_SET Function

UPDATE_HEALTH_CHECKER Function

UPDATE_LISTENER Function

UPDATE_NETWORK_LOAD_BALANCER Function

UPDATE_NETWORK_SECURITY_GROUPS Function