openapi: 3.2.0 info: description: 'API for the Load Balancing service. Use this API to manage load balancers, backend sets, and related items. For more information, see [Overview of Load Balancing](/iaas/Content/Balance/Concepts/balanceoverview.htm). ' title: Load Balancing Load Balancer API version: '20170115' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/b6419140fb4ac827445b4aac56633924a590bd456e678229e1c16c1afbcb7227.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Load Balancing 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/b6419140fb4ac827445b4aac56633924a590bd456e678229e1c16c1afbcb7227.yaml what: the harvested document for Load Balancing API servers: - url: /20170115 tags: - name: loadBalancer paths: /loadBalancerHealths: get: description: Lists the summary health statuses for all load balancers in the specified compartment. operationId: ListLoadBalancerHealths parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - 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). Example: `50` ' in: query name: limit required: false schema: type: integer format: int64 default: 10 - description: '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). Example: `3` ' in: query name: page required: false schema: type: string - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to return health status information for. in: query name: compartmentId required: true schema: type: string responses: 200: description: The health status information was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/LoadBalancerHealthSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListLoadBalancerHealths tags: - loadBalancer x-example: 'GET /20170115/loadBalancerHealths Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancerPolicies: get: description: Lists the available load balancer policies. operationId: ListPolicies parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer policies to list. in: query name: compartmentId required: true schema: type: string - 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). Example: `50` ' in: query name: limit required: false schema: type: integer format: int64 default: 16 - description: '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). Example: `3` ' in: query name: page required: false schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/LoadBalancerPolicy' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPolicies tags: - loadBalancer x-example: 'GET /20170115/loadBalancerPolicies?compartmentId=<compartment_OCID> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancerProtocols: get: description: Lists all supported traffic protocols. operationId: ListProtocols parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer protocols to list. in: query name: compartmentId required: true schema: type: string - 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). Example: `50` ' in: query name: limit required: false schema: type: integer format: int64 default: 16 - description: '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). Example: `3` ' in: query name: page required: false schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/LoadBalancerProtocol' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListProtocols tags: - loadBalancer x-example: 'GET /20170115/loadBalancerProtocols?compartmentId=<compartment_OCID> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancerShapes: get: description: Lists the valid load balancer shapes. operationId: ListShapes parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer shapes to list. in: query name: compartmentId required: true schema: type: string - 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). Example: `50` ' in: query name: limit required: false schema: type: integer format: int64 default: 16 - description: '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). Example: `3` ' in: query name: page required: false schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/LoadBalancerShape' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListShapes tags: - loadBalancer x-example: 'GET /20170115/loadBalancerShapes?compartmentId=<compartment_OCID> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancerWorkRequests/{workRequestId}: get: description: Gets the details of a work request. operationId: GetWorkRequest parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request to retrieve. in: path name: workRequestId required: true schema: type: string responses: 200: description: The work request is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetWorkRequest tags: - loadBalancer x-example: 'GET /20170115/loadBalancerWorkRequests/<work_request_OCID> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancers: get: description: Lists all load balancers in the specified compartment. operationId: ListLoadBalancers parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - 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). Example: `50` ' in: query name: limit required: false schema: type: integer format: int64 default: 10 - description: '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). Example: `3` ' in: query name: page required: false schema: type: string - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to list. in: query name: compartmentId required: true schema: type: string - description: 'The level of detail to return for each result. Can be `full` or `simple`. Example: `full` ' in: query name: detail required: false schema: type: string default: full - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/LoadBalancer' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListLoadBalancers tags: - loadBalancer x-example: 'GET /20170115/loadBalancers?compartmentId=<compartment_OCID> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a new load balancer in the specified compartment. For general information about load balancers, see [Overview of the Load Balancing Service](/Content/Balance/Concepts/balanceoverview.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the load balancer to reside. Notice that the load balancer doesn''t have to be in the same compartment as the VCN or backend set. If you''re not sure which compartment to use, put the load balancer in the same compartment as the VCN. For information about access control and compartments, see [Overview of the IAM Service](/Content/Identity/Concepts/overview.htm). You must specify a display name for the load balancer. It does not have to be unique, and you can change it. For information about Availability Domains, see [Regions and Availability Domains](/Content/General/Concepts/regions.htm). To get a list of Availability Domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource''s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. Fore more information, see [Resource Identifiers](/Content/General/Concepts/identifiers.htm). After you send your request, the new object''s state will temporarily be PROVISIONING. Before using the object, first make sure its state has changed to RUNNING. When you create a load balancer, the system assigns an IP address. To get the IP address, use the [GetLoadBalancer](#/en/loadbalancer/20170115/LoadBalancer/GetLoadBalancer) operation. ' operationId: CreateLoadBalancer parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateLoadBalancer tags: - loadBalancer x-example: "POST /20170115/loadBalancers\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_load_balancer\",\n \"shapeName\": \"flexible\",\n \"shapeDetails\": {\n \"minimumBandwidthInMbps\": 10,\n \"maximumBandwidthInMbps\": 100\n },\n \"isPrivate\": true,\n \"ipMode\": \"IPV4\",\n isDeleteProtectionEnabled: true,\n\n \"listeners\": {\n \"exampleListener\": {\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n }\n },\n \"hostnames\": {\n \"example_hostname_001\": {\n \"name\": \"example_hostname_001\",\n \"hostname\": \"app.example.com\"\n },\n \"example_hostname_002\": {\n \"name\": \"example_hostname_002\",\n \"hostname\": \"app.example.*\"\n }\n },\n \"backendSets\": {\n \"example_backend_set\": {\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n },\n },\n \"certificates\": {\n \"example_certificate_bundle\": {\n \"passphrase\": \"<passphrase>\",\n \"privateKey\": \"<private_key>\",\n \"publicCertificate\": \"<public_certificate>\",\n \"caCertificate\": \"<ca_certificate>\",\n \"certificateName\": \"example_certificate_bundle\"\n }\n },\n \"sslCipherSuites\": {\n \"example_cipher_suite\": {\n \"ciphers\": [\n \"ECDHE-ECDSA-AES128-GCM-SHA256\",\n \"ECDHE-ECDSA-AES128-SHA256\",\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n ],\n \"name\": \"example_cipher_suite\"\n }\n },\n \"pathRouteSets\": {\n \"example_path_route_set\": {\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n }\n },\n \"ruleSets\": {\n \"example_rule_set\": {\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n }\n }\n },\n \"subnetIds\": [\n \"ocid1.subnet.oc1.phx.<unique_ID>\"\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLoadBalancerDetails' description: The configuration details for creating a load balancer. required: true /loadBalancers/{loadBalancerId}: delete: description: Stops a load balancer and removes it from service. operationId: DeleteLoadBalancer parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to delete. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request to delete the load balancer was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteLoadBalancer tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: Gets the specified load balancer's configuration information. operationId: GetLoadBalancer parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to retrieve. in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The configuration information is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LoadBalancer' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetLoadBalancer tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates a load balancer's configuration. operationId: UpdateLoadBalancer parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to update. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateLoadBalancer tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"displayName\": \"example_load_balancer\",\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLoadBalancerDetails' description: The details for updating a load balancer's configuration. required: true /loadBalancers/{loadBalancerId}/backendSets: get: description: Lists all backend sets associated with a given load balancer. operationId: ListBackendSets parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend sets to retrieve. in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BackendSet' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBackendSets tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: Adds a backend set to a load balancer. operationId: CreateBackendSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a backend set. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateBackendSet tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/backendSets\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"name\": \"example_backend_set\",\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyDepth\": \"3\",\n \"verifyPeerCertificate\": true\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackendSetDetails' description: The details for adding a backend set. required: true /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}: delete: description: 'Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the load balancer. Before you can delete a backend set, you must remove it from any active listeners. ' operationId: DeleteBackendSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the backend set to delete. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteBackendSet tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: Gets the specified backend set's configuration information. operationId: GetBackendSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the backend set to retrieve. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 200: description: The backend set information is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBackendSet tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates a backend set. operationId: UpdateBackendSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the backend set to update. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateBackendSet tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyDepth\": \"3\",\n \"verifyPeerCertificate\": true\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackendSetDetails' description: The details to update a backend set. required: true /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends: get: description: Lists the backend servers for a given load balancer and backend set. operationId: ListBackends parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. in: path name: loadBalancerId required: true schema: type: string - 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: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Backend' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBackends tags: - loadBalancer x-example: 'GET /loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: Adds a backend server to a backend set. operationId: CreateBackend parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the backend set to add the backend server to. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateBackend tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackendDetails' description: The details to add a backend server to a backend set. required: true /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}: delete: description: Removes a backend server from a given load balancer and backend set. operationId: DeleteBackend parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server. in: path name: loadBalancerId required: true schema: type: string - 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 IP address and port of the backend server to remove. Example: `10.0.0.3:8080` ' in: path name: backendName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteBackend tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: Gets the specified backend server's configuration information. operationId: GetBackend parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server. in: path name: loadBalancerId required: true schema: type: string - 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 IP address and port of the backend server to retrieve. Example: `10.0.0.3:8080` ' in: path name: backendName required: true schema: type: string responses: 200: description: The backend server information is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backend' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBackend tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the configuration of a backend server within the specified backend set. operationId: UpdateBackend parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server. in: path name: loadBalancerId required: true schema: type: string - 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 IP address and port of the backend server to update. Example: `10.0.0.3:8080` ' in: path name: backendName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateBackend tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackendDetails' description: Details for updating a backend server. required: true /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/health: get: description: Gets the current health status of the specified backend server. operationId: GetBackendHealth parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend server health status to be retrieved. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the backend set associated with the backend server to retrieve the health status for. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string - description: 'The IP address and port of the backend server to retrieve the health status for. Example: `10.0.0.3:8080` ' in: path name: backendName required: true schema: type: string responses: 200: description: The health status information was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendHealth' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BackendHealth tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name>/health Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/health: get: description: Gets the health status for the specified backend set. operationId: GetBackendSetHealth parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set health status to be retrieved. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the backend set to retrieve the health status for. Example: `example_backend_set` ' in: path name: backendSetName required: true schema: type: string responses: 200: description: The health status information was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BackendSetHealth' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BackendSetHealth tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/health Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker: get: description: Gets the health check policy information for a given load balancer and backend set. operationId: GetHealthChecker parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be retrieved. in: path name: loadBalancerId required: true schema: type: string - 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: 200: description: The health check policy information is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HealthChecker' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetHealthChecker tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/healthChecker Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the health check policy for a given load balancer and backend set. operationId: UpdateHealthChecker parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be updated. in: path name: loadBalancerId required: true schema: type: string - 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: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateHealthChecker tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/healthChecker\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHealthCheckerDetails' description: The health check policy configuration details. required: true /loadBalancers/{loadBalancerId}/certificates: get: description: Lists all SSL certificates bundles associated with a given load balancer. operationId: ListCertificates parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundles to be listed. ' in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Certificate' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCertificates tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/certificates Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: Creates an asynchronous request to add an SSL certificate bundle. operationId: CreateCertificate parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add the certificate bundle. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCertificate tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/certificates\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"passphrase\": \"<passphrase>\",\n \"privateKey\": \"<private_key>\",\n \"publicCertificate\": \"<public_certificate>\",\n \"caCertificate\": \"<ca_certificate>\",\n \"certificateName\": \"example_certificate_bundle\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCertificateDetails' description: The details of the certificate bundle to add. required: true /loadBalancers/{loadBalancerId}/certificates/{certificateName}: delete: description: Deletes an SSL certificate bundle from a load balancer. operationId: DeleteCertificate parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundle to be deleted. ' in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the certificate bundle to delete. Example: `example_certificate_bundle` ' in: path name: certificateName required: true schema: type: string maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_.-]*$ responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteCertificate tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/certificates/<certificate_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancers/{loadBalancerId}/changeCompartment: post: description: 'Moves a 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: ChangeLoadBalancerCompartment parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer to move. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request to move the load balancer to a different compartment was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeLoadBalancerCompartment tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/changeCompartment\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/LoadBalancer' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeLoadBalancerCompartmentDetails' description: The configuration details for moving a load balancer to a different compartment. required: true /loadBalancers/{loadBalancerId}/health: get: description: Gets the health status for the specified load balancer. operationId: GetLoadBalancerHealth parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to return health status for. in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The health status information was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LoadBalancerHealth' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: LoadBalancerHealth tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/health Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancers/{loadBalancerId}/hostnames: get: description: Lists all hostname resources associated with the specified load balancer. operationId: ListHostnames parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostnames to retrieve. ' in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Hostname' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListHostnames tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/hostnames Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Adds a hostname resource to the specified load balancer. For more information, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). ' operationId: CreateHostname parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the hostname to. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateHostname tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/hostnames\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"example_hostname_001\",\n \"hostname\": \"app.example.com\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostnameDetails' description: The details of the hostname resource to add to the specified load balancer. required: true /loadBalancers/{loadBalancerId}/hostnames/{name}: delete: description: 'Deletes a hostname resource from the specified load balancer. ' operationId: DeleteHostname parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostname to delete. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the hostname resource to delete. Example: `example_hostname_001` ' in: path name: name required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteHostname tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/hostnames/<name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: Gets the specified hostname resource's configuration information. operationId: GetHostname parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the hostname resource to retrieve. Example: `example_hostname_001` ' in: path name: name required: true schema: type: string responses: 200: description: The hostname information is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Hostname' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetHostname tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/hostnames/<name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a virtual hostname. ' operationId: UpdateHostname parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the virtual hostname to update. ' in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the hostname resource to update. Example: `example_hostname_001` ' in: path name: name required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateHostname tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/hostnames/<name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"hostname\": \"app.example.com\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHostnameDetails' description: The configuration details to update a virtual hostname. required: true /loadBalancers/{loadBalancerId}/listeners: post: description: Adds a listener to a load balancer. operationId: CreateListener parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a listener. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateListener tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/listeners\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"hostnameNames\": [\n \"example_hostname_001\",\n \"example_hostname_002\"\n ],\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n }\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n \"name\": \"example_listener\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListenerDetails' description: Details to add a listener. required: true /loadBalancers/{loadBalancerId}/listeners/{listenerName}: delete: description: Deletes a listener from a load balancer. operationId: DeleteListener parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to delete. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the listener to delete. Example: `example_listener` ' in: path name: listenerName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteListener tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/listeners/<listener_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates a listener for a given load balancer. operationId: UpdateListener parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to update. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the listener to update. Example: `example_listener` ' in: path name: listenerName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateListener tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/listeners/<listener_name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"hostnameNames\": [\n \"example_hostname_001\",\n \"example_hostname_002\"\n ],\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n }\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListenerDetails' description: Details to update a listener. required: true /loadBalancers/{loadBalancerId}/listeners/{listenerName}/rules: get: description: 'Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes the rules in the following order: * Access control rules * Allow method rules * Request header rules * Response header rules ' operationId: ListListenerRules parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the listener the rules are associated with. Example: `example_listener` ' in: path name: listenerName required: true schema: type: string responses: 200: description: The list of rules was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ListenerRuleSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListListenerRules tags: - loadBalancer x-example: 'GET /20170115//loadBalancers/<load_balancer_OCID>/listeners/<listener_name>/rules Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /loadBalancers/{loadBalancerId}/networkSecurityGroups: put: description: Updates the network security groups associated with the specified load balancer. operationId: UpdateNetworkSecurityGroups parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to update the NSGs for. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateNetworkSecurityGroups tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/networkSecurityGroups\nHost: iaas.us-phoenix-1.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/NetworkSecurityGroups' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNetworkSecurityGroupsDetails' description: The details for updating the NSGs associated with the specified load balancer. required: true /loadBalancers/{loadBalancerId}/pathRouteSets: get: deprecated: true description: Lists all path route sets associated with the specified load balancer. operationId: ListPathRouteSets parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route sets to retrieve. ' in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PathRouteSet' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPathRouteSets tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: deprecated: true description: 'Adds a path route set to a load balancer. For more information, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). ' operationId: CreatePathRouteSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the path route set to. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreatePathRouteSet tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"name\": \"example_path_route_set\",\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePathRouteSetDetails' description: The details of the path route set to add. required: true /loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}: delete: deprecated: true description: 'Deletes a path route set from the specified load balancer. To delete a path route rule from a path route set, use the [UpdatePathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/UpdatePathRouteSet) operation. ' operationId: DeletePathRouteSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to delete. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the path route set to delete. Example: `example_path_route_set` ' in: path name: pathRouteSetName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeletePathRouteSet tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets/<path_route_set_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: deprecated: true description: Gets the specified path route set's configuration information. operationId: GetPathRouteSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the path route set to retrieve. Example: `example_path_route_set` ' in: path name: pathRouteSetName required: true schema: type: string responses: 200: description: The path route set information is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PathRouteSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPathRouteSet tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets/<path_route_set_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: deprecated: true description: 'Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter path route rules in a path route set. To add a new path route rule to a path route set, the `pathRoutes` in the [UpdatePathRouteSetDetails](#/en/loadbalancer/20170115/requests/UpdatePathRouteSetDetails) object must include both the new path route rule to add and the existing path route rules to retain. ' operationId: UpdatePathRouteSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to update. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the path route set to update. Example: `example_path_route_set` ' in: path name: pathRouteSetName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdatePathRouteSet tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets/<path_route_set_name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePathRouteSetDetails' description: The configuration details to update a path route set. required: true /loadBalancers/{loadBalancerId}/routingPolicies: get: description: Lists all routing policies associated with the specified load balancer. operationId: ListRoutingPolicies parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policies. ' in: path name: loadBalancerId required: true schema: type: string - 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). Example: `50` ' in: query name: limit required: false schema: type: integer format: int64 default: 10 - description: '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). Example: `3` ' in: query name: page required: false schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/RoutingPolicy' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListRoutingPolicies tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Adds a routing policy to a load balancer. For more information, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). ' operationId: CreateRoutingPolicy parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the routing policy rule list to. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateRoutingPolicy tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"name\": \"example_routing_rules\",\n \"conditionLanguageVersion\": \"V1\",\n \"rules\": [\n {\n \"name\": \"HR_mobile_user_rule\",\n \"condition\" : \"all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))\",\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForHRMobileUsers\"\n }]\n },\n {\n \"name\": \"Documents_rule\",\n \"condition\" : \"any(http.request.url.path eq (i '/documents'), http.request.headers[(i 'host')] eq (i 'doc.myapp.com'))\",\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForDocuments\"\n }]\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRoutingPolicyDetails' description: The details of the routing policy rules to add. required: true /loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}: delete: description: 'Deletes a routing policy from the specified load balancer. To delete a routing rule from a routing policy, use the [UpdateRoutingPolicy](#/en/loadbalancer/20170115/RoutingPolicies/UpdateRoutingPolicy) operation. ' operationId: DeleteRoutingPolicy parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to delete. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the routing policy to delete. Example: `example_routing_policy` ' in: path name: routingPolicyName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteRoutingPolicy tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies/<routing_policy_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: Gets the specified routing policy. operationId: GetRoutingPolicy parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the routing policy to retrieve. Example: `example_routing_policy` ' in: path name: routingPolicyName required: true schema: type: string responses: 200: description: The routing policy requested. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RoutingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetRoutingPolicy tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies/<routing_policy_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Overwrites an existing routing policy on the specified load balancer. Use this operation to add, delete, or alter routing policy rules in a routing policy. To add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain. ' operationId: UpdateRoutingPolicy parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to update. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the routing policy to update. Example: `example_routing_policy_name` ' in: path name: routingPolicyName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateRoutingPolicy tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies/<routing_policy_name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"rules\": [\n {\n \"name\": \"HR_mobile_user_rule\",\n \"condition\": \"all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))\",\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForHRMobileUsers\"\n }]\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRoutingPolicyDetails' description: The configuration details needed to update a routing policy. required: true /loadBalancers/{loadBalancerId}/ruleSets: get: description: Lists all rule sets associated with the specified load balancer. operationId: ListRuleSets parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The set of rules is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/RuleSet' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListRuleSets tags: - loadBalancer x-example: 'GET /20170115//loadBalancers/<load_balancer_OCID>/ruleSets Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a new rule set associated with the specified load balancer. For more information, see [Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm). ' operationId: CreateRuleSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateRuleSet tags: - loadBalancer x-example: "POST /20170115//loadBalancers/<load_balancer_OCID>/ruleSets\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"name\": \"example_rule_set\",\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRuleSetDetails' description: The configuration details for the rule set to create. required: true /loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}: delete: description: 'Deletes a rule set from the specified load balancer. To delete a rule from a rule set, use the [UpdateRuleSet](#/en/loadbalancer/20170115/RuleSet/UpdateRuleSet) operation. ' operationId: DeleteRuleSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the rule set to delete. Example: `example_rule_set` ' in: path name: ruleSetName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteRuleSet tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/ruleSets/<rule_set_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: Gets the specified set of rules. operationId: GetRuleSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the rule set to retrieve. Example: `example_rule_set` ' in: path name: ruleSetName required: true schema: type: string responses: 200: description: The rule set is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RuleSet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetRuleSet tags: - loadBalancer x-example: 'GET /20170115//loadBalancers/<load_balancer_OCID>/ruleSets/<rule_set_name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter the rules in a rule set. To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain. ' operationId: UpdateRuleSet parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. in: path name: loadBalancerId required: true schema: type: string - description: 'The name of the rule set to update. Example: `example_rule_set` ' in: path name: ruleSetName required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateRuleSet tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/ruleSets/<rule_set_name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRuleSetDetails' description: The configuration details to update a set of rules. required: true /loadBalancers/{loadBalancerId}/sslCipherSuites: get: description: Lists all SSL cipher suites associated with the specified load balancer. operationId: ListSSLCipherSuites parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LoadBalancerIdPathParam' responses: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SSLCipherSuite' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSSLCipherSuites tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: Creates a custom SSL cipher suite. operationId: CreateSSLCipherSuite parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/LoadBalancerIdPathParam' responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateSSLCipherSuite tags: - loadBalancer x-example: "POST /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"ciphers\": [\"ECDHE-RSA-AES256-GCM-SHA384\", \"ECDHE-ECDSA-AES256-GCM-SHA384\", \"ECDHE-RSA-AES128-GCM-SHA256\"],\n \"name\": \"example_cipher_suite\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSSLCipherSuiteDetails' description: The details of the SSL cipher suite to add. required: true /loadBalancers/{loadBalancerId}/sslCipherSuites/{name}: delete: description: Deletes an SSL cipher suite from a load balancer. operationId: DeleteSSLCipherSuite parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LoadBalancerIdPathParam' - description: 'The name of the SSL cipher suite to delete. example: `example_cipher_suite` ' in: path name: name required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteSSLCipherSuite tags: - loadBalancer x-example: 'DELETE /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites/<name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: Gets the specified SSL cipher suite's configuration information. operationId: GetSSLCipherSuite parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LoadBalancerIdPathParam' - description: 'The name of the SSL cipher suite to retrieve. example: `example_cipher_suite` ' in: path name: name required: true schema: type: string responses: 200: description: The SSL cipher suite's configuration information is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SSLCipherSuite' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetSSLCipherSuite tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites/<name> Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates an existing SSL cipher suite for the specified load balancer. operationId: UpdateSSLCipherSuite parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/LoadBalancerIdPathParam' - description: 'The name of the SSL cipher suite to update. example: `example_cipher_suite` ' in: path name: name required: true schema: type: string responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateSSLCipherSuite tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites/<name>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"ciphers\": ['ECDHE-ECDSA-AES128-GCM-SHA256','ECDHE-RSA-AES128-GCM-SHA256']\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSSLCipherSuiteDetails' description: The configuration details to update an SSL cipher suite. required: true /loadBalancers/{loadBalancerId}/updateShape: put: description: 'Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the LB. The service will try to perform this operation in the least disruptive way to existing connections, but there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller bandwidth. ' operationId: UpdateLoadBalancerShape parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - $ref: '#/components/parameters/RetryTokenHeader' - description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer whose shape will be updated. in: path name: loadBalancerId required: true schema: type: string responses: 204: description: The request to change the load balancer to a different shape was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateLoadBalancerShape tags: - loadBalancer x-example: "PUT /20170115/loadBalancers/<load_balancer_OCID>/updateShape\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"shapeName\": \"Flexible\",\n \"shapeDetails\": {\n \"minimumBandwidthInMbps\": 150,\n \"maximumBandwidthInMbps\": 1500\n }\n}\n" x-related-resource: '#/definitions/LoadBalancer' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLoadBalancerShapeDetails' description: The details for updating a load balancer's shape. This contains the new, desired shape. required: true /loadBalancers/{loadBalancerId}/workRequests: get: description: Lists the work requests for a given load balancer. operationId: ListWorkRequests parameters: - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string default: '' - 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). Example: `50` ' in: query name: limit required: false schema: type: integer format: int64 default: 100 - description: '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). Example: `3` ' in: query name: page required: false schema: type: string - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the work requests to retrieve. in: path name: loadBalancerId required: true schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequest' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListWorkRequests tags: - loadBalancer x-example: 'GET /20170115/loadBalancers/<load_balancer_OCID>/workRequests Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' components: schemas: CreateLoadBalancerDetails: description: 'The configuration details for creating a load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: backendSets: additionalProperties: $ref: '#/components/schemas/BackendSetDetails' type: object certificates: additionalProperties: $ref: '#/components/schemas/CertificateDetails' type: object compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to create the load balancer. maxLength: 255 minLength: 1 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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: `example_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 hostnames: additionalProperties: $ref: '#/components/schemas/HostnameDetails' type: object ipMode: default: IPV4 description: 'Whether the load balancer has an IPv4 or IPv6 IP address. If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic. If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic. Example: "ipMode":"IPV6" ' enum: - IPV4 - IPV6 type: string ipv6SubnetCidr: description: "Applies to IPV6 LB creation only. \n\nUsed to disambiguate which subnet prefix should be used to create an IPv6 LB. \n\nExample: \"2002::1234:abcd:ffff:c0a8:101/64\"\n" maxLength: 255 minLength: 1 type: string isDeleteProtectionEnabled: default: false description: 'Whether or not the load balancer has delete protection enabled. If "true", the loadbalancer will be protected against deletion if configured to accept traffic. If "false", the loadbalancer will not be protected against deletion. Delete protection will not be enabled unless a value of "true" is provided. Example: `true` ' type: boolean isPrivate: default: false description: 'Whether the load balancer has a VCN-local (private) IP address. If "true", the service assigns a private IP address to the load balancer. If "false", the service assigns a public IP address to the load balancer. A public load balancer is accessible from the internet, depending on your VCN''s [security list rules](/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works). Example: `true` ' type: boolean isRequestIdEnabled: default: false description: 'Whether or not the load balancer has the Request Id feature enabled for HTTP listeners. If "true", the load balancer will attach a unique request id header to every request passed through from the load balancer to load balancer backends. This same request id header also will be added to the response the lb received from the backend handling the request before the load balancer returns the response to the requestor. The name of the unique request id header is set the by value of requestIdHeader. If "false", the loadbalancer not add this unique request id header to either the request passed through to the load balancer backends nor to the reponse returned to the user. New load balancers have the Request Id feature disabled unless isRequestIdEnabled is set to true. Example: `true` ' type: boolean listeners: additionalProperties: $ref: '#/components/schemas/ListenerDetails' type: object networkSecurityGroupIds: description: "An array of NSG [OCIDs](/Content/General/Concepts/identifiers.htm) associated with this load balancer.\n\nDuring the load balancer's creation, the service adds the new load balancer to the specified NSGs.\n\nThe benefits of using NSGs with the load balancer include:\n\n* NSGs define network security rules to govern ingress and egress traffic for the load balancer.\n\n* The network security rules of other resources can reference the NSGs associated with the load balancer\n to ensure access.\n\nExample: `[\"ocid1.nsg.oc1.phx.unique_ID\"]`\n" items: maxLength: 256 minLength: 1 type: string maxItems: 5 minItems: 0 type: array pathRouteSets: additionalProperties: $ref: '#/components/schemas/PathRouteSetDetails' type: object requestIdHeader: default: X-Request-Id description: 'If isRequestIdEnabled is true then this field contains the name of the header field that contains the unique request id that is attached to every request from the load balancer to the load balancer backends and to every response from the load balancer. If a request to the load balancer already contains a header with same name as specified in requestIdHeader then the load balancer will not change the value of that field. If isRequestIdEnabled is false then this field is ignored. If this field is not set or is set to "" then this field defaults to X-Request-Id **Notes:** * Unless the header name is "" it must start with "X-" prefix. * Setting the header name to "" will set it to the default: X-Request-Id. ' maxLength: 255 pattern: ^(X-(-?[a-zA-Z_0-9])*)?$ type: string reservedIps: description: 'An array of reserved Ips. ' items: $ref: '#/components/schemas/ReservedIP' maxItems: 2 minItems: 0 type: array ruleSets: additionalProperties: $ref: '#/components/schemas/RuleSetDetails' type: object securityAttributes: additionalProperties: additionalProperties: description: 'Multiple key-value pairs of the tag. Example: {"value":"42","mode":"audit", "usagetype" : "zpr"} ' type: object description: 'Key-value pair representing a max egress count and ZPR tag attributes Example: `{"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}` ' type: object description: 'Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace. Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}` ' type: object shapeDetails: $ref: '#/components/schemas/ShapeDetails' description: 'The configuration details to create load balancer using Flexible shape. This is required only if shapeName is `Flexible`. ' shapeName: description: "A template that determines the total pre-provisioned bandwidth (ingress plus egress).\nTo get a list of available shapes, use the [ListShapes](#/en/loadbalancer/20170115/LoadBalancerShape/ListShapes)\noperation.\n\nExample: `flexible`\nNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape\n allowed would be `Flexible`\n" type: string sslCipherSuites: additionalProperties: $ref: '#/components/schemas/SSLCipherSuiteDetails' type: object subnetIds: description: An array of subnet [OCIDs](/Content/General/Concepts/identifiers.htm). items: maxLength: 255 minLength: 1 type: string type: array required: - compartmentId - displayName - shapeName - subnetIds type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_load_balancer\",\n \"shapeName\": \"Flexible\",\n \"shapeDetails\": {\n \"minimumBandwidthInMbps\": 100,\n \"maximumBandwidthInMbps\": 1000\n }\n \"isPrivate\": true,\n \"ipMode\": \"IPV6\",\n \"reservedIps\":[{\n \"id\": \"ocid1.floatingip.oc1.phx.<unique_ID>\"\n }]\n \"listeners\": {\n \"exampleListener\": {\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n }\n },\n \"hostnames\": {\n \"example_hostname_001: {\n \"name\": \"example_hostname_001\",\n \"hostname\": \"app.example.com\"\n },\n \"example_hostname_002: {\n \"name\": \"example_hostname_002\",\n \"hostname\": \"app.example.*\"\n }\n }\n \"backendSets\": {\n \"example_backend_set\": {\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n },\n },\n \"sslCipherSuites\": {\n \"example_cipher_suite\": {\n \"ciphers\": [\n \"ECDHE-ECDSA-AES128-GCM-SHA256\",\n \"ECDHE-ECDSA-AES128-SHA256\",\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n ],\n \"name\": \"example_cipher_suite\"\n }\n },\n \"certificates\": {\n \"example_certificate_bundle\": {\n \"passphrase\": \"<passphrase>\",\n \"privateKey\": \"<private_key>\",\n \"publicCertificate\": \"<public_certificate>\",\n \"caCertificate\": \"<ca_certificate>\",\n \"certificateName\": \"example_certificate_bundle\"\n }\n },\n \"pathRouteSets\": {\n \"example_path_route_set\": {\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n }\n },\n \"isRequestIdEnabled\": true,\n \"requestIdHeader\": \"X-Request-Id\",\n \"ruleSets\": {\n \"example_rule_set\": {\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n }\n }\n },\n \"networkSecurityGroupIds\": [\n \"ocid1.nsg.oc1.phx.<unique_ID>\"\n ],\n \"subnetIds\": [\n \"ocid1.subnet.oc1.phx.<unique_ID>\"\n ]\n}\n" ListenerRuleSummary: description: 'The attributes of a rule associated with the specified listener, and the name of the rule set that the rule belongs to. ' properties: rule: $ref: '#/components/schemas/Rule' description: A rule object that applies to the listener. ruleSetName: description: 'The name of the rule set that the rule belongs to. ' example: example_rule_set type: string type: object x-example: "{\n \"rule\": {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n \"ruleSetName\": \"example_rule_set\"\n}\n" UpdateRoutingPolicyDetails: description: An updated list of routing rules that overwrites the existing list of routing rules. properties: conditionLanguageVersion: description: 'The version of the language in which `condition` of `rules` are composed. ' enum: - V1 type: string rules: description: The list of routing rules. items: $ref: '#/components/schemas/RoutingRule' maxItems: 100 minItems: 1 type: array required: - rules type: object x-example: "{\n \"conditionLanguageVersion\": \"V1\",\n \"rules\": [\n {\n \"name\": \"HR_mobile_user_rule\",\n \"condition\": \"all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))\" ,\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForHRMobileUsers\"\n }]\n },\n {\n \"name\": \"Cookie_rule\",\n \"condition\": \"any(http.request.cookies['myCookie'] eq 'myCookieVal', http.request.headers[(i 'customHeader')] eq (i 'headerVal'))\" ,\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForlargeimages\"\n }]\n }\n ]\n}\n" BackendSetDetails: description: 'The configuration details for a load balancer backend set. For more information on backend set configuration, see [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). ' properties: backendMaxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. If setting backendMaxConnections to some value other than 0 then that value must be greater or equal to 256. Example: `300` ' format: int32 maximum: 65535 minimum: 0 type: integer backends: items: $ref: '#/components/schemas/BackendDetails' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthCheckerDetails' policy: description: 'The load balancer policy for the backend set. To get a list of available policies, use the [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. Example: `LEAST_CONNECTIONS` ' type: string sessionPersistenceConfiguration: $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' sslConfiguration: $ref: '#/components/schemas/SSLConfigurationDetails' required: - healthChecker - policy type: object x-example: "{\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"backendMaxConnections\": 300,\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n}\n" Error: properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: 'A human-readable error string. ' type: string required: - code - message x-example: "{\n \"code\" : \"400\",\n \"message\" : \"LimitExceeded\"\n}\n" UpdateRuleSetDetails: description: An updated set of rules that overwrites the existing set of rules. properties: items: description: An array of rules that compose the rule set. items: $ref: '#/components/schemas/Rule' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n}\n" Hostname: description: 'A hostname resource associated with a load balancer for use by one or more listeners. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: hostname: description: 'A virtual hostname. For more information about virtual hostname string construction, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). Example: `app.example.com` ' type: string name: description: 'A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `example_hostname_001` ' type: string required: - name - hostname type: object x-example: "{\n \"name\": \"example_hostname_001\",\n \"hostname\": \"app.example.com\"\n}\n" CreateRuleSetDetails: description: A named set of rules to add to the load balancer. properties: items: description: An array of rules that compose the rule set. items: $ref: '#/components/schemas/Rule' type: array name: description: 'The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `example_rule_set` ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string required: - name - items type: object x-example: "{\n \"name\": \"example_rule_set\",\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n}\n" BackendHealth: description: 'The health status of the specified backend server as reported by the primary and standby load balancers. ' 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 as reported by the primary and standby load balancers. * **OK:** Both health checks returned `OK`. * **WARNING:** One health check returned `OK` and one did not. * **CRITICAL:** Neither health check returned `OK`. * **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was 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 \"subnetId\": \"ocid1.subnet.oc1.phx.<unique_ID>\",\n \"sourceIpAddress\": \"192.168.0.7\",\n \"timestamp\": \"2018-02-09T21:58:11.417Z\",\n \"healthCheckStatus\": \"OK\"\n }\n ]\n}\n" CertificateDetails: description: 'The configuration details for a certificate bundle. For more information on SSL certficate configuration, see [Managing SSL Certificates](/Content/Balance/Tasks/managingcertificates.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: caCertificate: description: "The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.\n\nExample:\n\n -----BEGIN CERTIFICATE-----\n MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix\n EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD\n VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y\n aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy\n ...\n -----END CERTIFICATE-----\n" type: string certificateName: description: 'A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `example_certificate_bundle` ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_.-]*$ type: string passphrase: description: 'A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. ' type: string privateKey: description: "The SSL private key for your certificate, in PEM format.\n\nExample:\n\n -----BEGIN RSA PRIVATE KEY-----\n jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK\n tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb\n +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16\n /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ\n ...\n -----END RSA PRIVATE KEY-----\n" type: string publicCertificate: description: "The public certificate, in PEM format, that you received from your SSL certificate provider.\n\nExample:\n\n -----BEGIN CERTIFICATE-----\n MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG\n A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE\n MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl\n YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw\n ...\n -----END CERTIFICATE-----\n" type: string required: - certificateName type: object x-example: "{\n \"passphrase\": \"<passphrase>\",\n \"privateKey\": \"<private_key>\",\n \"publicCertificate\": \"<public_certificate>\",\n \"caCertificate\": \"<ca_certificate>\",\n \"certificateName\": \"example_certificate_bundle\",\n}\n" RuleSetDetails: description: The rules that compose a rule set. properties: items: description: An array of rules that compose the rule set. items: $ref: '#/components/schemas/Rule' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n}\n" SSLCipherSuite: description: "The configuration details of an SSL cipher suite.\n\nThe algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer\n(SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to\nnegotiate with peers while sending and receiving information. The cipher suites you use affect the security\nlevel, performance, and compatibility of your data traffic.\n\n**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.\n\nOracle created the following predefined cipher suites that you can specify when you define a resource's\n[SSL configuration](/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can [create custom\ncipher suites](/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher\nsuites do not meet your requirements.\n\n\n* __oci-default-ssl-cipher-suite-v1__\n\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-modern-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-wider-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-AES256-SHA256\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-AES256-SHA256\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\n* __oci-default-http2-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n\n* __oci-default-http2-tls-13-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-13-recommended-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-12-13-wider-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n\n * __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"AES128-SHA\"\n \"AES256-SHA\"\n" properties: ciphers: description: "A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.\n\nThe following ciphers are valid values for this property:\n\n* __TLSv1.3 ciphers__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"TLS_AES_128_CCM_SHA256\"\n \"TLS_AES_128_CCM_8_SHA256\"\n\n* __TLSv1.2 ciphers__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA256\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __TLSv1 ciphers also supported by TLSv1.2__\n\n \"AES128-SHA\"\n \"AES256-SHA\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\nexample: `[\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]`\n" items: type: string minItems: 1 type: array name: description: "A friendly name for the SSL cipher suite. It must be unique and it cannot be changed.\n\n**Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or\n reserved SSL cipher suite names:\n\n* oci-default-ssl-cipher-suite-v1\n* oci-modern-ssl-cipher-suite-v1\n* oci-compatible-ssl-cipher-suite-v1\n* oci-wider-compatible-ssl-cipher-suite-v1\n* oci-customized-ssl-cipher-suite\n* oci-default-http2-ssl-cipher-suite-v1\n* oci-default-http2-tls-13-ssl-cipher-suite-v1\n* oci-default-http2-tls-12-13-ssl-cipher-suite-v1\n* oci-tls-13-recommended-ssl-cipher-suite-v1\n* oci-tls-12-13-wider-ssl-cipher-suite-v1\n* oci-tls-11-12-13-wider-ssl-cipher-suite-v1\n\nexample: `example_cipher_suite`\n" maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_-]*$ type: string required: - name - ciphers type: object x-example: "{\n \"ciphers\" : ['ECDHE-RSA-AES256-GCM-SHA384','ECDHE-ECDSA-AES256-GCM-SHA384','ECDHE-RSA-AES128-GCM-SHA256'],\n \"name\": \"example_cipher_suite\"\n}\n" Certificate: description: 'The configuration details of a certificate bundle. For more information on SSL certficate configuration, see [Managing SSL Certificates](/Content/Balance/Tasks/managingcertificates.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: caCertificate: description: "The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.\n\nExample:\n\n -----BEGIN CERTIFICATE-----\n MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix\n EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD\n VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y\n aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy\n ...\n -----END CERTIFICATE-----\n" type: string certificateName: description: 'A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `example_certificate_bundle` ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_.-]*$ type: string publicCertificate: description: "The public certificate, in PEM format, that you received from your SSL certificate provider.\n\nExample:\n\n -----BEGIN CERTIFICATE-----\n MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG\n A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE\n MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl\n YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw\n ...\n -----END CERTIFICATE-----\n" type: string required: - caCertificate - certificateName - publicCertificate type: object x-example: "{\n \"certificateName\": \"example_certificate_bundle\",\n \"publicCertificate\": \"<public_certificate>\",\n \"caCertificate\": \"<ca_certificate>\",\n}\n" CreateListenerDetails: description: 'The configuration details for adding a listener to a backend set. For more information on listener configuration, see [Managing Load Balancer Listeners](/Content/Balance/Tasks/managinglisteners.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: connectionConfiguration: $ref: '#/components/schemas/ConnectionConfiguration' defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' maxLength: 32 minLength: 1 type: string hostnameNames: description: An array of hostname resource names. items: maxLength: 16 minLength: 1 type: string type: array name: description: 'A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `example_listener` ' maxLength: 255 minLength: 1 type: string pathRouteSetName: description: 'Deprecated. Please use `routingPolicies` instead. The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), applied to this listener''s traffic. Example: `example_path_route_set` ' maxLength: 32 minLength: 1 type: string port: description: 'The communication port for the listener. Example: `80` ' format: int32 maximum: 65535.0 minimum: 1.0 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) operation. Example: `HTTP` ' type: string routingPolicyName: description: 'The name of the routing policy applied to this listener''s traffic. Example: `example_routing_policy` ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string ruleSetNames: description: 'The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener. Example: ["example_rule_set"] ' items: maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string type: array sslConfiguration: $ref: '#/components/schemas/SSLConfigurationDetails' required: - defaultBackendSetName - name - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"hostnameNames\": [\n \"example_hostname_001\",\n \"example_hostname_002\"\n ],\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n },\n \"name\": \"example_listener\"\n}\n" LoadBalancerHealthSummary: description: A health status summary for the specified load balancer. properties: loadBalancerId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer the health status is associated with. ' type: string status: description: "The overall health status of the load balancer.\n\n* **OK:** All backend sets associated with the load balancer return a status of `OK`.\n\n* **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,\nno backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.\n\n* **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.\n\n* **UNKNOWN:** If any one of the following conditions is true:\n\n * The load balancer life cycle state is not `ACTIVE`.\n\n * No backend sets are defined for the load balancer.\n\n * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend\n sets return a status of `WARNING` or `CRITICAL`, and the 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: - loadBalancerId - status type: object x-example: "{\n \"loadBalancerId\": \"ocid1.loadbalancer.oc1.phx.<unique_ID>\",\n \"status\": \"OK\"\n}\n" BackendSetHealth: description: 'The health status details for a backend set. This object does not explicitly enumerate backend servers with a status of `OK`. However, they 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 set''s backend servers 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 set''s backend servers return a status of `OK`. * **UNKNOWN:** More than half of the backend set''s backend servers return a status of `UNKNOWN`, the system was unable to retrieve metrics, or the backend set does not have a listener attached. ' 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 and port. Example: `10.0.0.3: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 \"10.0.0.5:8080\"\n ],\n \"totalBackendCount\": 7\n}\n" LoadBalancerProtocol: description: A protocol that defines the type of traffic accepted by a listener. properties: name: description: 'The name of a protocol. Example: ''HTTP'' ' type: string required: - name type: object x-example: "{\n \"name\": \"HTTP\"\n}\n" CreateRoutingPolicyDetails: description: 'An ordered list of routing rules. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: conditionLanguageVersion: description: 'The version of the language in which `condition` of `rules` are composed. ' enum: - V1 type: string name: description: 'The name for this list of routing rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `example_routing_rules` ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string rules: description: The list of routing rules. items: $ref: '#/components/schemas/RoutingRule' maxItems: 100 minItems: 1 type: array required: - name - conditionLanguageVersion - rules type: object x-example: "{\n \"name\": \"example_routing_rules\",\n \"conditionLanguageVersion\": \"V1\",\n \"rules\": [\n {\n \"name\": \"HR_mobile_user_rule\",\n \"condition\": \"all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))\" ,\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForHRMobileUsers\"\n }]\n },\n {\n \"name\": \"Documents_rule\",\n \"condition\": \"any(http.request.url.path eq (i '/documents'), http.request.headers[(i 'host')] eq (i 'doc.myapp.com'))\",\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForDocuments\"\n }]\n }\n ]\n}\n" SSLConfigurationDetails: description: 'The load balancer''s SSL handling configuration details. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: certificateIds: description: 'Ids for OCI certificates service certificates. Currently only a single Id may be passed. Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]` ' example: 'true' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true certificateName: description: 'A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `example_certificate_bundle` ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_.-]*$ type: string cipherSuiteName: default: oci-default-ssl-cipher-suite-v1 description: "The name of the cipher suite to use for HTTPS or SSL connections.\n\nIf this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`.\n\n**Notes:**\n\n* You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher\n suite. Clients cannot perform an SSL handshake if there is an incompatible configuration.\n* You must ensure compatibility between the ciphers configured in the cipher suite and the configured\n certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA\n certificates.\n* If the cipher configuration is not modified after load balancer creation, the `GET` operation returns\n `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners\n that predate this feature.\n* If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET`\n operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for\n existing listeners that predate this feature.\n* The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL\n configuration for existing backend sets that predate this feature.\n* If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field,\n you must specify an appropriate predefined or custom cipher suite name when updating the resource.\n* The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for\n this field.\n\nexample: `example_cipher_suite`\n" maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_-]*$ type: string protocols: default: TLSv1.2 description: "A list of SSL protocols the load balancer must support for HTTPS or SSL connections.\n\nThe load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure\nconnection ensures that all data passed between the client and the server is private.\n\nThe Load Balancing service supports the following protocols:\n\n* TLSv1\n* TLSv1.1\n* TLSv1.2\n* TLSv1.3\n\nIf this field is not specified, TLSv1.2 is the default.\n\n**Warning:** All SSL listeners created on a given port must use the same set of SSL protocols.\n\n**Notes:**\n\n* The handshake to establish an SSL connection fails if the client supports none of the specified protocols.\n* You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher\n suite.\n* For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation\n displays a list of SSL protocols currently used by those resources.\n\nexample: `[\"TLSv1.1\", \"TLSv1.2\"]`\n" items: type: string type: array serverOrderPreference: default: ENABLED description: "When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client\nciphers.\n\n**Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This\n field is ignored when the `SSLConfiguration` object is associated with a backend set.\n" enum: - ENABLED - DISABLED example: ENABLED type: string trustedCertificateAuthorityIds: description: 'Ids for OCI certificates service CA or CA bundles for the load balancer to trust. Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]` ' example: 'true' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true verifyDepth: description: 'The maximum depth for peer certificate chain verification. Example: `3` ' format: int32 type: integer verifyPeerCertificate: default: false description: 'Whether the load balancer listener should verify peer certificates. Example: `true` ' type: boolean type: object x-example: "{\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n}\n" PathRouteSet: description: 'A named set of path route rules. For more information, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: name: description: 'The unique name for this set of path route rules. Avoid entering confidential information. Example: `example_path_route_set` ' maxLength: 32 minLength: 1 type: string pathRoutes: description: The set of path route rules. items: $ref: '#/components/schemas/PathRoute' maxItems: 20 minItems: 0 type: array required: - name - pathRoutes type: object x-example: "{\n \"name\": \"example_path_route_set\",\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n}\n" CreateBackendDetails: description: 'The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see [Managing Backend Servers](/Content/Balance/Tasks/managingbackendservers.htm). ' properties: backup: default: false description: 'Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. Example: `false` ' type: boolean drain: default: false description: 'Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` ' type: boolean ipAddress: description: 'The IP address of the backend server. Example: `10.0.0.3` ' type: string maxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. Example: `300` ' format: int32 maximum: 65535 minimum: 0 type: integer offline: default: false description: 'Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean port: description: 'The communication port for the backend server. Example: `8080` ' format: int32 maximum: 65535.0 minimum: 1.0 type: integer 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 3 times the number of new connections as a server weighted ''1''. For more information on load balancing policies, see [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). Example: `3` ' format: int32 type: integer required: - ipAddress - port type: object x-example: "{\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"maxConnections\": 300,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n}\n" CreatePathRouteSetDetails: description: 'A named set of path route rules to add to the load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: name: description: 'The name for this set of path route rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `example_path_route_set` ' maxLength: 32 minLength: 1 type: string pathRoutes: description: The set of path route rules. items: $ref: '#/components/schemas/PathRoute' maxItems: 20 minItems: 1 type: array required: - name - pathRoutes type: object x-example: "{\n \"name\": \"example_path_route_set\",\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n}\n" RuleSet: description: 'A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener, such as adding, altering, or removing HTTP headers. For more information, see [Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm). ' properties: items: description: An array of rules that compose the rule set. items: $ref: '#/components/schemas/Rule' type: array name: description: 'The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `example_rule_set` ' type: string required: - name - items type: object x-example: "{\n \"name\": \"example_rule_set\",\n \"items\": [\n {\n \"action\": \"ADD_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n },\n {\n \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n \"header\": \"example_header_name2\",\n \"prefix\": \"example_prefix_value\",\n \"suffix\": \"example_suffix_value\"\n }\n ]\n}\n" ReservedIP: properties: id: description: 'Ocid of the Reserved IP/Public Ip created with VCN. Reserved IPs are IPs which already registered using VCN API. Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP. Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer. Example: "ocid1.publicip.oc1.phx.unique_ID" IPV6 example: "ocid1.ipv6.oc1.phx.unique_ID" ' type: string LoadBalancerShape: description: 'A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the load balancer. Note that the pre-provisioned maximum capacity applies to aggregated connections, not to a single client attempting to use the full bandwidth. ' properties: name: description: 'The name of the shape. Example: `100Mbps` ' type: string required: - name type: object x-example: "{\n \"name\": \"100Mbps\"\n}\n" BackendSet: description: 'The configuration of a load balancer backend set. For more information on backend set configuration, see [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: backendMaxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: `300` ' format: int32 type: integer backends: items: $ref: '#/components/schemas/Backend' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthChecker' name: description: 'A friendly name for the backend set. It must be unique and it 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: description: 'The load balancer policy for the backend set. To get a list of available policies, use the [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. Example: `LEAST_CONNECTIONS` ' type: string sessionPersistenceConfiguration: $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' sslConfiguration: $ref: '#/components/schemas/SSLConfiguration' required: - backends - healthChecker - name - policy type: object x-example: "{\n \"name\": \"example_backend_set\",\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"backendMaxConnections\": 300,\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n}\n" HealthCheckResult: description: 'Information about a single backend server health check result reported by a load balancer. ' properties: healthCheckStatus: description: 'The result of the most recent health check. ' enum: - OK - INVALID_STATUS_CODE - TIMED_OUT - REGEX_MISMATCH - CONNECT_FAILED - IO_ERROR - OFFLINE - UNKNOWN type: string sourceIpAddress: description: 'The IP address of the health check status report provider. This identifier helps you differentiate same-subnet load balancers that report health check status. Example: `10.0.0.7` ' type: string subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet hosting the load balancer that reported this health check status. ' type: string timestamp: description: 'The date and time the data was retrieved, in the format defined by RFC3339. Example: `2017-06-02T18:28:11+00:00` ' format: date-time type: string required: - subnetId - sourceIpAddress - timestamp - healthCheckStatus type: object x-example: "{\n \"subnetId\": \"ocid1.subnet.oc1.phx.<unique_ID>\",\n \"sourceIpAddress\": \"192.168.0.7\",\n \"timestamp\": \"2018-02-09T21:58:11.417Z\",\n \"healthCheckStatus\": \"OK\"\n}\n" HealthChecker: description: 'The health check policy configuration. For more information, see [Editing Health Check Policies](/Content/Balance/Tasks/editinghealthcheck.htm). ' properties: intervalInMillis: description: 'The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: `10000` ' format: int32 type: integer isForcePlainText: default: false description: 'Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL. If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL. If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text. Example: `false` ' type: boolean port: description: 'The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the `Backend` object. Example: `8080` ' example: '0' format: int32 type: integer protocol: description: 'The protocol the health check must use; either HTTP or TCP. Example: `HTTP` ' type: string responseBodyRegex: description: 'A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` ' 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. Defaults to 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, 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. Defaults to 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: - port - protocol - responseBodyRegex - returnCode type: object x-example: "{\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n}\n" LoadBalancer: description: 'The properties that define a load balancer. For more information, see [Managing a Load Balancer](/Content/Balance/Tasks/managingloadbalancer.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, 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' type: object certificates: additionalProperties: $ref: '#/components/schemas/Certificate' type: object compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the 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. It does not have to be unique, and it is changeable. 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 hostnames: additionalProperties: $ref: '#/components/schemas/Hostname' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer. type: string ipAddresses: description: 'An array of IP addresses. ' items: $ref: '#/components/schemas/IpAddress' type: array uniqueItems: true ipMode: default: IPV4 description: "Whether the load balancer has an IPv4 or IPv6 IP address.\n\n If \"IPV4\", the service assigns an IPv4 address and the load balancer supports IPv4 traffic.\n\n If \"IPV6\", the service assigns an IPv6 address and the load balancer supports IPv6 traffic.\n\n Example: \"ipMode\":\"IPV6\"\n" enum: - IPV4 - IPV6 type: string isDeleteProtectionEnabled: description: 'Whether or not the load balancer has delete protection enabled. If "true", the loadbalancer will be protected against deletion if configured to accept traffic. If "false", the loadbalancer will not be protected against deletion. Delete protection is not be enabled unless this field is set to "true". Example: `true` ' type: boolean isPrivate: description: 'Whether the load balancer has a VCN-local (private) IP address. If "true", the service assigns a private IP address to the load balancer. If "false", the service assigns a public IP address to the load balancer. A public load balancer is accessible from the internet, depending on your VCN''s [security list rules](/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works). Example: `true` ' type: boolean isRequestIdEnabled: description: 'Whether or not the load balancer has the Request Id feature enabled for HTTP listeners. If "true", the load balancer will attach a unique request id header to every request passed through from the load balancer to load balancer backends. This same request id header also will be added to the response the lb received from the backend handling the request before the load balancer returns the response to the requestor. The name of the unique request id header is set the by value of requestIdHeader. If "false", the loadbalancer not add this unique request id header to either the request passed through to the load balancer backends nor to the reponse returned to the user. Example: `true` ' type: boolean lifecycleState: description: 'The current state of the load balancer. ' enum: - CREATING - FAILED - ACTIVE - DELETING - DELETED type: string listeners: additionalProperties: $ref: '#/components/schemas/Listener' type: object networkSecurityGroupIds: description: "An array of NSG [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the load\nbalancer.\n\nDuring the load balancer's creation, the service adds the new load balancer to the specified NSGs.\n\nThe benefits of associating the load balancer with NSGs include:\n\n* NSGs define network security rules to govern ingress and egress traffic for the load balancer.\n\n* The network security rules of other resources can reference the NSGs associated with the load balancer\n to ensure access.\n\nExample: [\"ocid1.nsg.oc1.phx.unique_ID\"]\n" items: maxLength: 256 minLength: 1 type: string minItems: 0 type: array pathRouteSets: additionalProperties: $ref: '#/components/schemas/PathRouteSet' type: object requestIdHeader: description: 'If isRequestIdEnabled is true then this field contains the name of the header field that contains the unique request id that is attached to every request from the load balancer to the load balancer backends and to every response from the load balancer. If a request to the load balancer already contains a header with same name as specified in requestIdHeader then the load balancer will not change the value of that field. If this field is set to "" this field defaults to X-Request-Id. ' maxLength: 255 pattern: ^(X-(-?[a-zA-Z_0-9])*)?$ type: string routingPolicies: additionalProperties: $ref: '#/components/schemas/RoutingPolicy' type: object ruleSets: additionalProperties: $ref: '#/components/schemas/RuleSet' type: object securityAttributes: additionalProperties: additionalProperties: description: 'Multiple key-value pairs of the tag. Example: {"value":"42","mode":"audit", "usagetype" : "zpr"} ' type: object description: 'Key-value pair representing a max egress count and ZPR tag attributes Example: `{"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}` ' type: object description: 'Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace. Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}` ' type: object shapeDetails: $ref: '#/components/schemas/ShapeDetails' shapeName: description: 'A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the [ListShapes](#/en/loadbalancer/20170115/LoadBalancerShape/ListShapes) operation. Example: `100Mbps` ' type: string sslCipherSuites: additionalProperties: $ref: '#/components/schemas/SSLCipherSuite' type: object subnetIds: description: An array of subnet [OCIDs](/Content/General/Concepts/identifiers.htm). items: type: string type: array systemTags: 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: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the load balancer was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - displayName - shapeName - timeCreated type: object x-example: "{\n \"id\": \"ocid1.loadbalancer.oc1.phx.<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_load_balancer\",\n \"lifecycleState\": \"ACTIVE\",\n \"ipMode\": \"IPV6\"\n \"timeCreated\": \"2016-08-25T21:10:29.600Z\",\n \"ipAddresses\": [\n {\n \"ipAddress\": \"192.168.0.3\",\n \"isPublic\": false\n }\n ],\n \"shapeName\": \"Flexible\",\n \"shapeDetails\": {\n \"minimumBandwidthInMbps\": 100,\n \"maximumBandwidthInMbps\": 1000\n }\n \"isPrivate\": true,\n \"isDeleteProtectionEnabled\": true,\n \"isRequestIdEnabled\": true,\n \"requestIdHeader\": \"X-Request-Id\",\n \"listeners\": {\n \"exampleListener\": {\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n }\n },\n \"hostnames\": {\n \"example_hostname_001: {\n \"name\": \"example_hostname_001\",\n \"hostname\": \"app.example.com\"\n },\n \"example_hostname_002: {\n \"name\": \"example_hostname_002\",\n \"hostname\": \"app.example.*\"\n }\n }\n \"backendSets\": {\n \"example_backend_set\": {\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n },\n },\n \"subnetIds\": [\n \"ocid1.subnet.oc1.phx.<unique_ID>\"\n ],\n \"sslCipherSuites\": {\n \"example_cipher_suite\": {\n \"ciphers\": [\n \"ECDHE-ECDSA-AES128-GCM-SHA256\",\n \"ECDHE-ECDSA-AES128-SHA256\",\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n ],\n \"name\": \"example_cipher_suite\"\n }\n },\n \"certificates\": {\n \"example_certificate_bundle\": {\n \"passphrase\": \"<passphrase>\",\n \"privateKey\": \"<private_key>\",\n \"publicCertificate\": \"<public_certificate>\",\n \"caCertificate\": \"<ca_certificate>\",\n \"certificateName\": \"example_certificate_bundle\"\n }\n },\n \"pathRouteSets\": {\n \"example_path_route_set\": {\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n }\n }\n}\n" CreateSSLCipherSuiteDetails: description: "The configuration details of an SSL cipher suite.\n\nThe algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer\n(SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to\nnegotiate with peers while sending and receiving information. The cipher suites you use affect the security\nlevel, performance, and compatibility of your data traffic.\n\n**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.\n\nOracle created the following predefined cipher suites that you can specify when you define a resource's\n[SSL configuration](/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can [create custom\ncipher suites](/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher\nsuites do not meet your requirements.\n\n\n* __oci-default-ssl-cipher-suite-v1__\n\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-modern-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-wider-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-AES256-SHA256\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-AES256-SHA256\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\n* __oci-default-http2-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n\n* __oci-default-http2-tls-13-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-13-recommended-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-12-13-wider-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n\n * __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"AES128-SHA\"\n \"AES256-SHA\"\n" properties: ciphers: description: "A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.\n\nThe following ciphers are valid values for this property:\n\n* __TLSv1.3 ciphers__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"TLS_AES_128_CCM_SHA256\"\n \"TLS_AES_128_CCM_8_SHA256\"\n\n* __TLSv1.2 ciphers__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA256\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __TLSv1 ciphers also supported by TLSv1.2__\n\n \"AES128-SHA\"\n \"AES256-SHA\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\nexample: `[\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]`\n" items: type: string minItems: 1 type: array name: description: "A friendly name for the SSL cipher suite. It must be unique and it cannot be changed.\n\n**Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or\n reserved SSL cipher suite names:\n\n* oci-default-ssl-cipher-suite-v1\n* oci-modern-ssl-cipher-suite-v1\n* oci-compatible-ssl-cipher-suite-v1\n* oci-wider-compatible-ssl-cipher-suite-v1\n* oci-customized-ssl-cipher-suite\n* oci-default-http2-ssl-cipher-suite-v1\n* oci-default-http2-tls-13-ssl-cipher-suite-v1\n* oci-default-http2-tls-12-13-ssl-cipher-suite-v1\n* oci-tls-13-recommended-ssl-cipher-suite-v1\n* oci-tls-12-13-wider-ssl-cipher-suite-v1\n* oci-tls-11-12-13-wider-ssl-cipher-suite-v1\n\nexample: `example_cipher_suite`\n" maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_-]*$ type: string required: - name - ciphers type: object x-example: "{\n \"ciphers\" : [\n \"ECDHE-RSA-AES256-GCM-SHA384\",\n \"ECDHE-ECDSA-AES256-GCM-SHA384\",\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n ],\n \"name\": \"example_cipher_suite\"\n}\n" Rule: description: An object that represents an action to apply to a listener. discriminator: propertyName: action properties: action: enum: - ADD_HTTP_REQUEST_HEADER - EXTEND_HTTP_REQUEST_HEADER_VALUE - REMOVE_HTTP_REQUEST_HEADER - ADD_HTTP_RESPONSE_HEADER - EXTEND_HTTP_RESPONSE_HEADER_VALUE - REMOVE_HTTP_RESPONSE_HEADER - ALLOW - CONTROL_ACCESS_USING_HTTP_METHODS - REDIRECT - HTTP_HEADER - IP_BASED_MAX_CONNECTIONS type: string required: - action type: object x-example: "{\n \"action\": \"ADD_HTTP_REQUEST_HEADER\",\n \"header\": \"example_header_name\",\n \"value\": \"example_value\"\n}\n" PathMatchType: description: The type of matching to apply to incoming URIs. properties: matchType: description: "Specifies how the load balancing service compares a [PathRoute](#/en/loadbalancer/20170115/requests/PathRoute)\nobject's `path` string against the incoming URI.\n\n* **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path.\n\n* **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning\n portion of the incoming URI path.\n\n* **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path.\n\n* **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path.\n\nFor a full description of how the system handles `matchType` in a path route set containing multiple rules, see\n[Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm).\n" enum: - EXACT_MATCH - FORCE_LONGEST_PREFIX_MATCH - PREFIX_MATCH - SUFFIX_MATCH type: string required: - matchType type: object x-example: "{\n \"matchType\": \"EXACT_MATCH\"\n}\n" RoutingRule: description: 'A routing rule examines an incoming request, routing matching requests to the specified backend set. Routing rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests. ' properties: actions: description: 'A list of actions to be applied when conditions of the routing rule are met. ' items: $ref: '#/components/schemas/Action' maxItems: 1 minItems: 1 type: array condition: description: 'A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action. ' maxLength: 4096 minLength: 1 type: string name: description: 'A unique name for the routing policy rule. Avoid entering confidential information. ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string required: - name - condition - actions type: object x-example: "{\n \"name\": \"Cookie_rule\",\n \"condition\" : \"any(http.request.cookies['myCookie'] eq 'myCookieVal', http.request.headers[(i 'customHeader')] eq 'headerVal')\",\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForThumbnails\"\n }]\n}\n" UpdateHealthCheckerDetails: description: The health checker's configuration details. properties: intervalInMillis: description: 'The interval between health checks, in milliseconds. Example: `10000` ' format: int32 maximum: 1800000.0 minimum: 1000.0 type: integer isForcePlainText: default: false description: 'Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL. If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL. If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text. Example: `true` ' type: boolean 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 the health check must use; either HTTP or TCP. Example: `HTTP` ' type: string responseBodyRegex: description: 'A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` ' maxLength: 255 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. Example: `200` ' 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` ' maxLength: 1024 type: string required: - protocol - port - returnCode - retries - timeoutInMillis - intervalInMillis - responseBodyRegex type: object x-example: "{\n \"protocol\": \"HTTP\",\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n}\n" SessionPersistenceConfigurationDetails: description: 'The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness). Session persistence enables the Load Balancing service to direct any number of requests that originate from a single logical client to a single backend web server. For more information, see [Session Persistence](/Content/Balance/Reference/sessionpersistence.htm). To disable application cookie stickiness on a running load balancer, use the [UpdateBackendSet](#/en/loadbalancer/20170115/BackendSet/UpdateBackendSet) operation and specify `null` for the `SessionPersistenceConfigurationDetails` object. Example: `SessionPersistenceConfigurationDetails: null` **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: cookieName: description: 'The name of the cookie used to detect a session initiated by the backend server. Use ''*'' to specify that any cookie set by the backend causes the session to persist. Example: `example_cookie` ' maxLength: 4096 minLength: 1 type: string disableFallback: default: false description: 'Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: `false` ' type: boolean required: - cookieName type: object x-example: "{\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n}\n" CreateBackendSetDetails: description: 'The configuration details for creating a backend set in a load balancer. For more information on backend set configuration, see [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: backendMaxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. If setting backendMaxConnections to some value other than 0 then that value must be greater or equal to 256. Example: `300` ' format: int32 maximum: 65535 minimum: 0 type: integer backends: items: $ref: '#/components/schemas/BackendDetails' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthCheckerDetails' name: description: 'A friendly name for the backend set. It must be unique and it 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: description: 'The load balancer policy for the backend set. To get a list of available policies, use the [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. Example: `LEAST_CONNECTIONS` ' type: string sessionPersistenceConfiguration: $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' sslConfiguration: $ref: '#/components/schemas/SSLConfigurationDetails' required: - healthChecker - name - policy type: object x-example: "{\n \"name\": \"example_backend_set\",\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"backendMaxConnections\": 300,\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": false,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true,\n \"verifyDepth\": 3\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n}\n" UpdateLoadBalancerShapeDetails: properties: shapeDetails: $ref: '#/components/schemas/ShapeDetails' description: 'The configuration details to update load balancer to a different profile. ' shapeName: description: "The new shape name for the load balancer.\n\nAllowed values are :\n * 10Mbps\n * 100Mbps\n * 400Mbps\n * 8000Mbps\n * Flexible\n\n Example: `flexible`\n\n * NOTE: Fixed shapes 10Mbps, 100Mbps, 400Mbps, 8000Mbps will be deprecated after May 2023. This api\n * will only support `Flexible` shape after that date.\n" type: string required: - shapeName type: object x-example: "{\n \"shapeName\": \"Flexible\",\n \"shapeDetails\": {\n \"minimumBandwidthInMbps\": 150,\n \"maximumBandwidthInMbps\": 1500\n }\n}\n" IpAddress: description: A load balancer IP address. properties: ipAddress: description: 'An IP address. Example: `192.168.0.3` ' type: string isPublic: description: 'Whether the IP address is public or private. If "true", the IP address is public and accessible from the internet. If "false", the IP address is private and accessible only from within the associated VCN. ' type: boolean reservedIp: $ref: '#/components/schemas/ReservedIP' required: - ipAddress x-example: "{\n \"reservedIp\": {\n \"id\": \"ocid1.publicip.oc1.phx.amaasavayhrfkyyamqzspkfppv5vsvbtlkyxq6cu2b34pv575empq7nv6zvp\"\n },\n \"ipAddress\": \"192.168.0.3\",\n \"isPublic\": false\n}\n" ConnectionConfiguration: description: 'Configuration details for the connection between the client and backend servers. ' properties: backendTcpProxyProtocolOptions: description: 'An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: ["PP2_TYPE_AUTHORITY"] ' items: enum: - PP2_TYPE_AUTHORITY maxLength: 64 minLength: 1 type: string type: array uniqueItems: true backendTcpProxyProtocolVersion: description: 'The backend TCP Proxy Protocol version. Example: `1` ' format: int32 maximum: 2.0 minimum: 1.0 type: integer idleTimeout: description: 'The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations. For more information, see [Connection Configuration](/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration). Example: `1200` ' format: int64 minimum: 1.0 type: integer required: - idleTimeout type: object x-example: "{\n \"backendTcpProxyProtocolVersion\": 2,\n \"backendTcpProxyProtocolOptions\": [\"PP2_TYPE_AUTHORITY\"],\n \"idleTimeout\": 1200\n}\n" LoadBalancerHealth: description: 'The health status details for the specified load balancer. This object does not explicitly enumerate backend sets with a status of `OK`. However, they 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 friendly name you assigned when you created it. Example: `example_backend_set` ' items: type: string type: array status: description: "The overall health status of the load balancer.\n\n* **OK:** All backend sets associated with the load balancer return a status of `OK`.\n\n* **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,\nno backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.\n\n* **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.\n\n* **UNKNOWN:** If any one of the following conditions is true:\n\n * The load balancer life cycle state is not `ACTIVE`.\n\n * No backend sets are defined for the load balancer.\n\n * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend\n sets return a status of `WARNING` or `CRITICAL`, and the 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 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 friendly name you assigned when you created it. 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 friendly name you assigned when you created it. 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" HostnameDetails: description: The details of a hostname resource associated with a load balancer. properties: hostname: description: 'A virtual hostname. For more information about virtual hostname string construction, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). Example: `app.example.com` ' type: string name: description: 'The name of the hostname resource. Example: `example_hostname_001` ' type: string required: - name - hostname type: object PathRouteSetDetails: description: A set of path route rules. properties: pathRoutes: description: The set of path route rules. items: $ref: '#/components/schemas/PathRoute' maxItems: 20 minItems: 1 type: array required: - pathRoutes type: object x-example: "{\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n}\n" SSLCipherSuiteDetails: description: "The configuration details of an SSL cipher suite.\n\nThe algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer\n(SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to\nnegotiate with peers while sending and receiving information. The cipher suites you use affect the security\nlevel, performance, and compatibility of your data traffic.\n\n**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.\n\nOracle created the following predefined cipher suites that you can specify when you define a resource's\n[SSL configuration](/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can [create custom\ncipher suites](/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher\nsuites do not meet your requirements.\n\n\n* __oci-default-ssl-cipher-suite-v1__\n\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-modern-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-wider-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-AES256-SHA256\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-AES256-SHA256\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\n* __oci-default-http2-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n\n* __oci-default-http2-tls-13-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-13-recommended-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-12-13-wider-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n\n * __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"AES128-SHA\"\n \"AES256-SHA\"\n" properties: ciphers: description: "A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.\n\nThe following ciphers are valid values for this property:\n\n* __TLSv1.3 ciphers__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"TLS_AES_128_CCM_SHA256\"\n \"TLS_AES_128_CCM_8_SHA256\"\n\n* __TLSv1.2 ciphers__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA256\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __TLSv1 ciphers also supported by TLSv1.2__\n\n \"AES128-SHA\"\n \"AES256-SHA\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\nexample: `[\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]`\n" items: type: string minItems: 1 type: array name: description: "A friendly name for the SSL cipher suite. It must be unique and it cannot be changed.\n\n**Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or\n reserved SSL cipher suite names:\n\n* oci-default-ssl-cipher-suite-v1\n* oci-modern-ssl-cipher-suite-v1\n* oci-compatible-ssl-cipher-suite-v1\n* oci-wider-compatible-ssl-cipher-suite-v1\n* oci-customized-ssl-cipher-suite\n* oci-default-http2-ssl-cipher-suite-v1\n* oci-default-http2-tls-13-ssl-cipher-suite-v1\n* oci-default-http2-tls-12-13-ssl-cipher-suite-v1\n* oci-tls-13-recommended-ssl-cipher-suite-v1\n* oci-tls-12-13-wider-ssl-cipher-suite-v1\n* oci-tls-11-12-13-wider-ssl-cipher-suite-v1\n\nexample: `example_cipher_suite`\n" maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_-]*$ type: string required: - name - ciphers type: object x-example: "{\n \"ciphers\" : ['ECDHE-RSA-AES256-GCM-SHA384','ECDHE-ECDSA-AES256-GCM-SHA384','ECDHE-RSA-AES128-GCM-SHA256'],\n \"name\": \"example_cipher_suite\"\n}\n" SSLConfiguration: description: 'A listener''s SSL handling configuration. To use SSL, a listener must be associated with a [certificate bundle](#/en/loadbalancer/20170115/Certificate/). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: certificateIds: description: 'Ids for OCI certificates service certificates. Currently only a single Id may be passed. Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]` ' example: 'true' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true certificateName: description: 'A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `example_certificate_bundle` ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_.-]*$ type: string cipherSuiteName: default: oci-default-ssl-cipher-suite-v1 description: "The name of the cipher suite to use for HTTPS or SSL connections.\n\nIf this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`.\n\n**Notes:**\n\n* You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher\n suite. Clients cannot perform an SSL handshake if there is an incompatible configuration.\n* You must ensure compatibility between the ciphers configured in the cipher suite and the configured\n certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA\n certificates.\n* If the cipher configuration is not modified after load balancer creation, the `GET` operation returns\n `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners\n that predate this feature.\n* If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET`\n operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for\n existing listeners that predate this feature.\n* The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL\n configuration for existing backend sets that predate this feature.\n* If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field,\n you must specify an appropriate predefined or custom cipher suite name when updating the resource.\n* The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for\n this field.\n\nexample: `example_cipher_suite`\n" maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_-]*$ type: string protocols: default: TLSv1.2 description: "A list of SSL protocols the load balancer must support for HTTPS or SSL connections.\n\nThe load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure\nconnection ensures that all data passed between the client and the server is private.\n\nThe Load Balancing service supports the following protocols:\n\n* TLSv1\n* TLSv1.1\n* TLSv1.2\n* TLSv1.3\n\nIf this field is not specified, TLSv1.2 is the default.\n\n**Warning:** All SSL listeners created on a given port must use the same set of SSL protocols.\n\n**Notes:**\n\n* The handshake to establish an SSL connection fails if the client supports none of the specified protocols.\n* You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher\n suite.\n* For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation\n displays a list of SSL protocols currently used by those resources.\n\nexample: `[\"TLSv1.1\", \"TLSv1.2\"]`\n" items: type: string type: array serverOrderPreference: default: ENABLED description: "When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client\nciphers.\n\n**Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This\n field is ignored when the `SSLConfiguration` object is associated with a backend set.\n" enum: - ENABLED - DISABLED example: ENABLED type: string trustedCertificateAuthorityIds: description: 'Ids for OCI certificates service CA or CA bundles for the load balancer to trust. Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]` ' example: 'true' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true verifyDepth: description: 'The maximum depth for peer certificate chain verification. Example: `3` ' format: int32 type: integer verifyPeerCertificate: default: false description: 'Whether the load balancer listener should verify peer certificates. Example: `true` ' example: 'true' type: boolean required: - verifyDepth - verifyPeerCertificate type: object x-example: "[\n {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n },\n {\n \"certificateIds\": [ \"example_certificate_id\" ],\n \"trustedCertificateAuthorityIds\": [ \"example_certificate_authority_id\", \"example_certificate_bundle_id\"]\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n }\n]\n" CreateHostnameDetails: description: 'The details of the hostname resource to add to a load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: hostname: description: 'A virtual hostname. For more information about virtual hostname string construction, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). Example: `app.example.com` ' type: string name: description: 'A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `example_hostname_001` ' type: string required: - name - hostname type: object x-example: "{\n \"name\": \"example_hostname_001\",\n \"hostname\": \"app.example.com\"\n}\n" RoutingPolicy: description: 'A named ordered list of routing rules that is applied to a listener. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: conditionLanguageVersion: description: 'The version of the language in which `condition` of `rules` are composed. ' enum: - V1 type: string name: description: 'The unique name for this list of routing rules. Avoid entering confidential information. Example: `example_routing_policy` ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string rules: description: The ordered list of routing rules. items: $ref: '#/components/schemas/RoutingRule' maxItems: 100 minItems: 1 type: array required: - name - conditionLanguageVersion - rules type: object x-example: "{\n \"name\": \"example_routing_rules\",\n \"conditionLanguageVersion\": \"V1\",\n \"rules\": [\n {\n \"name\": \"HR_mobile_user_rule\",\n \"condition\" : \"all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query['department'] eq 'HR')\",\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForHRMobileUsers\"\n }]\n },\n {\n \"name\": \"Documents_rule\",\n \"condition\" : \"any(http.request.url.path eq (i '/documents'), http.request.headers[(i 'host')] eq 'doc.myapp.com')\",\n \"actions\": [{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\": \"backendSetForDocuments\"\n }]\n }\n ]\n}\n" ChangeLoadBalancerCompartmentDetails: description: 'The configuration details for moving a load balancer to a different compartment. **Warning:** 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 move the load balancer to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" UpdateHostnameDetails: description: 'The configuration details for updating a virtual hostname. For more information on virtual hostnames, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). ' properties: hostname: description: 'The virtual hostname to update. For more information about virtual hostname string construction, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). Example: `app.example.com` ' type: string type: object x-example: "{\n \"hostname\": \"app.example.com\"\n}\n" ListenerDetails: description: The listener's configuration details. properties: connectionConfiguration: $ref: '#/components/schemas/ConnectionConfiguration' defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' maxLength: 32 minLength: 1 type: string hostnameNames: description: An array of hostname resource names. items: maxLength: 16 minLength: 1 type: string type: array pathRouteSetName: description: 'Deprecated. Please use `routingPolicies` instead. The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), applied to this listener''s traffic. Example: `example_path_route_set` ' maxLength: 32 minLength: 1 type: string port: description: 'The communication port for the listener. Example: `80` ' format: int32 maximum: 65535.0 minimum: 1.0 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) operation. Example: `HTTP` ' type: string routingPolicyName: description: 'The name of the routing policy applied to this listener''s traffic. Example: `example_routing_policy` ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string ruleSetNames: description: "The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener.\n\n Example: [\"example_rule_set\"]\n" items: maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string type: array sslConfiguration: $ref: '#/components/schemas/SSLConfigurationDetails' required: - defaultBackendSetName - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n }\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n}\n" WorkRequestError: description: An object returned in the event of a work request error. properties: errorCode: enum: - BAD_INPUT - INTERNAL_ERROR type: string message: description: A human-readable error string. type: string required: - errorCode - message type: object x-example: "{\n \"errorCode\" : \"BAD_INPUT\",\n \"message\" : \"Default Listener on port '80' refer to VIP 'private-vip' twice\"\n}\n" Listener: description: 'The listener''s configuration. For more information on backend set configuration, see [Managing Load Balancer Listeners](/Content/Balance/Tasks/managinglisteners.htm). ' properties: connectionConfiguration: $ref: '#/components/schemas/ConnectionConfiguration' defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' type: string hostnameNames: description: An array of hostname resource names. items: maxLength: 16 minLength: 1 type: string type: array name: description: 'A friendly name for the listener. It must be unique and it cannot be changed. Example: `example_listener` ' type: string pathRouteSetName: description: 'Deprecated. Please use `routingPolicies` instead. The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), applied to this listener''s traffic. Example: `example_path_route_set` ' maxLength: 32 minLength: 1 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. To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) operation. Example: `HTTP` ' type: string routingPolicyName: description: 'The name of the routing policy applied to this listener''s traffic. Example: `example_routing_policy_name` ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string ruleSetNames: description: 'The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener. Example: ["example_rule_set"] ' items: maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string type: array sslConfiguration: $ref: '#/components/schemas/SSLConfiguration' required: - defaultBackendSetName - name - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"hostnameNames\": [\n \"example_hostname_001\",\n \"example_hostname_002\"\n ],\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n }\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n \"name\": \"example_listener\"\n}\n" UpdateLoadBalancerDetails: description: 'Configuration details to update a load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: 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: 'The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: `example_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 ipMode: default: IPV4 description: "Whether the load balancer has an IPv4 or IPv6 IP address.\n\n If \"IPV4\", the service assigns an IPv4 address and the load balancer supports IPv4 traffic.\n\n If \"IPV6\", the service assigns an IPv6 address and the load balancer supports IPv6 traffic.\n\n Example: \"ipMode\":\"IPV6\"\n" enum: - IPV4 - IPV6 type: string isDeleteProtectionEnabled: description: 'Whether or not the load balancer has delete protection enabled. If "true", the loadbalancer will be protected against deletion if configured to accept traffic. If "false", the loadbalancer will not be protected against deletion. If null or unset, the value for delete protection will not be changed. Example: `true` ' type: boolean isRequestIdEnabled: description: 'Whether or not the load balancer has the Request Id feature enabled for HTTP listeners. If "true", the load balancer will attach a unique request id header to every request passed through from the load balancer to load balancer backends. This same request id header also will be added to the response the lb received from the backend handling the request before the load balancer returns the response to the requestor. The name of the unique request id header is set the by value of requestIdHeader. If "false", the loadbalancer not add this unique request id header to either the request passed through to the load balancer backends nor to the reponse returned to the user. New load balancers have the Request Id feature enabled unless isRequestIdEnabled is set to False. Example: `true` ' type: boolean x-default-description: when unspecified, the current value of this field will be preserved requestIdHeader: description: 'If isRequestIdEnabled is true then this field contains the name of the header field that contains the unique request id that is attached to every request from the load balancer to the load balancer backends and to every response from the load balancer. If a request to the load balancer already contains a header with same name as specified in requestIdHeader then the load balancer will not change the value of that field. If isRequestIdEnabled is false then this field is ignored. **Notes:** * Unless the header name is "" it must start with "X-" prefix. * Setting the header name to "" will set it to the default: X-Request-Id. ' maxLength: 255 pattern: ^(X-(-?[a-zA-Z_0-9])*)?$ type: string x-default-description: when unspecified, the current value of this field will be preserved securityAttributes: additionalProperties: additionalProperties: description: 'Multiple key-value pairs of the tag. Example: {"value":"42","mode":"audit", "usagetype" : "zpr"} ' type: object description: 'Key-value pair representing a max egress count and ZPR tag attributes Example: `{"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}` ' type: object description: 'Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace. Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}` ' type: object type: object x-example: "{\n \"isDeleteProtectionEnabled\": true,\n \"isRequestIdEnabled\": true,\n \"requestIdHeader\": \"X-Request-Id\",\n \"ipMode\": \"IPV6\"\n \"displayName\": \"example_load_balancer\"\n}\n" UpdateNetworkSecurityGroupsDetails: description: 'An object representing an updated list of network security groups (NSGs) that overwrites the existing list of NSGs. * If the load balancer has no NSGs configured, it uses the NSGs in this list. * If the load balancer has a list of NSGs configured, this list replaces the existing list. * If the load balancer has a list of NSGs configured and this list is empty, the operation removes all of the load balancer''s NSG associations.' properties: networkSecurityGroupIds: description: "An array of NSG [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the load\nbalancer.\n\nDuring the load balancer's creation, the service adds the new load balancer to the specified NSGs.\n\nThe benefits of associating the load balancer with NSGs include:\n\n* NSGs define network security rules to govern ingress and egress traffic for the load balancer.\n\n* The network security rules of other resources can reference the NSGs associated with the load balancer\n to ensure access.\n" items: maxLength: 256 minLength: 1 type: string maxItems: 5 minItems: 0 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: backup: default: false description: 'Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. Example: `false` ' type: boolean drain: default: false description: 'Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` ' type: boolean maxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. Example: `300` ' format: int32 maximum: 65535 minimum: 0 type: integer offline: default: false description: 'Whether the 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 3 times the number of new connections as a server weighted ''1''. For more information on load balancing policies, see [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). Example: `3` ' format: int32 type: integer required: - weight - backup - drain - offline type: object x-example: "{\n \"weight\": 3,\n \"maxConnections\": 300,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n}\n" CreateCertificateDetails: description: 'The configuration details for adding a certificate bundle to a listener. For more information on SSL certficate configuration, see [Managing SSL Certificates](/Content/Balance/Tasks/managingcertificates.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: caCertificate: description: "The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.\n\nExample:\n\n -----BEGIN CERTIFICATE-----\n MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix\n EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD\n VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y\n aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy\n ...\n -----END CERTIFICATE-----\n" type: string certificateName: description: 'A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `example_certificate_bundle` ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_.-]*$ type: string passphrase: description: 'A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. ' type: string privateKey: description: "The SSL private key for your certificate, in PEM format.\n\nExample:\n\n -----BEGIN RSA PRIVATE KEY-----\n jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK\n tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb\n +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16\n /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ\n ...\n -----END RSA PRIVATE KEY-----\n" type: string publicCertificate: description: "The public certificate, in PEM format, that you received from your SSL certificate provider.\n\nExample:\n\n -----BEGIN CERTIFICATE-----\n MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbM..QswCQYDVQQGEwJKU\n A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxE..TAPBgNVBAoTCEZyY\n MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWB..gNVBAMTD0ZyYW5rN\n YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmc..mFuazRkZC5jb20wH\n ...\n -----END CERTIFICATE-----\n" type: string required: - certificateName type: object x-example: "{\n \"passphrase\": \"<passphrase>\",\n \"privateKey\": \"<private_key>\",\n \"publicCertificate\": \"<public_certificate>\",\n \"caCertificate\": \"<ca_certificate>\",\n \"certificateName\": \"example_certificate_bundle\"\n}\n" UpdatePathRouteSetDetails: description: An updated set of path route rules that overwrites the existing set of rules. properties: pathRoutes: description: The set of path route rules. items: $ref: '#/components/schemas/PathRoute' maxItems: 20 minItems: 0 type: array required: - pathRoutes type: object x-example: "{\n \"pathRoutes\": [\n {\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n }\n ]\n}\n" UpdateListenerDetails: description: The configuration details for updating a listener. properties: connectionConfiguration: $ref: '#/components/schemas/ConnectionConfiguration' defaultBackendSetName: description: 'The name of the associated backend set. Example: `example_backend_set` ' maxLength: 32 minLength: 1 type: string hostnameNames: description: An array of hostname resource names. items: maxLength: 16 minLength: 1 type: string type: array pathRouteSetName: description: 'Deprecated. Please use `routingPolicies` instead. The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), applied to this listener''s traffic. Example: `example_path_route_set` ' maxLength: 32 minLength: 1 type: string port: description: 'The communication port for the listener. Example: `80` ' format: int32 maximum: 65535.0 minimum: 1.0 type: integer protocol: description: 'The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) operation. Example: `HTTP` ' type: string routingPolicyName: description: 'The name of the routing policy applied to this listener''s traffic. Example: `example_routing_policy` ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string ruleSetNames: description: 'The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener. Example: ["example_rule_set"] ' items: maxLength: 32 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string type: array sslConfiguration: $ref: '#/components/schemas/SSLConfigurationDetails' required: - defaultBackendSetName - port - protocol type: object x-example: "{\n \"defaultBackendSetName\": \"example_backend_set\",\n \"port\": 80,\n \"protocol\": \"HTTP\",\n \"hostnameNames\": [\n \"example_hostname_001\",\n \"example_hostname_002\"\n ],\n \"pathRouteSetName\": \"example_path_route_set\",\n \"sslConfiguration\": {\n \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n \"cipherSuiteName\" : \"example_cipher_suite\",\n \"serverOrderPreference\" : \"ENABLED\",\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyPeerCertificate\": true\n \"verifyDepth\": 3,\n }\n \"connectionConfiguration\": {\n \"idleTimeout\": 1200\n }\n}\n" UpdateBackendSetDetails: description: 'The configuration details for updating a load balancer backend set. For more information on backend set configuration, see [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: backendMaxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. If setting backendMaxConnections to some value other than 0 then that value must be greater or equal to 256. Example: `300` ' format: int32 maximum: 65535 minimum: 0 type: integer backends: items: $ref: '#/components/schemas/BackendDetails' type: array uniqueItems: true healthChecker: $ref: '#/components/schemas/HealthCheckerDetails' policy: description: 'The load balancer policy for the backend set. To get a list of available policies, use the [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. Example: `LEAST_CONNECTIONS` ' type: string sessionPersistenceConfiguration: $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' sslConfiguration: $ref: '#/components/schemas/SSLConfigurationDetails' required: - policy - backends - healthChecker type: object x-example: "{\n \"policy\": \"LEAST_CONNECTIONS\",\n \"backends\": [\n {\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n },\n {\n \"ipAddress\": \"10.0.0.4\",\n \"port\": 8080,\n \"weight\": 1,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n }\n ],\n \"backendMaxConnections\": 300,\n \"healthChecker\": {\n \"protocol\": \"HTTP\",\n \"isForcePlainText\": true,\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n },\n \"sslConfiguration\": {\n \"certificateName\": \"example_certificate_bundle\",\n \"verifyDepth\": \"3\",\n \"verifyPeerCertificate\": true\n },\n \"sessionPersistenceConfiguration\": {\n \"cookieName\": \"example_cookie\",\n \"disableFallback\": false\n }\n}\n" UpdateSSLCipherSuiteDetails: description: 'The configuration details for updating an SSL cipher suite. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: ciphers: description: "A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.\n\nThe following ciphers are valid values for this property:\n\n* __TLSv1.3 ciphers__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"TLS_AES_128_CCM_SHA256\"\n \"TLS_AES_128_CCM_8_SHA256\"\n\n* __TLSv1.2 ciphers__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA256\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __TLSv1 ciphers also supported by TLSv1.2__\n\n \"AES128-SHA\"\n \"AES256-SHA\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\nexample: `[\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]`\n" items: type: string minItems: 1 type: array required: - ciphers type: object x-example: "{\n \"ciphers\": [\n \"ECDHE-ECDSA-AES128-GCM-SHA256\",\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n ]\n}\n" Backend: description: 'The configuration of a backend server that is a member of a load balancer backend set. For more information, see [Managing Backend Servers](/Content/Balance/Tasks/managingbackendservers.htm). ' properties: backup: default: false description: 'Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. Example: `false` ' type: boolean drain: default: false description: 'Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` ' type: boolean ipAddress: description: 'The IP address of the backend server. Example: `10.0.0.3` ' type: string maxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: `300` ' format: int32 type: integer name: description: 'A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080` ' readOnly: true type: string offline: default: false description: 'Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean port: description: 'The communication port for the backend server. Example: `8080` ' format: int32 type: integer 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 3 times the number of new connections as a server weighted ''1''. For more information on load balancing policies, see [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). Example: `3` ' format: int32 type: integer required: - backup - drain - ipAddress - name - offline - port - weight type: object x-example: "{\n \"name\": \"example_backend\",\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"maxConnections\": 300,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n}\n" HealthCheckerDetails: description: The health check policy's configuration details. properties: intervalInMillis: description: 'The interval between health checks, in milliseconds. Example: `10000` ' format: int32 maximum: 1800000.0 minimum: 1000.0 type: integer isForcePlainText: default: false description: 'Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL. If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL. If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text. Example: `false` ' type: boolean port: description: 'The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the `Backend` object. Example: `8080` ' format: int32 maximum: 65535.0 minimum: 0.0 type: integer protocol: description: 'The protocol the health check must use; either HTTP or TCP. Example: `HTTP` ' type: string responseBodyRegex: description: 'A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` ' maxLength: 255 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. Example: `200` ' 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` ' maxLength: 1024 type: string required: - protocol type: object x-example: "{\n \"protocol\": \"HTTP\",\n \"urlPath\": \"/healthcheck\",\n \"port\": 8080,\n \"returnCode\": 200,\n \"retries\": 3,\n \"timeoutInMillis\": 3000,\n \"intervalInMillis\": 10000,\n \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n}\n" LoadBalancerPolicy: description: 'A policy that determines how traffic is distributed among backend servers. For more information on load balancing policies, see [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). ' properties: name: description: 'The name of a load balancing policy. Example: ''LEAST_CONNECTIONS'' ' type: string required: - name type: object x-example: "{\n \"name\": \"LEAST_CONNECTIONS\"\n}\n" BackendDetails: description: The load balancing configuration details of a backend server. properties: backup: default: false description: 'Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. Example: `false` ' type: boolean drain: default: false description: 'Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` ' type: boolean ipAddress: description: 'The IP address of the backend server. Example: `10.0.0.3` ' type: string maxConnections: description: 'The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. Example: `300` ' format: int32 maximum: 65535 minimum: 0 type: integer offline: default: false description: 'Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` ' type: boolean port: description: 'The communication port for the backend server. Example: `8080` ' format: int32 maximum: 65535.0 minimum: 1.0 type: integer 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 3 times the number of new connections as a server weighted ''1''. For more information on load balancing policies, see [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). Example: `3` ' format: int32 type: integer required: - ipAddress - port type: object x-example: "{\n \"ipAddress\": \"10.0.0.3\",\n \"port\": 8080,\n \"weight\": 3,\n \"maxConections\": 300,\n \"backup\": false,\n \"drain\": false,\n \"offline\": false\n}\n" Action: description: An entity that represents an action to apply for a routing rule. discriminator: propertyName: name properties: name: enum: - FORWARD_TO_BACKENDSET type: string required: - name type: object x-example: "{\n \"name\": \"FORWARD_TO_BACKENDSET\",\n \"backendSetName\" : \"backendSetToHandleSomeCriteria\"\n}\n" ShapeDetails: description: 'The configuration details to update load balancer to a different shape. ' properties: maximumBandwidthInMbps: description: 'Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter. The values must be between minimumBandwidthInMbps and 8000 (8Gbps). Example: `1500` ' format: int32 maximum: 8000 minimum: 10 type: integer minimumBandwidthInMbps: description: 'Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example: `150` ' format: int32 maximum: 8000 minimum: 10 type: integer required: - minimumBandwidthInMbps - maximumBandwidthInMbps type: object x-example: "{\n \"minimumBandwidthInMbps\": 150,\n \"maximumBandwidthInMbps\": 1500\n}\n" PathRoute: description: 'A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests. ' properties: backendSetName: description: 'The name of the target backend set for requests where the incoming URI matches the specified path. Example: `example_backend_set` ' maxLength: 32 minLength: 1 type: string path: description: 'The path string to match against the incoming URI path. * Path strings are case-insensitive. * Asterisk (*) wildcards are not supported. * Regular expressions are not supported. Example: `/example/video/123` ' maxLength: 2048 minLength: 1 type: string pathMatchType: $ref: '#/components/schemas/PathMatchType' description: The type of matching to apply to incoming URIs. required: - path - pathMatchType - backendSetName type: object x-example: "{\n \"path\": \"/example/video/123\",\n \"pathMatchType\": {\n \"matchType\": \"EXACT_MATCH\"\n },\n \"backendSetName\": \"example_backend_set\"\n}\n" WorkRequest: description: 'Many of the API requests you use to create and configure load balancing do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see [Viewing the State of a Work Request](/Content/Balance/Tasks/viewingworkrequest.htm). ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer. type: string errorDetails: items: $ref: '#/components/schemas/WorkRequestError' type: array id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. type: string lifecycleState: description: 'The current state of the work request. ' enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED type: string loadBalancerId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request is associated. ' type: string message: description: 'A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure. Possible data elements include: - workflow name - event ID - work request ID - load balancer ID - workflow completion message ' type: string timeAccepted: description: 'The date and time the work request was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time the work request was completed, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: description: 'The type of action the work request represents. Example: `CreateListener` ' type: string required: - errorDetails - id - lifecycleState - loadBalancerId - message - timeAccepted - type type: object x-example: "{\n \"id\": \"ocid1.loadbalancerworkrequest.oc1.phx.<unique_ID>\",\n \"loadBalancerId\": \"ocid1.loadbalancer.oc1.phx.<unique_ID>\",\n \"type\": \"CreateListener\",\n \"lifecycleState\": \"SUCCEEDED\",\n \"message\": \"OK\",\n \"timeAccepted\": \"2018-02-12T23:46:06.346Z\",\n \"timeFinished\": \"2018-02-12T23:46:06.346Z\",\n \"errorDetails\": [ ]\n}\n" parameters: SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME FilterByDisplayNameQueryParam: description: 'A filter to return only resources that match the given display name exactly. Example: `example_load_balancer` ' in: query name: displayName required: false schema: type: string SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. ' in: query name: sortOrder required: false schema: type: string enum: - ASC - DESC RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 FilterByLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED` ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/LoadBalancer/lifecycleState' schema: type: string LoadBalancerIdPathParam: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the associated load balancer. ' in: path name: loadBalancerId required: true schema: type: string RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id schema: type: string responses: DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-ssl-cipher-suite-description: "The configuration details of an SSL cipher suite.\n\nThe algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer\n(SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to\nnegotiate with peers while sending and receiving information. The cipher suites you use affect the security\nlevel, performance, and compatibility of your data traffic.\n\n**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.\n\nOracle created the following predefined cipher suites that you can specify when you define a resource's\n[SSL configuration](/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can [create custom\ncipher suites](/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher\nsuites do not meet your requirements.\n\n\n* __oci-default-ssl-cipher-suite-v1__\n\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-modern-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __oci-wider-compatible-ssl-cipher-suite-v1__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA\"\n \"AES256-SHA256\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-AES256-SHA256\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-AES256-SHA256\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\n* __oci-default-http2-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n\n* __oci-default-http2-tls-13-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__\n\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-13-recommended-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n\n* __oci-tls-12-13-wider-ssl-cipher-suite-v1__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n\n * __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"AES128-SHA\"\n \"AES256-SHA\"\n" x-ssl-cipher-suite-name: description: "A friendly name for the SSL cipher suite. It must be unique and it cannot be changed.\n\n**Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or\n reserved SSL cipher suite names:\n\n* oci-default-ssl-cipher-suite-v1\n* oci-modern-ssl-cipher-suite-v1\n* oci-compatible-ssl-cipher-suite-v1\n* oci-wider-compatible-ssl-cipher-suite-v1\n* oci-customized-ssl-cipher-suite\n* oci-default-http2-ssl-cipher-suite-v1\n* oci-default-http2-tls-13-ssl-cipher-suite-v1\n* oci-default-http2-tls-12-13-ssl-cipher-suite-v1\n* oci-tls-13-recommended-ssl-cipher-suite-v1\n* oci-tls-12-13-wider-ssl-cipher-suite-v1\n* oci-tls-11-12-13-wider-ssl-cipher-suite-v1\n\nexample: `example_cipher_suite`\n" maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_-]*$ type: string x-ssl-cipher-suite-properties: ciphers: description: "A list of SSL ciphers the load balancer must support for HTTPS or SSL connections.\n\nThe following ciphers are valid values for this property:\n\n* __TLSv1.3 ciphers__\n\n \"TLS_AES_128_GCM_SHA256\"\n \"TLS_AES_256_GCM_SHA384\"\n \"TLS_CHACHA20_POLY1305_SHA256\"\n \"TLS_AES_128_CCM_SHA256\"\n \"TLS_AES_128_CCM_8_SHA256\"\n\n* __TLSv1.2 ciphers__\n\n \"AES128-GCM-SHA256\"\n \"AES128-SHA256\"\n \"AES256-GCM-SHA384\"\n \"AES256-SHA256\"\n \"DH-DSS-AES128-GCM-SHA256\"\n \"DH-DSS-AES128-SHA256\"\n \"DH-DSS-AES256-GCM-SHA384\"\n \"DH-DSS-AES256-SHA256\"\n \"DH-RSA-AES128-GCM-SHA256\"\n \"DH-RSA-AES128-SHA256\"\n \"DH-RSA-AES256-GCM-SHA384\"\n \"DH-RSA-AES256-SHA256\"\n \"DHE-DSS-AES128-GCM-SHA256\"\n \"DHE-DSS-AES128-SHA256\"\n \"DHE-DSS-AES256-GCM-SHA384\"\n \"DHE-DSS-AES256-SHA256\"\n \"DHE-RSA-AES128-GCM-SHA256\"\n \"DHE-RSA-AES128-SHA256\"\n \"DHE-RSA-AES256-GCM-SHA384\"\n \"DHE-RSA-AES256-SHA256\"\n \"ECDH-ECDSA-AES128-GCM-SHA256\"\n \"ECDH-ECDSA-AES128-SHA256\"\n \"ECDH-ECDSA-AES256-GCM-SHA384\"\n \"ECDH-ECDSA-AES256-SHA384\"\n \"ECDH-RSA-AES128-GCM-SHA256\"\n \"ECDH-RSA-AES128-SHA256\"\n \"ECDH-RSA-AES256-GCM-SHA384\"\n \"ECDH-RSA-AES256-SHA384\"\n \"ECDHE-ECDSA-AES128-GCM-SHA256\"\n \"ECDHE-ECDSA-AES128-SHA256\"\n \"ECDHE-ECDSA-AES256-GCM-SHA384\"\n \"ECDHE-ECDSA-AES256-SHA384\"\n \"ECDHE-RSA-AES128-GCM-SHA256\"\n \"ECDHE-RSA-AES128-SHA256\"\n \"ECDHE-RSA-AES256-GCM-SHA384\"\n \"ECDHE-RSA-AES256-SHA384\"\n\n* __TLSv1 ciphers also supported by TLSv1.2__\n\n \"AES128-SHA\"\n \"AES256-SHA\"\n \"CAMELLIA128-SHA\"\n \"CAMELLIA256-SHA\"\n \"DES-CBC3-SHA\"\n \"DH-DSS-AES128-SHA\"\n \"DH-DSS-AES256-SHA\"\n \"DH-DSS-CAMELLIA128-SHA\"\n \"DH-DSS-CAMELLIA256-SHA\"\n \"DH-DSS-DES-CBC3-SHAv\"\n \"DH-DSS-SEED-SHA\"\n \"DH-RSA-AES128-SHA\"\n \"DH-RSA-AES256-SHA\"\n \"DH-RSA-CAMELLIA128-SHA\"\n \"DH-RSA-CAMELLIA256-SHA\"\n \"DH-RSA-DES-CBC3-SHA\"\n \"DH-RSA-SEED-SHA\"\n \"DHE-DSS-AES128-SHA\"\n \"DHE-DSS-AES256-SHA\"\n \"DHE-DSS-CAMELLIA128-SHA\"\n \"DHE-DSS-CAMELLIA256-SHA\"\n \"DHE-DSS-DES-CBC3-SHA\"\n \"DHE-DSS-SEED-SHA\"\n \"DHE-RSA-AES128-SHA\"\n \"DHE-RSA-AES256-SHA\"\n \"DHE-RSA-CAMELLIA128-SHA\"\n \"DHE-RSA-CAMELLIA256-SHA\"\n \"DHE-RSA-DES-CBC3-SHA\"\n \"DHE-RSA-SEED-SHA\"\n \"ECDH-ECDSA-AES128-SHA\"\n \"ECDH-ECDSA-AES256-SHA\"\n \"ECDH-ECDSA-DES-CBC3-SHA\"\n \"ECDH-ECDSA-RC4-SHA\"\n \"ECDH-RSA-AES128-SHA\"\n \"ECDH-RSA-AES256-SHA\"\n \"ECDH-RSA-DES-CBC3-SHA\"\n \"ECDH-RSA-RC4-SHA\"\n \"ECDHE-ECDSA-AES128-SHA\"\n \"ECDHE-ECDSA-AES256-SHA\"\n \"ECDHE-ECDSA-DES-CBC3-SHA\"\n \"ECDHE-ECDSA-RC4-SHA\"\n \"ECDHE-RSA-AES128-SHA\"\n \"ECDHE-RSA-AES256-SHA\"\n \"ECDHE-RSA-DES-CBC3-SHA\"\n \"ECDHE-RSA-RC4-SHA\"\n \"IDEA-CBC-SHA\"\n \"KRB5-DES-CBC3-MD5\"\n \"KRB5-DES-CBC3-SHA\"\n \"KRB5-IDEA-CBC-MD5\"\n \"KRB5-IDEA-CBC-SHA\"\n \"KRB5-RC4-MD5\"\n \"KRB5-RC4-SHA\"\n \"PSK-3DES-EDE-CBC-SHA\"\n \"PSK-AES128-CBC-SHA\"\n \"PSK-AES256-CBC-SHA\"\n \"PSK-RC4-SHA\"\n \"RC4-MD5\"\n \"RC4-SHA\"\n \"SEED-SHA\"\n\nexample: `[\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]`\n" items: type: string minItems: 1 type: array x-ssl-negotiation-properties: cipherSuiteName: default: oci-default-ssl-cipher-suite-v1 description: "The name of the cipher suite to use for HTTPS or SSL connections.\n\nIf this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`.\n\n**Notes:**\n\n* You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher\n suite. Clients cannot perform an SSL handshake if there is an incompatible configuration.\n* You must ensure compatibility between the ciphers configured in the cipher suite and the configured\n certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA\n certificates.\n* If the cipher configuration is not modified after load balancer creation, the `GET` operation returns\n `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners\n that predate this feature.\n* If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET`\n operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for\n existing listeners that predate this feature.\n* The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL\n configuration for existing backend sets that predate this feature.\n* If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field,\n you must specify an appropriate predefined or custom cipher suite name when updating the resource.\n* The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for\n this field.\n\nexample: `example_cipher_suite`\n" maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_-]*$ type: string protocols: default: TLSv1.2 description: "A list of SSL protocols the load balancer must support for HTTPS or SSL connections.\n\nThe load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure\nconnection ensures that all data passed between the client and the server is private.\n\nThe Load Balancing service supports the following protocols:\n\n* TLSv1\n* TLSv1.1\n* TLSv1.2\n* TLSv1.3\n\nIf this field is not specified, TLSv1.2 is the default.\n\n**Warning:** All SSL listeners created on a given port must use the same set of SSL protocols.\n\n**Notes:**\n\n* The handshake to establish an SSL connection fails if the client supports none of the specified protocols.\n* You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher\n suite.\n* For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation\n displays a list of SSL protocols currently used by those resources.\n\nexample: `[\"TLSv1.1\", \"TLSv1.2\"]`\n" items: type: string type: array serverOrderPreference: default: ENABLED description: "When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client\nciphers.\n\n**Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This\n field is ignored when the `SSLConfiguration` object is associated with a backend set.\n" enum: - ENABLED - DISABLED example: ENABLED type: string x-headers: etag: description: 'Reflects the current version of the load balancer and the resources it contains. The value only changes when the load balancer or an associated resource is created, updated, or delete For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string