Skip to main content

backend_sets

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

Overview​

Namebackend_sets
TypeResource
Idoci.load_balancer.backend_sets

Fields​

The following fields are returned by SELECT queries:

The backend set information is being retrieved.

NameDatatypeDescription
namestringA friendly name for the backend set. It must be unique and it cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. Example: example_backend_set
backendMaxConnectionsinteger (int32)The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300
backendsarray
healthCheckerobjectThe health check policy configuration. For more information, see [Editing Health Check Policies](/Content/Balance/Tasks/editinghealthcheck.htm). (x-example: {<br /> "protocol": "HTTP",<br /> "isForcePlainText": false,<br /> "urlPath": "/healthcheck",<br /> "port": 8080,<br /> "returnCode": 200,<br /> "retries": 3,<br /> "timeoutInMillis": 3000,<br /> "intervalInMillis": 10000,<br /> "responseBodyRegex": "^((?!false).|\s)*$"<br />}<br />)
policystringThe load balancer policy for the backend set. To get a list of available policies, use the [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. Example: LEAST_CONNECTIONS
sessionPersistenceConfigurationobjectThe configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness). Session persistence enables the Load Balancing service to direct any number of requests that originate from a single logical client to a single backend web server. For more information, see [Session Persistence](/Content/Balance/Reference/sessionpersistence.htm). To disable application cookie stickiness on a running load balancer, use the [UpdateBackendSet](#/en/loadbalancer/20170115/BackendSet/UpdateBackendSet) operation and specify null for the SessionPersistenceConfigurationDetails object. Example: SessionPersistenceConfigurationDetails: null Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. (x-example: {<br /> "cookieName": "example_cookie",<br /> "disableFallback": false<br />}<br />)
sslConfigurationobjectA listener's SSL handling configuration. To use SSL, a listener must be associated with a [certificate bundle](#/en/loadbalancer/20170115/Certificate/). Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. (x-example: [<br /> {<br /> "protocols": ["TLSv1.1", "TLSv1.2"],<br /> "cipherSuiteName" : "example_cipher_suite",<br /> "serverOrderPreference" : "ENABLED",<br /> "certificateName": "example_certificate_bundle",<br /> "verifyPeerCertificate": true<br /> "verifyDepth": 3,<br /> },<br /> {<br /> "certificateIds": [ "example_certificate_id" ],<br /> "trustedCertificateAuthorityIds": [ "example_certificate_authority_id", "example_certificate_bundle_id"]<br /> "verifyPeerCertificate": true<br /> "verifyDepth": 3,<br /> }<br />]<br />)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectloadBalancerId, backendSetName, regionopc-request-idGets the specified backend set's configuration information.
listselectloadBalancerId, regionopc-request-idLists all backend sets associated with a given load balancer.
createinsertloadBalancerId, region, healthChecker, name, policyopc-request-id, opc-retry-tokenAdds a backend set to a load balancer.
updateupdateloadBalancerId, backendSetName, region, policy, backends, healthCheckeropc-request-id, opc-retry-tokenUpdates a backend set.
deletedeleteloadBalancerId, backendSetName, regionopc-request-idDeletes the specified backend set. Note that deleting a backend set removes its backend servers from the load balancer.<br /><br />Before you can delete a backend set, you must remove it from any active listeners.<br />

Parameters​

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

NameDatatypeDescription
backendSetNamestringThe name of the backend set to delete. Example: example_backend_set
loadBalancerIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
opc-request-idstringThe unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

SELECT examples​

Gets the specified backend set's configuration information.

SELECT
name,
backendMaxConnections,
backends,
healthChecker,
policy,
sessionPersistenceConfiguration,
sslConfiguration
FROM oci.load_balancer.backend_sets
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND backendSetName = '{{ backendSetName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Adds a backend set to a load balancer.

INSERT INTO oci.load_balancer.backend_sets (
backendMaxConnections,
backends,
healthChecker,
name,
policy,
sessionPersistenceConfiguration,
sslConfiguration,
loadBalancerId,
region,
opc-request-id,
opc-retry-token
)
SELECT 
{{ backendMaxConnections }},
'{{ backends }}',
'{{ healthChecker }}' /* required */,
'{{ name }}' /* required */,
'{{ policy }}' /* required */,
'{{ sessionPersistenceConfiguration }}',
'{{ sslConfiguration }}',
'{{ loadBalancerId }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
;

UPDATE examples​

Updates a backend set.

UPDATE oci.load_balancer.backend_sets
SET 
backendMaxConnections = {{ backendMaxConnections }},
backends = '{{ backends }}',
healthChecker = '{{ healthChecker }}',
policy = '{{ policy }}',
sessionPersistenceConfiguration = '{{ sessionPersistenceConfiguration }}',
sslConfiguration = '{{ sslConfiguration }}'
WHERE 
loadBalancerId = '{{ loadBalancerId }}' --required
AND backendSetName = '{{ backendSetName }}' --required
AND region = '{{ region }}' --required
AND policy = '{{ policy }}' --required
AND backends = '{{ backends }}' --required
AND healthChecker = '{{ healthChecker }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}';

DELETE examples​

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

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