openapi: 3.2.0 info: description: This describes the network load balancer API. title: Network Load Balancer API version: '20200501' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/78ad56a04afca985945937d703d0d391f468fbef6049606759dccdd3804b2f9f.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the NetworkLoadBalancer API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/78ad56a04afca985945937d703d0d391f468fbef6049606759dccdd3804b2f9f.yaml what: the harvested document for NetworkLoadBalancer API servers: - url: /20200501 tags: - name: networkLoadBalancer paths: /networkLoadBalancers: get: description: 'Returns a list of network load balancers. ' operationId: ListNetworkLoadBalancers parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: A page of network load balancer objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkLoadBalancerCollection' summary: Retrieves a list of all network load balancers in a compartment tags: - networkLoadBalancer x-example: 'GET /20200501/networkLoadBalancers?compartmentId=<compartment_OCID> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkLoadBalancer' post: description: 'Creates a network load balancer. ' operationId: CreateNetworkLoadBalancer parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 201: description: Request accepted. The network load balancer will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkLoadBalancer' summary: Creates a network load balancer. tags: - networkLoadBalancer x-related-resource: '#/definitions/NetworkLoadBalancer' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNetworkLoadBalancerDetails' description: Details for the new network load balancer. required: true /networkLoadBalancers/health: get: description: Lists the summary health statuses for all network load balancers in the specified compartment. operationId: ListNetworkLoadBalancerHealths parameters: - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieved the health status information. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkLoadBalancerHealthCollection' summary: List network load balancers health tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/health Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkLoadBalancerHealth' /networkLoadBalancers/{networkLoadBalancerId}: delete: description: Deletes a network load balancer resource by identifier. operationId: DeleteNetworkLoadBalancer parameters: - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted. The network load balancer will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Delete a provisioned network load balancer tags: - networkLoadBalancer x-example: 'DELETE /20200501/networkLoadBalancers/<network_load_balancer_OCID> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkLoadBalancer' get: description: Retrieves network load balancer configuration information by identifier. operationId: GetNetworkLoadBalancer parameters: - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the network load balancer with the given identifier. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkLoadBalancer' summary: Get network load balancer tags: - networkLoadBalancer x-example: 'GET /20200501/networkLoadBalancers/<network_load_balancer_OCID> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the network load balancer operationId: UpdateNetworkLoadBalancer parameters: - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Update the network load balancer identified by the id tags: - networkLoadBalancer x-example: "PUT /20200501/networkLoadBalancers/<network_load_balancer_OCID>\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"displayName\": \"example_network_load_balancer\"\n}\n" x-related-resource: '#/definitions/NetworkLoadBalancer' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNetworkLoadBalancerDetails' description: The information to be updated. required: true /networkLoadBalancers/{networkLoadBalancerId}/actions/changeCompartment: post: description: 'Moves a network load balancer into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeNetworkLoadBalancerCompartment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: The request to move the network load balancer to a different compartment was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Change network load balancer compartment tags: - networkLoadBalancer x-example: "POST /20200501/networkLoadBalancers/<network_load_balancer_OCID>/changeCompartment\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/NetworkLoadBalancer' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeNetworkLoadBalancerCompartmentDetails' description: The configuration details for moving a network load balancer to a different compartment. required: true /networkLoadBalancers/{networkLoadBalancerId}/backendSets: get: description: Lists all backend sets associated with a given network load balancer. operationId: ListBackendSets parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the list of backend sets associated with the network load balancer. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendSetCollection' summary: List backend sets tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/BackendSetSummary' post: description: Adds a backend set to a network load balancer. operationId: CreateBackendSet parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Create backend set tags: - networkLoadBalancer x-example: "POST /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"name\": \"example_backend_set\",\n \"policy\": \"FIVE_TUPLE\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n}\n" x-related-resource: '#/definitions/BackendSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackendSetDetails' description: The details for adding a backend set. required: true /networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}: delete: description: 'Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the network load balancer. Before you can delete a backend set, you must remove it from any active listeners. ' operationId: DeleteBackendSet parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the backend set to delete. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Delete backend set tags: - networkLoadBalancer x-example: 'DELETE /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/BackendSet' get: description: Retrieves the configuration information for the specified backend set. operationId: GetBackendSet parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - description: 'The name of the backend set to retrieve. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the backend set information. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendSet' summary: Get backend set tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates a backend set. operationId: UpdateBackendSet parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the backend set to update. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Update backend set tags: - networkLoadBalancer x-example: "PUT /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"policy\": \"FIVE_TUPLE\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n}\n" x-related-resource: '#/definitions/BackendSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackendSetDetails' description: The details to update a backend set. required: true /networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends: get: description: Lists the backend servers for a given network load balancer and backend set. operationId: ListBackends parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - description: 'The name of the backend set associated with the backend servers. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the list of backends associated with backend sets of a network load balancer. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendCollection' summary: List backends tags: - networkLoadBalancer x-example: 'GET /networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/backends Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/BackendSummary' post: description: Adds a backend server to a backend set. operationId: CreateBackend parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the backend set to which to add the backend server. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Create backend tags: - networkLoadBalancer x-example: "POST /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/backends\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n}\n" x-related-resource: '#/definitions/Backend' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackendDetails' description: The details to add a backend server to a backend set. required: true /networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}: delete: description: Removes a backend server from a given network load balancer and backend set. operationId: DeleteBackend parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the backend set associated with the backend server. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string - description: 'The name of the backend server to remove. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080` ' in: path name: backendName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Delete backend tags: - networkLoadBalancer x-example: 'DELETE /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Backend' get: description: Retrieves the configuration information for the specified backend server. operationId: GetBackend parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - description: 'The name of the backend set that includes the backend server. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string - description: 'The name of the backend server to retrieve. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080` ' in: path name: backendName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the backend server information. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backend' summary: Get backend tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the configuration of a backend server within the specified backend set. operationId: UpdateBackend parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the backend set associated with the backend server. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string - description: 'The name of the backend server to update. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080` ' in: path name: backendName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Update backend tags: - networkLoadBalancer x-example: "PUT /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name>\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n}\n" x-related-resource: '#/definitions/Backend' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackendDetails' description: Details for updating a backend server. required: true /networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/health: get: description: Retrieves the current health status of the specified backend server. operationId: GetBackendHealth parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - description: 'The name of the backend set associated with the backend server for which to retrieve the health status. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string - description: 'The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080` ' in: path name: backendName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieved the health status information. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendHealth' summary: Get backend health tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name>/health Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/operationalStatus: get: description: Retrieves the current operational status of the specified backend server. operationId: GetBackendOperationalStatus parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - description: 'The name of the backend set associated with the backend server for which to retrieve the operational status. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string - description: 'The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080` ' in: path name: backendName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieved the backend operational status information. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendOperationalStatus' summary: Get backend operational status tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name>/operationalStatus Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/health: get: description: Retrieves the health status for the specified backend set. operationId: GetBackendSetHealth parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - description: 'The name of the backend set for which to retrieve the health status. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieved the health status information. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendSetHealth' summary: Get backend set health tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/health Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/healthChecker: get: description: Retrieves the health check policy information for a given network load balancer and backend set. operationId: GetHealthChecker parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - description: 'The name of the backend set associated with the health check policy to be retrieved. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the health check policy information. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HealthChecker' summary: Get health checker tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/healthChecker Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the health check policy for a given network load balancer and backend set. operationId: UpdateHealthChecker parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the backend set associated with the health check policy to be retrieved. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Update health checker tags: - networkLoadBalancer x-example: "PUT /20200105/networkLoadBalancers/<network_load_balancer_OCID>/backendSets/<backend_set_name>/healthChecker\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n}\n" x-related-resource: '#/definitions/HealthChecker' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHealthCheckerDetails' description: The health check policy configuration details. required: true /networkLoadBalancers/{networkLoadBalancerId}/health: get: description: Retrieves the health status for the specified network load balancer. operationId: GetNetworkLoadBalancerHealth parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieved the health status information. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkLoadBalancerHealth' summary: Get network load balancer health tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/health Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkLoadBalancerHealth' /networkLoadBalancers/{networkLoadBalancerId}/listeners: get: description: Lists all listeners associated with a given network load balancer. operationId: ListListeners parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the list of listeners associated with the network load balancer. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListenerCollection' summary: List Listeners tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/listeners Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListenerSummary' post: description: Adds a listener to a network load balancer. operationId: CreateListener parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: ETag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Create Listener tags: - networkLoadBalancer x-example: "POST /20200501/networkLoadBalancers/<network_load_balancer_OCID>/listeners\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"name\": \"example_listener\"\n}\n" x-related-resource: '#/definitions/Listener' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListenerDetails' description: Details to add a listener. required: true /networkLoadBalancers/{networkLoadBalancerId}/listeners/{listenerName}: delete: description: Deletes a listener from a network load balancer. operationId: DeleteListener parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the listener to delete. Example: `example_listener` ' in: path name: listenerName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: ETag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Delete listener tags: - networkLoadBalancer x-example: 'DELETE /20200501/networkLoadBalancers/<network_load_balancer_OCID>/listeners/<listener_name> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Listener' get: description: Retrieves listener properties associated with a given network load balancer and listener name. operationId: GetListener parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - description: 'The name of the listener to get. Example: `example_listener` ' in: path name: listenerName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the listener information. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Listener' summary: Get listener tags: - networkLoadBalancer x-example: 'GET /20200105/networkLoadBalancers/<network_load_balancer_OCID>/listeners/<listener_name> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates a listener for a given network load balancer. operationId: UpdateListener parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - description: 'The name of the listener to update. Example: `example_listener` ' in: path name: listenerName required: true schema: type: string responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Update listener tags: - networkLoadBalancer x-example: "PUT /20200501/networkLoadBalancers/<network_load_balancer_OCID>/listeners/<listener_name>\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\"\n}\n" x-related-resource: '#/definitions/Listener' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListenerDetails' description: Details to update a listener. required: true /networkLoadBalancers/{networkLoadBalancerId}/networkSecurityGroups: put: description: Updates the network security groups associated with the specified network load balancer. operationId: UpdateNetworkSecurityGroups parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkLoadBalancerIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 202: description: Request accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Update Network Security Groups tags: - networkLoadBalancer x-example: "PUT /20200501/networkLoadBalancers/<network_load_balancer_OCID>/networkSecurityGroups\nHost: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"networkSecurityGroupIds\": [\n \"ocid1.networksecuritygroup.oc1.phx.<unique_ID1>\",\n \"ocid1.networksecuritygroup.oc1.phx.<unique_ID2>\"\n ]\n}\n" x-related-resource: '#/definitions/NetworkLoadBalancer' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNetworkSecurityGroupsDetails' description: The details for updating the network security groups associated with the specified network load balancer. required: true /networkLoadBalancersPolicies: get: description: Lists the available network load balancer policies. operationId: ListNetworkLoadBalancersPolicies parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the list of network load balancers policies. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkLoadBalancersPolicyCollection' summary: List policies tags: - networkLoadBalancer x-example: 'GET /20200501/networkLoadBalancersPolicies/compartmentId=<compartment_OCID> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkLoadBalancingPolicy' /networkLoadBalancersProtocols: get: deprecated: true description: 'This API has been deprecated so it won''t return the updated list of supported protocls. Lists all supported traffic protocols. ' operationId: ListNetworkLoadBalancersProtocols parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the list of protocols supported by network load balancer. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkLoadBalancersProtocolCollection' summary: List protocols tags: - networkLoadBalancer x-example: 'GET /20200501/networkLoadBalancersProtocols?compartmentId=<compartment_OCID> Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListenerProtocols' /workRequests: get: description: Lists all work requests. operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the list of work requests for all network load balancers. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' summary: List workrequests tags: - networkLoadBalancer x-example: 'GET /20200501/workRequests/ Host: network-load-balancer-api.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Retrieves the details of the work request with the given identifier. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: The details of the work request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/WorkRequest' summary: Get workrequest status tags: - networkLoadBalancer x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: Retrieving the list of work requests errors for the network load balancer. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' summary: Lists workrequest errors tags: - networkLoadBalancer x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' summary: Lists workrequest logs tags: - networkLoadBalancer x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: NetworkLoadBalancerIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update. in: path name: networkLoadBalancerId required: true schema: type: string default: '' PaginationTokenQueryParam: description: 'The page token representing the page from which to start retrieving results. For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page required: false schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - displayName default: timeCreated IfNoneMatchHeader: description: '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` ' in: header name: if-none-match required: false x-default-description: 'null' schema: type: string default: '' CompartmentIdQueryParam: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list. ' in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: '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 will be updated or deleted only if the etag you provide matches the current etag value of the resource. ' in: header name: if-match required: false x-default-description: 'null' schema: type: string default: '' FilterByDisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page or items to return, in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit required: false schema: type: integer default: 10 maximum: 1000 minimum: 1 WorkRequestIdPathParam: description: The identifier of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' (ascending) or 'desc' (descending). in: query name: sortOrder required: false x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC RetryTokenHeader: description: 'A token that uniquely identifies a request so that it can be retried in case of a timeout or server error without risk of rerunning that same action. Retry tokens expire after 24 hours but they 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 might be rejected. ' in: header name: opc-retry-token required: false x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 FilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED RequestIdHeader: description: 'The unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' in: header name: opc-request-id required: false x-default-description: 'null' schema: type: string schemas: BackendSetDetails: description: 'The configuration of a network load balancer backend set. For more information about backend set configuration, see [Backend Sets for Network Load Balancers](/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: areOperationallyActiveBackendsPreferred: default: false description: "If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. \nThe new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.\n" type: boolean backends: description: 'An array of backends. ' items: $ref: '#/components/schemas/Backend' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthChecker' ipVersion: default: IPV4 description: IP version associated with the backend set. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isInstantFailoverTcpResetEnabled: default: true description: "This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. \nIf disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.\n" type: boolean isPreserveSource: default: true description: '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. ' type: boolean policy: default: FIVE_TUPLE description: 'The network load balancer policy for the backend set. Example: `FIVE_TUPLE` ' enum: - TWO_TUPLE - THREE_TUPLE - FIVE_TUPLE type: string x-obmcs-top-level-enum: '#/definitions/NetworkLoadBalancingPolicy' required: - healthChecker type: object x-example: "{\n \"name\": \"example_backend_set\",\n \"policy\": \"FIVE_TUPLE\",\n \"ipVersion\": \"IPV4\",\n \"isInstantFailoverTcpResetEnabled\": true,\n \"areOperationallyActiveBackendsPreferred\": true,\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n },\n {\n \"id\": \"ocid1.privateip..oc1.<unique_ID>\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n}\n" BackendCollection: description: Wrapper object for an array of BackendSummary objects. properties: items: description: An array of BackendSummary objects. items: $ref: '#/components/schemas/BackendSummary' type: array type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message BackendHealth: description: 'The health status of the specified backend server. ' properties: healthCheckResults: description: 'A list of the most recent health check results returned for the specified backend server. ' items: $ref: '#/components/schemas/HealthCheckResult' type: array status: description: 'The general health status of the specified backend server. * **OK:** All health check probes return `OK` * **WARNING:** At least one of the health check probes does not return `OK` * **CRITICAL:** None of the health check probes return `OK`. * * **UNKNOWN:** One of the health checks probes return `UNKNOWN`, * or the system is unable to retrieve metrics at this time. ' enum: - OK - WARNING - CRITICAL - UNKNOWN type: string required: - status - healthCheckResults type: object x-example: "{\n \"status\": \"OK\",\n \"healthCheckResults\": [\n {\n \"timestamp\": \"2020-05-09T21:58:11.417Z\",\n \"healthCheckStatus\": \"OK\"\n }\n ]\n}\n" NetworkLoadBalancersPolicySummary: description: Summary of network load balancing policy enum: - TWO_TUPLE - THREE_TUPLE - FIVE_TUPLE type: string BackendSetSummary: description: 'The configuration of a network load balancer backend set. For more information about backend set configuration, see [Backend Sets for Network Load Balancers](/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: areOperationallyActiveBackendsPreferred: default: false description: "If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. \nThe new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.\n" type: boolean backends: description: 'An array of backends. ' items: $ref: '#/components/schemas/Backend' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthChecker' ipVersion: default: IPV4 description: IP version associated with the backend set. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isInstantFailoverTcpResetEnabled: default: true description: "This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. \nIf disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.\n" type: boolean isPreserveSource: default: true description: '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. ' type: boolean name: description: '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. Example: `example_backend_set` ' type: string policy: default: FIVE_TUPLE description: 'The network load balancer policy for the backend set. Example: `FIVE_TUPLE` ' enum: - TWO_TUPLE - THREE_TUPLE - FIVE_TUPLE type: string x-obmcs-top-level-enum: '#/definitions/NetworkLoadBalancingPolicy' required: - name - policy - backends - healthChecker type: object x-example: "{\n \"name\": \"example_backend_set\",\n \"policy\": \"FIVE_TUPLE\",\n \"isInstantFailoverTcpResetEnabled\": true,\n \"areOperationallyActiveBackendsPreferred\": true,\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"ipVersion\": \"IPV4\",\n \"isOffline\": false\n },\n {\n \"id\": \"ocid1.privateip..oc1.<unique_ID>\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"ipVersion\": \"IPV4\",\n \"isOffline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"retries\": 3,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n}\n" ListenerCollection: description: Wrapper object for an array of ListenerSummary objects. properties: items: description: Array of ListenerSummary objects. items: $ref: '#/components/schemas/ListenerSummary' type: array type: object CreateListenerDetails: description: 'The configuration of the listener. For more information about listener configuration, see [Listeners for Network Load Balancers](/Content/NetworkLoadBalancer/Listeners/listener-management.htm). ' properties: defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' type: string ipVersion: default: IPV4 description: IP version associated with the listener. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isPpv2Enabled: default: false description: Property to enable/disable PPv2 feature for this listener. type: boolean l3IpIdleTimeout: description: 'The duration for L3IP idle timeout in seconds. Example: `200` ' example: 200 format: int32 type: integer name: description: 'A friendly name for the listener. It must be unique and it cannot be changed. Example: `example_listener` ' type: string port: description: 'The communication port for the listener. Example: `80` ' example: 0 format: int32 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: `TCP` ' enum: - ANY - TCP - UDP - TCP_AND_UDP - L3IP type: string x-obmcs-top-level-enum: '#/definitions/ListenerProtocols' tcpIdleTimeout: description: 'The duration for TCP idle timeout in seconds. Example: `300` ' example: 300 format: int32 type: integer udpIdleTimeout: description: 'The duration for UDP idle timeout in seconds. Example: `120` ' example: 120 format: int32 type: integer required: - name - defaultBackendSetName - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"TCP\",\n \"name\": \"example_listener\"\n}\n" WorkRequestCollection: description: Wrapper object for an array of WorkRequest objects. properties: items: description: An array of WorkRequest objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array type: object BackendSetHealth: description: 'The health status details for a backend set. This object does not explicitly enumerate backend servers with a status of `OK`. However, the backend sets are included in the `totalBackendCount` sum. ' properties: criticalStateBackendNames: description: 'A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by IP address and port. Example: `10.0.0.4:8080` ' items: type: string type: array status: description: 'Overall health status of the backend set. * **OK:** All backend servers in the backend set return a status of `OK`. * **WARNING:** Half or more of the backend servers in a backend set return a status of `OK` and at least one backend server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`. * **CRITICAL:** Fewer than half of the backend servers in a backend set return a status of `OK`. * **UNKNOWN:** If no probes have yet been sent to the backends, or the system is unable to retrieve metrics from the backends. ' enum: - OK - WARNING - CRITICAL - UNKNOWN type: string totalBackendCount: description: 'The total number of backend servers in this backend set. Example: `7` ' type: integer unknownStateBackendNames: description: 'A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by IP address and port. Example: `10.0.0.5:8080` ' items: type: string type: array warningStateBackendNames: description: 'A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by IP address or OCID and port. Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080` ' items: type: string type: array required: - status - warningStateBackendNames - criticalStateBackendNames - unknownStateBackendNames - totalBackendCount type: object x-example: "{\n \"status\": \"WARNING\",\n \"warningStateBackendNames\": [\n \"10.0.0.3:8080\"\n ],\n \"criticalStateBackendNames\": [\n \"10.0.0.4:8080\"\n ],\n \"unknownStateBackendNames\": [\n \"ocid1.privateip..oc1.<unique_ID>\"\n ],\n \"totalBackendCount\": 7\n}\n" CreateBackendDetails: description: 'The configuration of a backend server that is a member of a network load balancer backend set. For more information, see [Backend Servers for Network Load Balancers](/Content/NetworkLoadBalancer/BackendServers/backend-server-management.htm). ' properties: ipAddress: description: 'The IP address of the backend server. Example: `10.0.0.3` ' type: string x-default-description: If the targetId is not specified and the IP address is also not specified, then this is an invalid backend. isBackup: default: false description: '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` ' type: boolean isDrain: default: false description: "Whether the network load balancer should drain this server. \nServers marked \"isDrain\" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated.\n\nExample: `false`\n" type: boolean isOffline: default: false description: 'Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean name: description: 'Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: `webServer1` ' type: string port: description: 'The communication port for the backend server. Example: `8080` ' format: int32 type: integer targetId: description: 'The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` ' type: string weight: description: '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''. For more information about network load balancer policies, see [Network Load Balancer Policies](/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` ' format: int32 type: integer required: - port type: object x-example: "{\n \"name\": \"example_backend\",\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n}\n" ReservedIP: description: 'An object representing a reserved IP address to be attached or that is already attached to a network load balancer. ' properties: id: description: '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.oc1.phx.unique_ID" ' type: string type: object NetworkLoadBalancersProtocolCollection: description: 'This object is deprecated. Wrapper object for array of ProtocolSummary objects. ' properties: items: description: Array of NetworkLoadBalancersProtocolSummary objects. items: $ref: '#/components/schemas/NetworkLoadBalancersProtocolSummary' type: array type: object NetworkLoadBalancerHealth: description: 'The health status details for the specified network load balancer. This object does not explicitly enumerate backend sets with a status of `OK`. However, the backend sets are included in the `totalBackendSetCount` sum. ' properties: criticalStateBackendSetNames: description: 'A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: `example_backend_set` ' items: type: string type: array status: description: "The overall health status of the network load balancer.\n\n* **OK:** All backend sets associated with the network load balancer return a status of `OK`.\n\n* **WARNING:** At least one of the backend sets associated with the network load balancer returns a status of `WARNING`,\nno backend sets return a status of `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.\n\n* **CRITICAL:** One or more of the backend sets associated with the network load balancer return a status of `CRITICAL`.\n\n* **UNKNOWN:** If any one of the following conditions is true:\n\n * The network load balancer life cycle state is not `ACTIVE`.\n\n * No backend sets are defined for the network load balancer.\n\n * More than half of the backend sets associated with the network load balancer return a status of `UNKNOWN`, none of the backend\n sets return a status of `WARNING` or `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.\n\n * The system could not retrieve metrics for any reason.\n" enum: - OK - WARNING - CRITICAL - UNKNOWN type: string totalBackendSetCount: description: 'The total number of backend sets associated with this network load balancer. Example: `4` ' type: integer unknownStateBackendSetNames: description: 'A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: `example_backend_set2` ' items: type: string type: array warningStateBackendSetNames: description: 'A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the user-friendly name you assigned when you created the backend set. Example: `example_backend_set3` ' items: type: string type: array required: - status - warningStateBackendSetNames - criticalStateBackendSetNames - unknownStateBackendSetNames - totalBackendSetCount type: object x-example: "{\n \"status\": \"CRITICAL\",\n \"warningStateBackendSetNames\": [\n \"example_backend_set3\"\n ],\n \"criticalStateBackendSetNames\": [\n \"example_backend_set\"\n ],\n \"unknownStateBackendSetNames\": [\n \"example_backend_set2\"\n ],\n \"totalBackendSetCount\": 4\n}\n" NetworkLoadBalancersPolicyCollection: description: Wrapper object for array of NetworkLoadBalancersPolicySummary objects. properties: items: description: Array of NetworkLoadBalancersPolicySummary objects. items: $ref: '#/components/schemas/NetworkLoadBalancersPolicySummary' type: array type: object HealthCheckResult: description: 'Information about a single backend server health check result reported by a network load balancer. ' properties: healthCheckStatus: description: 'The result of the most recent health check. ' enum: - OK - INVALID_STATUS_CODE - TIMED_OUT - HEALTH_PAYLOAD_MISMATCH - CONNECT_FAILED - UNKNOWN type: string timestamp: description: 'The date and time the data was retrieved, in the format defined by RFC3339. Example: `2020-05-01T18:28:11+00:00` ' format: date-time type: string required: - timestamp - healthCheckStatus type: object x-example: "{\n \"timestamp\": \"2020-05-01T21:58:11.417Z\",\n \"healthCheckStatus\": \"OK\"\n}\n" HealthChecker: description: 'The health check policy configuration. For more information, see [Editing Network Load Balancer Health Check Policies](/Content/NetworkLoadBalancer/HealthCheckPolicies/update-health-check-policy.htm). ' properties: intervalInMillis: description: 'The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: `10000` ' format: int32 type: integer port: description: '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' format: int32 type: integer protocol: description: 'The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: `HTTP` ' enum: - HTTP - HTTPS - TCP - UDP type: string x-obmcs-top-level-enum: '#/definitions/HealthCheckProtocols' requestData: description: Base64 encoded pattern to be sent as UDP or TCP health check probe. format: byte type: string responseBodyRegex: description: 'A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` ' type: string responseData: description: Base64 encoded pattern to be validated as UDP or TCP health check probe response. format: byte type: string retries: description: '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. Example: `3` ' format: int32 type: integer returnCode: description: '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: `200` ' example: 0 format: int32 type: integer timeoutInMillis: description: '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). Example: `3000` ' format: int32 type: integer urlPath: description: 'The path against which to run the health check. Example: `/healthcheck` ' type: string required: - protocol type: object x-example: "{\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"retries\": 3,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n} or\n{\n \"protocol\": \"UDP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"retries\": 3,\n \"requestData\": \"4wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",\n \"responseData\": \"JA==\"\n}\n" NetworkLoadBalancerHealthSummary: description: A health status summary for the specified network load balancer properties: networkLoadBalancerId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer with which the health status is associated. ' type: string status: description: "The overall health status of the network load balancer.\n\n* **OK:** All backend sets associated with the network load balancer return a status of `OK`.\n\n* **WARNING:** At least one of the backend sets associated with the network load balancer returns a status of `WARNING`,\nno backend sets return a status of `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.\n\n* **CRITICAL:** One or more of the backend sets associated with the network load balancer returns a status of `CRITICAL`.\n\n* **UNKNOWN:** If any one of the following conditions is true:\n\n * The network load balancer life cycle state is not `ACTIVE`.\n\n * No backend sets are defined for the network load balancer.\n\n * More than half of the backend sets associated with the network load balancer return a status of `UNKNOWN`, none of the backend\n sets returns a status of `WARNING` or `CRITICAL`, and the network load balancer life cycle state is `ACTIVE`.\n\n * The system could not retrieve metrics for any reason.\n" enum: - OK - WARNING - CRITICAL - UNKNOWN type: string required: - networkLoadBalancerId - status type: object x-example: "{\n \"networkLoadBalancerId\": \"ocid1.networkloadbalancer.oc1.phx.<unique_ID>\",\n \"status\": \"OK\"\n}\n" WorkRequestResource: description: A resource that a work request creates or on which the work request operates. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point the resource transitions to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type that the work request affects. type: string entityUri: description: The URI path on which the user can perform a GET request to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier IpAddress: description: A load balancer IP address. properties: ipAddress: description: 'An IP address. Example: `192.168.0.3` ' type: string ipVersion: default: IPV4 description: IP version associated with this IP address. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isPublic: description: '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. ' type: boolean reservedIp: $ref: '#/components/schemas/ReservedIP' required: - ipAddress x-example: "{\n \"ipAddress\": \"192.168.0.3\",\n \"isPublic\": false\n}\n" UpdateHealthCheckerDetails: description: The configuration details of the health checker. properties: intervalInMillis: description: 'The interval between health checks, in milliseconds. Example: `10000` ' format: int32 maximum: 1800000.0 minimum: 1000.0 type: integer port: description: 'The backend server port against which to run the health check. Example: `8080` ' format: int32 maximum: 65535.0 minimum: 0.0 type: integer protocol: description: 'The protocol that the health check must use; either HTTP, UDP, or TCP. Example: `HTTP` ' enum: - HTTP - HTTPS - TCP - UDP type: string x-obmcs-top-level-enum: '#/definitions/HealthCheckProtocols' requestData: description: Base64 encoded pattern to be sent as UDP or TCP health check probe. format: byte type: string responseBodyRegex: description: 'A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` ' type: string responseData: description: Base64 encoded pattern to be validated as UDP or TCP health check probe response. format: byte type: string retries: description: '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. Example: `3` ' format: int32 type: integer returnCode: description: '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: `200` ' example: 0 format: int32 type: integer timeoutInMillis: description: '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. Example: `3000` ' format: int32 maximum: 600000.0 minimum: 1.0 type: integer urlPath: description: 'The path against which to run the health check. Example: `/healthcheck` ' type: string type: object x-example: "{\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"retries\": 3,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n}\n" CreateBackendSetDetails: description: 'The configuration details for creating a backend set in a network load balancer. For more information about backend set configuration, see [Backend Sets for Network Load Balancers](/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: areOperationallyActiveBackendsPreferred: default: false description: "If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. \nThe new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.\n" type: boolean backends: description: An array of backends to be associated with the backend set. items: $ref: '#/components/schemas/BackendDetails' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthCheckerDetails' ipVersion: default: IPV4 description: IP version associated with the backend set. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isInstantFailoverTcpResetEnabled: default: true description: "This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. \nIf disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.\n" type: boolean isPreserveSource: default: true description: '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. ' type: boolean name: description: '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. Example: `example_backend_set` ' maxLength: 32 minLength: 1 type: string policy: default: FIVE_TUPLE description: 'The network load balancer policy for the backend set. Example: `FIVE_TUPLE`` ' enum: - TWO_TUPLE - THREE_TUPLE - FIVE_TUPLE type: string x-obmcs-top-level-enum: '#/definitions/NetworkLoadBalancingPolicy' required: - name - policy - healthChecker type: object x-example: "{\n \"name\": \"example_backend_set\",\n \"policy\": \"FIVE_TUPLE\",\n \"ipVersion\": \"IPV4\",\n \"isInstantFailoverTcpResetEnabled\": false,\n \"areOperationallyActiveBackendsPreferred\": true,\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n}\n" BackendSummary: description: 'The configuration of a backend server that is a member of a network load balancer backend set. For more information, see [Backend Servers for Network Load Balancers](/Content/NetworkLoadBalancer/BackendServers/backend-server-management.htm). ' properties: ipAddress: description: 'The IP address of the backend server. Example: `10.0.0.3` ' type: string x-default-description: If the targetId is not specified and the IP address is also not specified, then this is an invalid backend. isBackup: default: false description: '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` ' type: boolean isDrain: default: false description: "Whether the network load balancer should drain this server. \nServers marked \"isDrain\" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out.\n\nExample: `false`\n" type: boolean isOffline: default: false description: 'Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean name: description: 'A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<unique_ID>:443` or `10.0.0.3:0` ' type: string port: description: 'The communication port for the backend server. Example: `8080` ' format: int32 type: integer targetId: description: 'The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` ' type: string weight: description: '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''. For more information about network load balancing policies, see [Network Load Balancer Policies](/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` ' format: int32 type: integer required: - port type: object x-example: "{\n \"name\": \"example_backend\",\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n}\n" BackendSetCollection: description: Wrapper object for an array of `BackendSetSummary` objects. properties: items: description: An array of `BackendSetSummary` objects. items: $ref: '#/components/schemas/BackendSetSummary' type: array type: object NetworkLoadBalancer: description: 'The properties that define a network load balancer. For more information, see [Introduction to Network Load Balancer](/Content/NetworkLoadBalancer/introduction.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who writes policies to give users access, then see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). For information about endpoints and signing API requests, see [About the API](/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](/Content/API/Concepts/sdks.htm). ' properties: backendSets: additionalProperties: $ref: '#/components/schemas/BackendSet' description: Backend sets associated with the network load balancer. type: object compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name, which does not have to be unique, and can be changed. Example: `example_load_balancer` ' type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer. type: string ipAddresses: description: 'An array of IP addresses. ' items: $ref: '#/components/schemas/IpAddress' type: array uniqueItems: true isPreserveSourceDestination: default: false description: '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. ' type: boolean isPrivate: default: true description: '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](/Content/network/Concepts/securitylists.htm) for your virtual cloudn network. For more information about public and private network load balancers, see [Network Load Balancer Types](/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. Example: `true` ' type: boolean lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. ' type: string lifecycleState: description: The current state of the network load balancer. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' listeners: additionalProperties: $ref: '#/components/schemas/Listener' description: Listeners associated with the network load balancer. type: object networkSecurityGroupIds: description: "An array of network security groups [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the network load\nbalancer.\n\nDuring the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.\n\nThe benefits of associating the network load balancer with network security groups include:\n\n* Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.\n\n* The network security rules of other resources can reference the network security groups associated with the network load balancer\n to ensure access.\n\nExample: [\"ocid1.nsg.oc1.phx.unique_ID\"]\n" items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array nlbIpVersion: default: IPV4 description: IP version associated with the NLB. enum: - IPV4 - IPV4_AND_IPV6 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/NlbIpVersion' securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'ZPR tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{ "oracle-zpr": { "td": { "value": "42", "mode": "audit" } } }` ' type: object subnetId: description: The subnet in which the network load balancer is spawned [OCIDs](/Content/General/Concepts/identifiers.htm). type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object timeCreated: description: 'The date and time the network load balancer was created, in the format defined by RFC3339. Example: `2020-05-01T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: `2020-05-01T22:10:29.600Z` ' format: date-time type: string x-default-description: This value is the value of the timeCreated parameter, if no other action after create has been taken on the resource. required: - id - compartmentId - displayName - lifecycleState - timeCreated - ipAddresses - subnetId type: object x-example: "{\n \"id\": \"ocid1.networkloadbalancer.oc1.phx.<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_network_load_balancer\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2020-05-01T21:10:29.600Z\",\n \"isPrivate\": true,\n \"isPreserveSourceDestination\": false,\n \"ipAddress\": \"192.168.0.3\",\n \"listeners\": {\n \"exampleListener\": {\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n },\n },\n \"backendSets\": {\n \"example_backend_set\": {\n \"policy\": \"FIVE_TUPLE\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n },\n },\n \"subnetId\": \"ocid1.subnet.oc1.phx.<unique_ID>\",\n}\n" WorkRequestErrorCollection: description: Wrapper object for an array of WorkRequestErrorSummary objects. properties: items: description: An array of WorkRequestErrorSummary objects. items: $ref: '#/components/schemas/WorkRequestError' type: array type: object BackendOperationalStatus: description: 'The operational status of the specified backend server. ' properties: status: description: 'The operational status. ' enum: - ACTIVE - STANDBY - UNKNOWN type: string required: - status type: object x-example: "{\n \"status\": \"ACTIVE\",\n}\n" NetworkLoadBalancersProtocolSummary: description: 'This object is deprecated. Protocols supported for the listener of the network load balancer. ' enum: - ANY - TCP - UDP - TCP_AND_UDP - L3IP type: string WorkRequestSummary: description: Summary of work request object. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests are scoped to the same compartment as the resource that the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, then the service team must choose the primary resource whose compartment is to be used. ' type: string id: description: The identifier of the work request. type: string operationType: description: Type of work request. enum: - CREATE_NETWORK_LOAD_BALANCER - UPDATE_NETWORK_LOAD_BALANCER - DELETE_NETWORK_LOAD_BALANCER - CREATE_BACKEND - UPDATE_BACKEND - DELETE_BACKEND - CREATE_LISTENER - UPDATE_LISTENER - DELETE_LISTENER - CREATE_BACKENDSET - UPDATE_BACKENDSET - DELETE_BACKENDSET - UPDATE_NSGS - UPDATE_HEALTH_CHECKER - CHANGE_COMPARTMENT - ATTACH_NLB_TO_POD - DETACH_NLB_FROM_POD - LIVE_MIGRATION type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time that the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time that the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time that the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted type: string ListenerDetails: description: 'The listener''s configuration. For more information about listener configuration, see [Listeners for Network Load Balancers](/Content/NetworkLoadBalancer/Listeners/listener-management.htm). ' properties: defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' type: string ipVersion: default: IPV4 description: IP version associated with the listener. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isPpv2Enabled: default: false description: Property to enable/disable PPv2 feature for this listener. type: boolean l3IpIdleTimeout: description: 'The duration for L3IP idle timeout in seconds. Example: `200` ' example: 200 format: int32 type: integer name: description: 'A friendly name for the listener. It must be unique and it cannot be changed. Example: `example_listener` ' type: string port: description: 'The communication port for the listener. Example: `80` ' example: 0 format: int32 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: `TCP` ' enum: - ANY - TCP - UDP - TCP_AND_UDP - L3IP type: string x-obmcs-top-level-enum: '#/definitions/ListenerProtocols' tcpIdleTimeout: description: 'The duration for TCP idle timeout in seconds. Example: `300` ' example: 300 format: int32 type: integer udpIdleTimeout: description: 'The duration for UDP idle timeout in seconds. Example: `120` ' example: 120 format: int32 type: integer required: - name - defaultBackendSetName - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"TCP\",\n \"name\": \"example_listener\"\n}\n" NetworkLoadBalancerHealthCollection: description: Wrapper object for an array of NetworkLoadBalancerHealthSummary objects. properties: items: description: An array of BackendSetSummary objects. items: $ref: '#/components/schemas/NetworkLoadBalancerHealthSummary' type: array type: object ChangeNetworkLoadBalancerCompartmentDetails: description: 'The configuration details for moving a network load balancer to a different compartment. **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which to move the network load balancer. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" Listener: description: 'The congfiguration of the listener. For more information about listener configuration, see [Listeners for Network Load Balancers](/Content/NetworkLoadBalancer/Listeners/listener-management.htm). ' properties: defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' type: string ipVersion: default: IPV4 description: IP version associated with the listener. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isPpv2Enabled: default: false description: Property to enable/disable PPv2 feature for this listener. type: boolean l3IpIdleTimeout: description: 'The duration for L3IP idle timeout in seconds. Example: `200` ' example: 200 format: int32 type: integer name: description: 'A friendly name for the listener. It must be unique and it cannot be changed. Example: `example_listener` ' type: string port: description: 'The communication port for the listener. Example: `80` ' example: 0 format: int32 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: `TCP` ' enum: - ANY - TCP - UDP - TCP_AND_UDP - L3IP type: string x-obmcs-top-level-enum: '#/definitions/ListenerProtocols' tcpIdleTimeout: description: 'The duration for TCP idle timeout in seconds. Example: `300` ' example: 300 format: int32 type: integer udpIdleTimeout: description: 'The duration for UDP idle timeout in seconds. Example: `120` ' example: 120 format: int32 type: integer required: - name - defaultBackendSetName - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"TCP\",\n \"name\": \"example_listener\"\n}\n" WorkRequestError: description: An error encountered while running a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed here: (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human-readable description of the issue encountered. type: string timestamp: description: The time the error occured in the form of an RFC3339 formatted date-time string. format: date-time type: string required: - code - message - timestamp NetworkLoadBalancerCollection: description: Wrapper object for an array of NetworkLoadBalancerSummary objects. properties: items: description: Array of NetworkLoadBalancerSummary objects. items: $ref: '#/components/schemas/NetworkLoadBalancerSummary' type: array type: object UpdateNetworkLoadBalancerDetails: description: 'Configuration details to update a network load balancer. **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: assignedIpv6: description: 'IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789" ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, and scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The user-friendly display name for the network load balancer, which does not have to be unique and can be changed. Avoid entering confidential information. Example: `example_network_load_balancer` ' maxLength: 1024 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isPreserveSourceDestination: default: false description: '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. ' type: boolean nlbIpVersion: default: IPV4 description: IP version associated with the NLB. enum: - IPV4 - IPV4_AND_IPV6 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/NlbIpVersion' securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'ZPR tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}` ' type: object subnetIpv6Cidr: description: IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this. type: string type: object x-example: "{\n \"displayName\": \"example_network_load_balancer\"\n}\n" ListenerSummary: description: 'The configuration of the listener. For more information about listener configuration, see [Listeners for Network Load Balancers](/Content/NetworkLoadBalancer/Listeners/listener-management.htm). ' properties: defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' type: string ipVersion: default: IPV4 description: IP version associated with the listener. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isPpv2Enabled: default: false description: Property to enable/disable PPv2 feature for this listener. type: boolean l3IpIdleTimeout: description: 'The duration for L3IP idle timeout in seconds. Example: `200` ' example: 200 format: int32 type: integer name: description: 'A friendly name for the listener. It must be unique and it cannot be changed. Example: `example_listener` ' type: string port: description: 'The communication port for the listener. Example: `80` ' example: 0 format: int32 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: `TCP` ' enum: - ANY - TCP - UDP - TCP_AND_UDP - L3IP type: string x-obmcs-top-level-enum: '#/definitions/ListenerProtocols' tcpIdleTimeout: description: 'The duration for TCP idle timeout in seconds. Example: `300` ' example: 300 format: int32 type: integer udpIdleTimeout: description: 'The duration for UDP idle timeout in seconds. Example: `120` ' example: 120 format: int32 type: integer required: - name - defaultBackendSetName - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"TCP\",\n \"name\": \"example_listener\"\n}\n" UpdateNetworkSecurityGroupsDetails: description: 'An object representing an updated list of network security groups that overwrites the existing list of network security groups. * If the network load balancer has no configured network security groups, then the network load balancer uses the network security groups in this list. * If the network load balancer has a list of configured network security groups, then this list replaces the existing list. * If the network load balancer has a list of configured network security groups and this list is empty, then the operation removes all of the network security groups associated with the network load balancer.' properties: networkSecurityGroupIds: description: "An array of network security group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the network load\nbalancer.\n\nDuring the creation of the network load balancer, the service adds the new network load balancer to the specified network security groups.\n\nThe benefits of associating the network load balancer with network security groups include:\n\n* Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.\n\n* The network security rules of other resources can reference the network security groups associated with the network load balancer\n to ensure access.\n" items: maxLength: 255 minLength: 1 type: string uniqueItems: true maxItems: 5 type: array type: object x-example: "{\n \"networkSecurityGroupIds\": [\n \"ocid1.networksecuritygroup.oc1.phx.<unique_ID1>\",\n \"ocid1.networksecuritygroup.oc1.phx.<unique_ID2>\"\n ]\n}\n" UpdateBackendDetails: description: The configuration details for updating a backend server. properties: isBackup: default: false description: '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` ' type: boolean isDrain: default: false description: "Whether the network load balancer should drain this server. \nServers marked \"isDrain\" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out.\n\nExample: `false`\n" type: boolean isOffline: default: false description: 'Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean weight: description: 'The 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''. For more information about network load balancer policies, see [Network Load Balancer Policies](/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` ' format: int32 type: integer type: object x-example: "{\n \"weight\": 4,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n}\n" UpdateBackendSetDetails: description: 'The configuration details for updating a load balancer backend set. For more information about backend set configuration, see [Backend Sets for Network Load Balancers](/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: areOperationallyActiveBackendsPreferred: description: "If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. \nThe new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.\n" type: boolean backends: description: An array of backends associated with the backend set. items: $ref: '#/components/schemas/BackendDetails' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthCheckerDetails' ipVersion: default: IPV4 description: The IP version associated with the backend set. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isInstantFailoverTcpResetEnabled: description: "This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. \nIf disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.\n" type: boolean isPreserveSource: default: true description: '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. ' type: boolean policy: default: FIVE_TUPLE description: 'The network load balancer policy for the backend set. To get a list of available policies, use the [ListNetworkLoadBalancersPolicies](#/en/networkloadbalancer/20200501/networkLoadBalancerPolicy/ListNetworkLoadBalancersPolicies) operation. Example: `FIVE_TUPLE` ' type: string type: object x-example: "{\n \"policy\": \"FIVE_TUPLE\",\n \"isInstantFailoverTcpResetEnabled\": false,\n \"areOperationallyActiveBackendsPreferred\": true,\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n}\n" UpdateListenerDetails: description: 'The configuration of the listener. For more information about listeners, see [Listeners for Network Load Balancers](/Content/NetworkLoadBalancer/Listeners/listener-management.htm). ' properties: defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' type: string ipVersion: default: IPV4 description: IP version associated with the listener. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isPpv2Enabled: default: false description: Property to enable/disable PPv2 feature for this listener. type: boolean l3IpIdleTimeout: description: 'The duration for L3IP idle timeout in seconds. Example: `200` ' example: 200 format: int32 type: integer port: description: 'The communication port for the listener. Example: `80` ' example: 0 format: int32 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: `TCP` ' enum: - ANY - TCP - UDP - TCP_AND_UDP - L3IP type: string x-obmcs-top-level-enum: '#/definitions/ListenerProtocols' tcpIdleTimeout: description: 'The duration for TCP idle timeout in seconds. Example: `300` ' example: 300 format: int32 type: integer udpIdleTimeout: description: 'The duration for UDP idle timeout in seconds. Example: `120` ' example: 120 format: int32 type: integer type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"TCP\",\n \"name\": \"example_listener\"\n}\n" HealthCheckerDetails: description: 'The health check policy configuration. For more information, see [Editing Network Load Balancer Health Check Policies](/Content/NetworkLoadBalancer/HealthCheckPolicies/update-health-check-policy.htm). ' properties: intervalInMillis: default: 10000 description: 'The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: `10000` ' format: int32 type: integer port: description: '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' format: int32 type: integer protocol: description: 'The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: `HTTP` ' enum: - HTTP - HTTPS - TCP - UDP type: string x-obmcs-top-level-enum: '#/definitions/HealthCheckProtocols' requestData: description: Base64 encoded pattern to be sent as UDP or TCP health check probe. format: byte type: string responseBodyRegex: description: 'A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` ' type: string responseData: description: Base64 encoded pattern to be validated as UDP or TCP health check probe response. format: byte type: string retries: default: 3 description: '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. Example: `3` ' format: int32 type: integer returnCode: description: '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: `200` ' example: 200 format: int32 type: integer timeoutInMillis: default: 3000 description: '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). Example: `3000` ' format: int32 type: integer urlPath: description: 'The path against which to run the health check. Example: `/healthcheck` ' type: string required: - protocol type: object x-example: "{\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"retries\": 3,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n} or\n{\n \"protocol\": \"UDP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"retries\": 3,\n \"requestData\": \"4wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",\n \"responseData\": \"JA==\"\n}\n" Backend: description: 'The configuration of a backend server that is a member of a network load balancer backend set. For more information, see [Backend Servers for Network Load Balancers](/Content/NetworkLoadBalancer/BackendServers/backend-server-management.htm). ' properties: ipAddress: description: 'The IP address of the backend server. Example: `10.0.0.3` ' type: string x-default-description: If the targetId is not specified and the IP address is also not specified, then this is an invalid backend. isBackup: default: false description: '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` ' type: boolean isDrain: default: false description: "Whether the network load balancer should drain this server. \nServers marked \"isDrain\" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out.\n\nExample: `false`\n" type: boolean isOffline: default: false description: 'Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean name: description: 'A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<unique_ID>:443` or `10.0.0.3:0` ' type: string port: description: 'The communication port for the backend server. Example: `8080` ' format: int32 type: integer targetId: description: 'The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` ' type: string weight: description: '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''. For more information about network load balancing policies, see [Network Load Balancer Policies](/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` ' format: int32 type: integer required: - port type: object x-example: "{\n \"name\": \"example_backend\",\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n}\n" WorkRequestLogEntry: description: A log message from the running of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written displayed as an RFC3339 formatted date-time string. format: date-time type: string required: - message - timestamp BackendDetails: description: The network network load balancing configuration details of a backend server. properties: ipAddress: description: 'The IP address of the backend server. Example: `10.0.0.3` ' type: string x-default-description: If the targetId is not specified and the IP address is also not specified, then this is an invalid backend. isBackup: default: false description: '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` ' type: boolean isDrain: default: false description: "Whether the network load balancer should drain this server. \nServers marked \"isDrain\" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out.\n\nExample: `false`\n" type: boolean isOffline: default: false description: 'Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean name: description: 'A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<unique_ID>:443` or `10.0.0.3:0` ' type: string port: description: 'The communication port for the backend server. Example: `8080` ' format: int32 maximum: 65535.0 minimum: 0.0 type: integer targetId: description: 'The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` ' type: string weight: default: 1.0 description: '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''. For more information about load balancing policies, see [Network Load Balancer Policies](/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` ' format: int32 maximum: 100.0 minimum: 1.0 type: integer required: - port type: object x-example: "{\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"ipVersion\": \"IPV4\",\n \"isOffline\": false\n}\n" CreateNetworkLoadBalancerDetails: description: 'The properties that define a network load balancer. For more information, see [Introduction to Network Load Balancer](/Content/NetworkLoadBalancer/introduction.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, then contact an administrator. If you are an administrator who writes policies to give users access, then see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). For information about endpoints and signing API requests, see [About the API](/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](/Content/API/Concepts/sdks.htm). ' properties: assignedIpv6: description: 'IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789" ' type: string assignedPrivateIpv4: description: 'Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1" ' type: string backendSets: additionalProperties: $ref: '#/components/schemas/BackendSetDetails' description: Backend sets associated with the network load balancer. type: object compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Network load balancer identifier, which can be renamed. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isPreserveSourceDestination: default: false description: '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. ' type: boolean isPrivate: default: true description: '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](/Content/network/Concepts/securitylists.htm) for your virtual cloud network. For more information about public and private network load balancers, see [Network Load Balancer Types](/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. Example: `true` ' type: boolean listeners: additionalProperties: $ref: '#/components/schemas/ListenerDetails' description: Listeners associated with the network load balancer. type: object networkSecurityGroupIds: description: "An array of network security groups [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the network load\nbalancer.\n\nDuring the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.\n\nThe benefits of associating the network load balancer with network security groups include:\n\n* Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.\n\n* The network security rules of other resources can reference the network security groups associated with the network load balancer\n to ensure access.\n\nExample: [\"ocid1.nsg.oc1.phx.unique_ID\"]\n" items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array nlbIpVersion: default: IPV4 description: IP version associated with the NLB. enum: - IPV4 - IPV4_AND_IPV6 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/NlbIpVersion' reservedIps: description: 'An array of reserved Ips. ' items: $ref: '#/components/schemas/ReservedIP' maxItems: 1 minItems: 0 type: array securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'ZPR tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}` ' type: object subnetId: description: The subnet in which the network load balancer is spawned [OCIDs](/Content/General/Concepts/identifiers.htm). type: string subnetIpv6Cidr: description: IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this. type: string required: - compartmentId - displayName - subnetId x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_network_load_balancer\",\n \"ipAddress\": \"192.168.0.3\",\n \"isPrivate\": true,\n \"isPreserveSourceDestination\": false,\n \"nlbIpVersion\": \"IPV4_AND_IPV6\",\n \"listeners\": {\n \"exampleListener\": {\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n },\n },\n \"backendSets\": {\n \"example_backend_set\": {\n \"policy\": \"FIVE_TUPLE\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n },\n },\n \"subnetId\": \"ocid1.subnet.oc1.phx.<unique_ID>\",\n}\n" BackendSet: description: 'The configuration of a network load balancer backend set. For more information about backend set configuration, see [Backend Sets for Network Load Balancers](/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm). **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: areOperationallyActiveBackendsPreferred: default: false description: "If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. \nThe new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.\n" type: boolean backends: description: 'An array of backends. ' items: $ref: '#/components/schemas/Backend' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthChecker' ipVersion: default: IPV4 description: IP version associated with the backend set. enum: - IPV4 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/IpVersion' isInstantFailoverTcpResetEnabled: default: true description: "This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. \nIf disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.\n" type: boolean isPreserveSource: default: true description: '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. ' type: boolean name: description: '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. Example: `example_backend_set` ' type: string policy: default: FIVE_TUPLE description: 'The network load balancer policy for the backend set. Example: `FIVE_TUPLE` ' enum: - TWO_TUPLE - THREE_TUPLE - FIVE_TUPLE type: string x-obmcs-top-level-enum: '#/definitions/NetworkLoadBalancingPolicy' required: - name - healthChecker type: object x-example: "{\n \"name\": \"example_backend_set\",\n \"policy\": \"FIVE_TUPLE\",\n \"ipVersion\": \"IPV4\",\n \"isInstantFailoverTcpResetEnabled\": false,\n \"areOperationallyActiveBackendsPreferred\": true,\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n },\n {\n \"id\": \"ocid1.privateip..oc1.<unique_ID>\",\n \"port\": 8080,\n \"isBackup\": false,\n \"isDrain\": false,\n \"isOffline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"port\": 8080,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"urlPath\": \"/healthcheck\",\n \"returnCode\": 200,\n \"retries\": 3,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n}\n" WorkRequestLogEntryCollection: description: Wrapper object for an array of WorkRequestLogEntry objects. properties: items: description: An array of WorkRequestLogEntry objects. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array type: object WorkRequest: description: A description of work request status. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests are scoped to the same compartment as the resource that the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, then the service team must choose the primary resource whose compartment is to be used. ' type: string id: description: The identifier of the work request. type: string operationType: description: Type of work request. enum: - CREATE_NETWORK_LOAD_BALANCER - UPDATE_NETWORK_LOAD_BALANCER - DELETE_NETWORK_LOAD_BALANCER - CREATE_BACKEND - UPDATE_BACKEND - DELETE_BACKEND - CREATE_LISTENER - UPDATE_LISTENER - DELETE_LISTENER - CREATE_BACKENDSET - UPDATE_BACKENDSET - DELETE_BACKENDSET - UPDATE_NSGS - UPDATE_HEALTH_CHECKER - CHANGE_COMPARTMENT - ATTACH_NLB_TO_POD - DETACH_NLB_FROM_POD - LIVE_MIGRATION type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time that the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time that the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time that the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted NetworkLoadBalancerSummary: description: Network load balancer object to be used for list operations. properties: backendSets: additionalProperties: $ref: '#/components/schemas/BackendSet' description: Backend sets associated with the network load balancer. type: object compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name, which does not have to be unique, and can be changed. Example: `example_load_balancer` ' type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer. type: string ipAddresses: description: 'An array of IP addresses. ' items: $ref: '#/components/schemas/IpAddress' type: array uniqueItems: true isPreserveSourceDestination: default: false description: '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. ' type: boolean isPrivate: default: true description: '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](/Content/network/Concepts/securitylists.htm) for your virtual cloudn network. For more information about public and private network load balancers, see [Network Load Balancer Types](/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. Example: `true` ' type: boolean lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. ' type: string lifecycleState: description: The current state of the network load balancer. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' listeners: additionalProperties: $ref: '#/components/schemas/Listener' description: Listeners associated with the network load balancer. type: object networkSecurityGroupIds: description: "An array of network security groups [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the network load\nbalancer.\n\nDuring the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.\n\nThe benefits of associating the network load balancer with network security groups include:\n\n* Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.\n\n* The network security rules of other resources can reference the network security groups associated with the network load balancer\n to ensure access.\n\nExample: [\"ocid1.nsg.oc1.phx.unique_ID\"]\n" items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array nlbIpVersion: default: IPV4 description: IP version associated with the NLB. enum: - IPV4 - IPV4_AND_IPV6 - IPV6 type: string x-obmcs-top-level-enum: '#/definitions/NlbIpVersion' securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'ZPR tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{ "oracle-zpr": { "td": { "value": "42", "mode": "audit" } } }` ' type: object subnetId: description: The subnet in which the network load balancer is spawned [OCIDs](/Content/General/Concepts/identifiers.htm). type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object timeCreated: description: 'The date and time the network load balancer was created, in the format defined by RFC3339. Example: `2020-05-01T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: `2020-05-01T22:10:29.600Z` ' format: date-time type: string x-default-description: This value is the value of the timeCreated parameter, if no other action after create has been taken on the resource. required: - id - compartmentId - ipAddresses - subnetId - lifecycleState - displayName - timeCreated type: object x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-properties: areOperationallyActiveBackendsPreferred: default: false description: "If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. \nThe new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.\n" type: boolean assignedIpv6: description: 'IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789" ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isFailOpen: default: false description: '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. ' type: boolean isInstantFailoverEnabled: description: 'If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. ' type: boolean isInstantFailoverTcpResetEnabled: default: true description: "This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. \nIf disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.\n" type: boolean l3IpIdleTimeout: description: 'The duration for L3IP idle timeout in seconds. Example: `200` ' example: 200 format: int32 type: integer securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'ZPR tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}` ' type: object subnetIpv6Cidr: description: IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this. type: string x-http_status: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' 409: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' 412: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier. ' type: string schema: $ref: '#/components/schemas/Error' x-obmcs-client-circuit-breaker-enabled: false x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.nlb