1. REST API for Oracle Private Cloud Appliance Compute Enclave
  2. Tasks
  3. Load Balancers
  4. Network Load Balancer

GetBackendSet

get

/20200501/networkLoadBalancers/{network_load_balancer_id}/backendSets/{backend_set_name}

Retrieve the configuration information for the specified backend set.

Request

Supported Media Types
Path Parameters
Header Parameters
  • Minimum Length: 0
    Maximum Length: 1
    Pattern: ^[*]$
    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
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Back to Top

Response

Supported Media Types

200 Response

Retrieving the backend set information.
Headers
  • For optimistic concurrency control. See `if-match`.
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : BackendSet
Type: object
The configuration of a network load balancer backend set. Avoid entering confidential information when you supply string values using the API.
Show Source
  • backends
    Unique Items Required: true
    Array of backends.
  • HealthChecker
    The health check policy configuration.
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV6" ]
    IP version associated with the backend set.
  • If this parameter is enabled, the NLB fleet in a particular AD will prefer backends within the same AD while load-balancing traffic.
  • Default Value: false
    If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
  • If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
  • Default Value: true
    If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.
  • When backends are added without weights, this value will represent the percent of backends that must be healthy within an AD for AD Affinity to be honored. When backends are added with weights, this value will represent the percent of weights that must be healthy within an AD for AD Affinity to be honored. If the percent of healthy backends falls below this threshold, traffic will be distributed across all healthy backends in all ADs. If this percent value is not specified then default will be 80.
  • A user-friendly name for the backend set that must be unique and cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.
  • Default Value: FIVE_TUPLE
    Allowed Values: [ "TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE" ]
    The network load balancer policy for the backend set. Example: FIVE_TUPLE
Nested Schema : backends
Type: array
Unique Items Required: true
Array of backends.
Show Source
Nested Schema : HealthChecker
Type: object
The health check policy configuration.
Show Source
  • DnsHealthCheckerDetails
    DNS healthcheck configurations.
  • The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
  • The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080
    Example: 8080
  • Allowed Values: [ "HTTP", "HTTPS", "TCP", "UDP", "DNS" ]
    The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
  • Base64 encoded pattern to be sent as UDP or TCP health check probe.
  • A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
  • Base64 encoded pattern to be validated as UDP or TCP health check probe response.
  • The number of retries to attempt before a backend server is considered unhealthy. This number also applies when recovering a server to the healthy state. The default value is 3.
  • The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as 200.
    Example: 0
  • The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds).
  • The path against which to run the health check. Example: /healthcheck
Nested Schema : Backend
Type: object
The configuration of a backend server that is a member of a network load balancer backend set.
Show Source
  • The IP address of the backend server. Example: 10.0.0.3
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV6" ]
    IP version associated with the Backend object.
  • Default Value: false
    Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as isBackup fail the health check policy. Example: false
  • Default Value: false
    Whether the network load balancer should drain this server. Servers marked isDrain receive no incoming traffic. Example: false
  • Default Value: false
    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
  • A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Examples: 10.0.0.3:8080 or ocid1.privateip..unique_ID:443 or 10.0.0.3:0
  • The communication port for the backend server. Example: 8080
  • The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip.unique_ID
  • The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted 3 receives three times the number of new connections as a server weighted 1.
Nested Schema : DnsHealthCheckerDetails
Type: object
DNS healthcheck configurations.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
  • Allowed Values: [ "IN", "CH" ]
    The class the dns health check query to use; either IN or CH. Example: `IN`
  • Allowed Values: [ "A", "TXT", "AAAA" ]
    The type the dns health check query to use; A, AAAA, TXT. Example: `A`
  • rcodes
    Minimum Number of Items: 1
    Unique Items Required: true
    An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
  • Allowed Values: [ "UDP", "TCP" ]
    DNS transport protocol; either UDP or TCP. Example: `UDP`
Nested Schema : rcodes
Type: array
Minimum Number of Items: 1
Unique Items Required: true
An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
Show Source
  • Allowed Values: [ "NOERROR", "SERVFAIL", "NXDOMAIN", "REFUSED" ]
    Return code value to validate the DNS response in healthcheck.

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

409 Response

Conflict
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

412 Response

Precondition Failed
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.
Back to Top