1. REST API for Oracle Java Cloud Service
  2. Tasks
  3. Service Instances

View Details of the Load Balancer

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer

Returns information about the Oracle-managed load balancer for the specified Oracle Java Cloud Service instance.

On Oracle Cloud Infrastructure: The Oracle-managed load balancer is an instance of Oracle Cloud Infrastructure Load Balancing that is automatically configured and managed for you by Oracle Cloud when the service instance is created with either configureLoadBalancer or useIdentityService set to true. This endpoint does not apply to a service instance that is configured to an Oracle Cloud Infrastructure Load Balancing instance that you have created and configured yourself.

On Cloud Infrastructure Classic and Oracle Cloud at Customer: The Oracle-managed load balancer runs on Oracle Cloud Infrastructure Load Balancing Classic. It is automatically configured and managed for you by Oracle Cloud when Oracle Identity Cloud Service is enabled on the service instance during provisioning.

Request

Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.

See Status Codes for information about other possible HTTP status codes.

Body ()
Root Schema : loadbalancer-getresponse
Type: object
The response body includes information about the Oracle-managed load balancer.
Show Source
Nested Schema : PUBLIC
Type: object
Groups details of the Oracle-managed load balancer for the Oracle Java Cloud Service instance.
Show Source
Nested Schema : configurationSettings
Type: object
Configuration settings of the load balancer.
Show Source
  • The time period after which the load balancer stops sending new connections or requests to origin servers that are disabled or unhealthy or deregistered. The connection drain timeout allows the load balancer to complete in-flight requests gracefully.
  • The time period after which the load balancer closes a connection (client or back-end) if no data has been sent or received over the connection during the specified time.
  • Timeout for the TCP connection establishment from load balancer to origin server. Default is 20 seconds. Increasing this results in a longer overall response time in case of transient unavailability of origin servers.
Nested Schema : listeners
Type: array
Groups load balancer listener details.
Show Source
Nested Schema : permanentUrls
Type: array
List of permanent URLs.
Show Source
Nested Schema : policies
Type: array
Groups load balancer policy details.
Show Source
Nested Schema : restrictions
Type: object
Load balancer restrictions.
Show Source
Nested Schema : urls
Type: array
List of friendly URLs.
Show Source
Nested Schema : lblisteners-details
Type: object
Show Source
Nested Schema : originServerPool
Type: object
Origin servers to which the load balancer routes its requests.
Show Source
Nested Schema : pathPrefix
Type: array
List of URI path prefixes for which this listener may be selected depending on other routing criteria.
Show Source
Nested Schema : permanentUrl
Type: array
List of permanent urls.
Show Source
Nested Schema : policyNames
Type: array
List of policies applicable to a listener.
Show Source
Nested Schema : url
Type: array
List of virtual host listener urls.
Show Source
Nested Schema : healthCheck
Type: object
Health Check configuration for the load balancer, which can perform regular health checks of the origin server pool and route inbound traffic to the healthy origin servers.
Show Source
  • accepted_return_codes
    List of HTTP response status codes that indicate the origin server is healthy. List is displayed only when the health check type is http.

    Accepted return codes can be one or more of the 2xx, 3xx, 4xx, or 5xx codes. If no code is specified then all 2xx and 3xx status codes are considered healthy.

  • Flag that specifies whether health check is enforced. true means health check is enforced. If unspecified, it means health check is disabled.
  • The approximate interval, in seconds, that the load balancer will wait before sending the target request to each origin server.
  • The amount of time, in seconds, that the load balancer will wait without a response before identifying the origin server as unavailable.
  • The number of consecutive successful health checks required before moving the origin server to the healthy state. If no value is specified then 6 is considered as the healthy threshold value by default.
  • The path of the HTTP health check requests. This applies only when the health check type is http.

    A value of / means all paths.

  • The health check mechanism to use to test the origin servers.

    A value of HTTP means the load balancer will send an HTTP HEAD request to the origin servers. The HTTP request path is defined in path. The origin server is considered healthy if the HTTP response status code matches one of those in accepted_return_codes.

  • The number of consecutive health check failures required before moving the origin server to the unhealthy state. If no value is specified then 3 is considered as the unhealthy threshold value by default.
