ListBackendSets
get
/20200501/networkLoadBalancers/{network_load_balancer_id}/backendSets
Lists all backend sets associated with a given network load balancer.
Request
Supported Media Types
- application/json
Path Parameters
-
networkLoadBalancerId(required): string
The OCID of the network load balancer to update.Default Value:
Query Parameters
-
limit: integer
Minimum Value:
1
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.Default Value:100
-
page: string
Minimum Length:
1
Maximum Length:512
For list pagination. The value of the opc-next-page response header from the previous List call.Default Value:oracle.doceng.json.BetterJsonNull@2c07545f
-
sortBy: string
The optional field to sort the results by.Default Value:
NAME
Allowed Values:[ "ID", "NAME", "TIME_CREATED" ]
-
sortOrder: string
The sort order to use, either ascending (ASC) or descending (DESC).Allowed Values:
[ "ASC", "DESC" ]
Header Parameters
-
if-none-match: string
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-etagDefault Value:
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Response
Supported Media Types
- application/json
200 Response
Retrieving the list of backend sets associated with the network load balancer.
Headers
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : BackendSetCollection
Type:
object
Wrapper object for an array of BackendSetSummary objects.
Show Source
-
items:
array items
An array of BackendSetSummary objects.
Nested Schema : items
Type:
array
An array of BackendSetSummary objects.
Show Source
-
Array of:
object BackendSetSummary
The configuration of a network load balancer backend set. Avoid entering confidential information when you supply string values using the API.
Nested Schema : BackendSetSummary
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(required):
array backends
Unique Items Required:
true
An array of backends. -
healthChecker(required):
object HealthChecker
The health check policy configuration.
-
ipVersion:
string
Default Value:
IPV4
Allowed Values:[ "IPV4", "IPV6" ]
IP version associated with the backend set. -
isPreserveSource:
boolean
Default Value:
true
If this parameter is enabled, the network load balancer preserves the source IP of the packet forwarded to the backend servers. Backend servers see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, this parameter cannot be disabled. The value is true by default. -
name(required):
string
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.
-
policy(required):
string
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
An array of backends.
Show Source
-
Array of:
object Backend
The configuration of a backend server that is a member of a network load balancer backend set.
Nested Schema : HealthChecker
Type:
object
The health check policy configuration.
Show Source
-
intervalInMillis:
integer(int32)
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
-
port:
integer(int32)
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: 8080Example:
8080
-
protocol(required):
string
Allowed Values:
[ "HTTP", "HTTPS", "TCP", "UDP" ]
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. -
requestData:
string(byte)
Base64 encoded pattern to be sent as UDP or TCP health check probe.
-
responseBodyRegex:
string
A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
-
responseData:
string(byte)
Base64 encoded pattern to be validated as UDP or TCP health check probe response.
-
retries:
integer(int32)
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.
-
returnCode:
integer(int32)
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
-
timeoutInMillis:
integer(int32)
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).
-
urlPath:
string
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
-
ipAddress:
string
The IP address of the backend server. Example: 10.0.0.3
-
ipVersion:
string
Default Value:
IPV4
Allowed Values:[ "IPV4", "IPV6" ]
IP version associated with the Backend object. -
isBackup:
boolean
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 -
isDrain:
boolean
Default Value:
false
Whether the network load balancer should drain this server. Servers marked isDrain receive no incoming traffic. Example: false -
isOffline:
boolean
Default Value:
false
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false -
name:
string
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
-
port(required):
integer(int32)
The communication port for the backend server. Example: 8080
-
targetId:
string
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip.unique_ID
-
weight:
integer(int32)
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.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
409 Response
Conflict
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
412 Response
Precondition Failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
Unknown Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload