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

CreateNetworkLoadBalancer

post

/20200501/networkLoadBalancers

Creates a network load balancer.

Request

Supported Media Types
Header Parameters
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
  • 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).
Body ()
Details for the new network load balancer.
Root Schema : CreateNetworkLoadBalancerDetails
Type: object
The properties that define a network load balancer. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, then contact an administrator.
Show Source
  • backendSets
    Additional Properties Allowed: BackendSetDetails
    Backend sets associated with the network load balancer.
  • The OCID of the compartment containing the network load balancer.
  • definedTags
    Additional Properties Allowed: additionalProperties
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
  • Network load balancer identifier, which can be renamed.
  • freeformTags
    Additional Properties Allowed: additionalProperties
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
  • Default Value: false
    This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
  • Default Value: true
    Whether the network load balancer has a virtual cloud network-local (private) IP address. If "true", then the service assigns a private IP address to the network load balancer. If "false", then the service assigns a public IP address to the network load balancer. A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. This value is true by default. Example: true
  • listeners
    Additional Properties Allowed: ListenerDetails
    Listeners associated with the network load balancer.
  • networkSecurityGroupIds
    Maximum Number of Items: 5
    An array of OCIDs of network security groups associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"]
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV4_AND_IPV6" ]
    IP version associated with the NLB.
  • reservedIps
    Minimum Number of Items: 0
    Maximum Number of Items: 1
    An array of reserved Ips.
  • VnicShape for NLB. Example: VNICAAS_FIXED0400
  • Unique id of the shard where the VNIC will be allocated for the NLB. Example: test_shard1
  • The OCID of the subnet in which the network load balancer is spawned.
Nested Schema : backendSets
Type: object
Additional Properties Allowed
Show Source
  • BackendSetDetails
    The configuration of a network load balancer backend set. Avoid entering confidential information when you supply string values using the API.
Backend sets associated with the network load balancer.
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Nested Schema : listeners
Type: object
Additional Properties Allowed
Show Source
Listeners associated with the network load balancer.
Nested Schema : networkSecurityGroupIds
Type: array
Maximum Number of Items: 5
An array of OCIDs of network security groups associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"]
Show Source
Nested Schema : reservedIps
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1
An array of reserved Ips.
Show Source
  • ReservedIP
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
Nested Schema : BackendSetDetails
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
    An array of backends.
  • HealthChecker
    The health check policy configuration.
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV6" ]
    IP version associated with the backend set.
  • 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.
  • 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
Nested Schema : HealthChecker
Type: object
The health check policy configuration.
Show Source
  • 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" ]
    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 : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
Nested Schema : additionalProperties
Type: object
The value of the tag. Only string, integer, and boolean types are supported.
Nested Schema : ListenerDetails
Type: object
The listener's configuration.
Show Source
  • The name of the associated backend set.
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV6" ]
    IP version associated with the listener.
  • A user-friendly name for the listener. It must be unique and it cannot be changed.
  • The communication port for the listener. Example: 80
    Example: 0
  • Allowed Values: [ "ANY", "TCP", "UDP", "TCP_AND_UDP" ]
    The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP
Nested Schema : ReservedIP
Type: object
An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
Show Source
  • OCID of the reserved public IP address created with the virtual cloud network. Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API. Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address. Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer. Example: "ocid1.publicip.unique_ID"
Back to Top

Response

Supported Media Types

201 Response

Request accepted. The network load balancer will be created.
Headers
  • For optimistic concurrency control. See if-match.
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
  • Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
Body ()
Root Schema : NetworkLoadBalancer
Type: object
The properties that define a network load balancer. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator.
Show Source
  • backendSets
    Additional Properties Allowed: BackendSet
    Backend sets associated with the network load balancer.
  • The OCID of the compartment containing the network load balancer.
  • definedTags
    Additional Properties Allowed: additionalProperties
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
  • A user-friendly name, which does not need to be unique, and can be changed.
  • freeformTags
    Additional Properties Allowed: additionalProperties
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
  • The OCID of the network load balancer.
  • ipAddresses
    Unique Items Required: true
    An array of IP addresses.
  • Default Value: false
    When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
  • Default Value: true
    Whether the network load balancer has a virtual cloud network-local (private) IP address. If "true", then the service assigns a private IP address to the network load balancer. If "false", then the service assigns a public IP address to the network load balancer. A public network load balancer is accessible from the internet, depending the security list rules for your virtual cloudn network. This value is true by default. Example: true
  • A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
  • Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]
    The current state of the network load balancer.
  • listeners
    Additional Properties Allowed: Listener
    Listeners associated with the network load balancer.
  • networkSecurityGroupIds
    Maximum Number of Items: 5
    An array of network security groups OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"]
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV4_AND_IPV6" ]
    IP version associated with the NLB.
  • The OCID of the subnet in which the network load balancer is spawned."
  • systemTags
    Additional Properties Allowed: additionalProperties
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
  • The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
  • The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
Nested Schema : backendSets
Type: object
Additional Properties Allowed
Show Source
  • BackendSet
    The configuration of a network load balancer backend set. Avoid entering confidential information when you supply string values using the API.
Backend sets associated with the network load balancer.
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : ipAddresses
Type: array
Unique Items Required: true
An array of IP addresses.
Show Source
Nested Schema : listeners
Type: object
Additional Properties Allowed
Show Source
Listeners associated with the network load balancer.
Nested Schema : networkSecurityGroupIds
Type: array
Maximum Number of Items: 5
An array of network security groups OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access. Example: ["ocid1.nsg.unique_ID"]
Show Source
Nested Schema : systemTags
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
Nested 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.
  • 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.
  • 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
  • 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" ]
    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 : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing a defined tag key and value, scoped to a namespace.
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the string type is supported.
Nested Schema : IpAddress
Type: object
A load balancer IP address.
Show Source
  • An IP address. Example: 192.168.0.3
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV6" ]
    IP version associated with this IP address.
  • Whether the IP address is public or private. If true, then the IP address is public and accessible from the internet. If false, then the IP address is private and accessible only from within the associated virtual cloud network.
  • ReservedIP
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
Nested Schema : ReservedIP
Type: object
An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
Show Source
  • OCID of the reserved public IP address created with the virtual cloud network. Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API. Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address. Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer. Example: "ocid1.publicip.unique_ID"
Nested Schema : Listener
Type: object
The congfiguration of the listener.
Show Source
  • The name of the associated backend set.
  • Default Value: IPV4
    Allowed Values: [ "IPV4", "IPV6" ]
    IP version associated with the listener.
  • A friendly name for the listener. It must be unique and it cannot be changed.
  • The communication port for the listener. Example: 80
    Example: 0
  • Allowed Values: [ "ANY", "TCP", "UDP", "TCP_AND_UDP" ]
    The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the ListNetworkLoadBalancersProtocols operation. Example: TCP
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
The value of the tag. Only string, integer and boolean types are supported.
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the String type is supported.

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source

409 Response

Conflict
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source

412 Response

Precondition Failed
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
Back to Top