CreateBackend
post
/20170115/loadBalancers/{load_balancer_id}/backendSets/{backend_set_name}/backends
Adds a backend server to a backend set.
Request
Supported Media Types
- application/json
Path Parameters
-
backendSetName(required): string
The name of the backend set to add the backend server to. Example: example_backend_set
-
loadBalancerId(required): string
The OCID of the load balancer associated with the backend set and servers.
Header Parameters
-
if-match: string
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 is updated or deleted only if the ETag you provide matches the resource's current ETag value.Default Value:
-
opc-request-id: string
The unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.Default Value:
-
opc-retry-token: string
Minimum Length:
1
Maximum Length:64
A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
The details to add a backend server to a backend set.
Root Schema : CreateBackendDetails
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 CreateBackendDetails 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
Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
-
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'. Example: 3
Response
Supported Media Types
- application/json
204 Response
The request was accepted for processing.
Headers
-
ETag: string
For optimistic concurrency control. See if-match.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
-
opc-work-request-id: string
The OCID of the work request.
304 Response
Not Modified
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
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
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
An error has occurred.
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