Jump to

• Request
• Response

Create a Listener

post

/20170115/loadBalancers/{load_balancer_id}/listeners

Add a listener to a load balancer.

Request

Supported Media Types

• application/json

Path Parameters

• loadBalancerId(required): string
  The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a listener.

Query Parameters

• isLockOverride: boolean
  Whether to override locks (if any exist).

  Default Value: false

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 for the load balancer. This value can be obtained from a GET or POST response for any resource of that load balancer. For example, the eTag returned by getListener can be specified as the ifMatch for updateRuleSets. The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value. Example: `example-etag`

  Default Value:
• opc-request-id: string
  The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  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).

Body ()

Details to add a listener.

Root Schema : CreateListenerDetails

Type: object

The configuration of the listener.

Show Source

• defaultBackendSetName(required): string
  The name of the associated backend set.
• internalProxyProtocolOptions: array internalProxyProtocolOptions
  Unique Items Required: true

  An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: ["VCN_ID"]
• ipVersion: string
  Default Value: IPV4

  Allowed Values: [ "IPV4", "IPV6" ]

  IP version associated with the listener.
• isApplicationOffloadEnabled: boolean
  Default Value: false

  Property to enable/disable Application Offload feature for the NLB. If enabled, NLB will use listener port to forward the packet to application's backends.
• isPpv2Enabled: boolean
  Default Value: false

  Property to enable/disable PPv2 feature for this listener.
• isSgwNatIpTlvTypeOverrideEnabled: boolean
  Default Value: false

  Override to use 0xE1 custom TLV for encoding Class E IP Address in IP Options. (Default is 0xE2)
• name(required): string
  A user-friendly name for the listener. It must be unique and it cannot be changed.
• port(required): integer(int32)
  The communication port for the listener.

  Example: 0
• protocol(required): string
  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](#/en/NetworkLoadBalancer/20200501/networkLoadBalancerProtocol/ListNetworkLoadBalancersProtocols) operation. Example: TCP
• tcpIdleTimeout: integer(int32)
  The duration for TCP idle timeout Example: `200`

  Example: 200
• udpIdleTimeout: integer(int32)
  The duration for UDP idle timeout Example: `200`

  Example: 200

{
    "type":"object",
    "required":[
        "name",
        "defaultBackendSetName",
        "port",
        "protocol"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"A user-friendly name for the listener. It must be unique and it cannot be changed."
        },
        "defaultBackendSetName":{
            "type":"string",
            "description":"The name of the associated backend set."
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "example":0,
            "description":"The communication port for the listener."
        },
        "protocol":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ListenerProtocols",
            "enum":[
                "ANY",
                "TCP",
                "UDP",
                "TCP_AND_UDP"
            ],
            "description":"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](#/en/NetworkLoadBalancer/20200501/networkLoadBalancerProtocol/ListNetworkLoadBalancersProtocols) operation. Example: TCP "
        },
        "ipVersion":{
            "description":"IP version associated with the listener.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/IpVersion",
            "enum":[
                "IPV4",
                "IPV6"
            ],
            "default":"IPV4"
        },
        "isPpv2Enabled":{
            "description":"Property to enable/disable PPv2 feature for this listener.",
            "type":"boolean",
            "default":false
        },
        "internalProxyProtocolOptions":{
            "type":"array",
            "uniqueItems":true,
            "description":"An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: [\"VCN_ID\"] ",
            "items":{
                "$ref":"#/definitions/MetadataOptions"
            }
        },
        "isSgwNatIpTlvTypeOverrideEnabled":{
            "description":"Override to use 0xE1 custom TLV for encoding Class E IP Address in IP Options. (Default is 0xE2)",
            "type":"boolean",
            "default":false
        },
        "tcpIdleTimeout":{
            "type":"integer",
            "format":"int32",
            "example":200,
            "description":"The duration for TCP idle timeout Example: `200` "
        },
        "udpIdleTimeout":{
            "type":"integer",
            "format":"int32",
            "example":200,
            "description":"The duration for UDP idle timeout Example: `200` "
        },
        "isApplicationOffloadEnabled":{
            "description":"Property to enable/disable Application Offload feature for the NLB. If enabled, NLB will use listener port to forward the packet to application's backends. ",
            "type":"boolean",
            "default":false
        }
    },
    "description":"The configuration of the listener.",
    "x-example":"{   \"defaultBackendSetName\": \"example_backend_set\",   \"port\": 80,   \"protocol\": \"TCP\",   \"name\": \"example_listener\" } "
}

Nested Schema : internalProxyProtocolOptions

Type: array

Unique Items Required: true

An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: ["VCN_ID"]

Show Source

• Array of: string
  Allowed Values: [ "VCN_ID", "SGW_PE_NAT_IP", "VCN_OCID", "PE_OCID", "SGW_OCID" ]

  TLV type for the PPv2 feature.

{
    "type":"array",
    "uniqueItems":true,
    "description":"An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: [\"VCN_ID\"] ",
    "items":{
        "$ref":"#/definitions/MetadataOptions"
    }
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

The request was accepted for processing.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• opc-work-request-id: string
  The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

412 Response

Precondition Failed

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top