Nested Schema : originServers
Type: array
List of origin servers under the listener.
Show Source
Nested Schema : accepted_return_codes
Type: array
List of HTTP response status codes that indicate the origin server is healthy. List is displayed only when the health check type is http.

Accepted return codes can be one or more of the 2xx, 3xx, 4xx, or 5xx codes. If no code is specified then all 2xx and 3xx status codes are considered healthy.

Show Source
Nested Schema : originservers-details
Type: object
Show Source
Nested Schema : lbpolicy-details
Type: object
Show Source
Nested Schema : conditions
Type: array
Access control rule for the policy type AllowAccessPolicy.
Show Source
Nested Schema : acl-details
Type: object
Show Source
  • Type of source the load balancer is to allow access. Valid value: SOURCE_IP_ADDRESS or SOURCE_VCN_ID and SOURCE_VCN_IP_ADDRESS.
  • For SOURCE_IP_ADDRESS, a user-specified IP address or address range in CIDR format. For SOURCE_VCN_ID and SOURCE_VCN_IP_ADDRESS, the ID of a virtual cloud network (VCN) and the IP address range within the VCN.

    The load balancer denies access to traffic that does not match the specified source value.

Nested Schema : permittedHttpMethods
Type: array
Groups permitted methods on the load balancer.
Show Source
Back to Top

Examples

The following example shows how to retrieve details about the Oracle-managed load balancer by submitting a GET request on the REST resource using cURL.

Note: The command in the example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/loadbalancer

Example of Response Header

The following shows an example of the response header.

HTTP/2 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
x-oracle-dms-ecid: 005Si5C5F636uHFpR0H7id0004m^0001K5
x-oracle-dms-ecid: 005Si5C5F636uHFpR0H7id0004m^0001K5
x-frame-options: DENY
content-language: en
content-type: application/json
vary: user-agent
date: Wed, 08 Aug 2018 00:07:38 GMT
content-length: 1913

Example of Response Body

The following shows an example of the PUBLIC object for an instance provisioned in Oracle Cloud Infrastructure. 

{
   "PUBLIC":{
      "displayName":"exampleinstance-loadbalancer-1",
      "role":"PRIMARY",
      "url":"https:\/\/ExampleInstance-cloudaccountname-someurl:443",
      "permanentUrl":"https:\/\/alongstring-someurl:443",
      "urls":[
         "https:\/\/ExampleInstance-cloudaccountname-someurl:443"
      ],
      "permanentUrls":[
         "https:\/\/alongstring-someurl:443"
      ],
      "loadBalancerAdminUrl":"https:\/\/iaas.us-ashburn-1.oraclecloud.com\/20170115\/loadBalancers\/ocid1.loadbalancer.oc1.iad.verylongstring",
      "type":"Public",
      "vanityUrls":[],
      "configurationSettings":{
         "connectionDrainTimeoutSecs":300,
         "idleTimeoutSecs":60,
         "tcpEstablishTimeoutSecs":20
      },
      "policies":[
         {
            "name":"somename_1_exampleinstance_cluster",
            "type":"LoadBalancingMechanismPolicy",
            "load_balancing_mechanism":"round_robin"
         },
         {
             "name": "requestHeaderPolicy",
             "type": "SetRequestHeaderPolicy",
             "header_name": "WL-PROXY-SSL",
             "value": "true",
             "action_when_hdr_exists": "OVERWRITE"
         },
            {
                "name": "accessrule01",
                "type": "AllowAccessPolicy",
                "description": "Allow traffic from clients whose IP address is in 192.0.2.254/24",
                "conditions": [
                    {
                        "attributeName": "SOURCE_IP_ADDRESS",
                        "attributeValue": "192.0.2.254/24"
                    }
                ]
            }
      ],
      "listeners":[
         {
            "name":"listener_http_443",
            "disabled":false,
            "url":[
               "https:\/\/ExampleInstance-cloudaccountname-someurl:443"
            ],
            "permanentUrl":[
               "https:\/\/alongstring-someurl:443"
            ],
            "vanityUrls":[],
            "policyNames": [
                "requestHeaderPolicy"
            ],
            "pathPrefix":[
               "\/"
            ],
            "originServerPool":{
               "originServers":[
                  {
                     "hostname":"ipaddress1",
                     "port":9075,
                     "disabled":false
                  },
                  {
                     "hostname":"ipaddress2",
                     "port":9075,
                     "disabled":false
                  }
               ],
               "healthCheck":{
                  "enabled":true,
                  "healthCheckIntervalSecs":30,
                  "healthCheckTarget":"http:\/",
                  "healthCheckTimeoutSecs":15,
                  "healthyThreshold":2,
                  "unHealthyThreshold":2
               },
               "disabled":false
            }
         }
      ],
      "disabled":false
   }
}

The following shows an example of the PUBLIC object for an instance provisioned in Oracle Cloud Infrastructure Classic. 

{
    "PUBLIC": {
        "displayName": "exampleinstance-loadbalancer-1",
        "role": "PRIMARY",
        "url": "https://ExampleInstance-cloudaccountname.uscom-east-1.oraclecloud.com:443",
        "permanentUrl": "https://8C9B128D98264EE79AE30CEE2AD200XY.uscom-east-1.oraclecloud.com:443",
        "urls": [
            "https://ExampleInstance-cloudaccountname.uscom-east-1.oraclecloud.com:443"
        ],
        "permanentUrls": [
            "https://8C9B128D98264EE79AE30CEE2AD200XY.uscom-east-1.oraclecloud.com:443"
        ],
        "loadBalancerAdminUrl": "https://lbaas-93f2fb1bbf144abeabbc5c2d4897d3eb.balancer.oraclecloud.com/vlbrs/uscom-east-1/599118-1522765006014",
        "loadBalancerConsoleUrl": "https://compute-cacct-bfe7ac6fc8a94d09a47e77536ppp416e.console.oraclecloud.com/mycompute/console/view.html",
        "type": "Public",
        "vanityUrl": [],
        "configurationSettings": {
            "connectionDrainTimeoutSecs": 300,
            "idleTimeoutSecs": 60,
            "tcpEstablishTimeoutSecs": 20
        },
        "restrictions": {
            "permittedHttpMethods": [
                "DELETE",
                "GET",
                "HEAD",
                "OPTIONS",
                "POST",
                "PUT"
            ]
        },
        "policies": [
            {
                "name": "loadBalancingMechanismPolicy",
                "type": "LoadBalancingMechanismPolicy",
                "load_balancing_mechanism": "round_robin"
            }
        ],
        "listeners": [
            {
                "name": "listener_1_ExampleI_cluster",
                "disabled": false,
                "url": [
                    "https://ExampleInstance-cloudaccountname.uscom-east-1.oraclecloud.com:443"
                ],
                "permanentUrl": [
                    "https://8C9B128D98264EE79AE30CEE2AD200XY.uscom-east-1.oraclecloud.com:443"
                ],
                "pathPrefix": [
                    "/"
                ],
                "policyNames": [
                    "loadBalancingMechanismPolicy"
                ],
                "originServerPool": {
                    "originServers": [
                        {
                            "hostname": "111.222.33.444",
                            "port": 8001,
                            "disabled": false
                        },
                        {
                            "hostname": "111.222.33.44",
                            "port": 8001,
                            "disabled": false
                        }
                    ],
                    "healthCheck": {
                        "enabled": true,
                        "healthCheckIntervalSecs": 30,
                        "healthCheckTimeoutSecs": 15,
                        "healthyThreshold": 2,
                        "unHealthyThreshold": 2,
                        "path": "/",
                        "type": "http",
                        "accepted_return_codes": [
                            "2xx",
                            "3xx",
                            "4xx"
                        ]
                    },
                    "disabled": false
                }
            }
        ],
        "disabled": false
    }
}
Back to Top