The load balancer enables network traffic to follow multiple paths to a specific destination. It distributes incoming service requests evenly among multiple servers in such a way that the load distribution is transparent to users. Load balancing helps achieve optimal resource utilization, maximizing throughput, minimizing response time, and avoiding overload.

Prerequisites
1

Log in to vCloud Air as an administrator. See Log in to vCloud Air for information.

2

Create a login session with vCloud Director. See Create a Session for a Virtual Data Center in a Service for information.

3

Using the vCloud API, query vCloud Director for the ID of the edge gateway you require load balancer configuration details about. See Querying the vCloud API for information.

Procedure
♦

To get the details for the load balancer configuration, issue the following request:

GET https://vchs.vmware.com/hybridity/api/gateways/gatewayId/lb/config

In the request header, include the OATH token and the Accept header that you obtained when creating a login session: 

Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: "vcloud-auth-token"

If the request is successful, the server returns HTTP response code 200 and the details of the load balancer configuration.

Example: Request and Response to Get Load Balancer Configuration

Request Header – List the Load Balancer Configuration 

GET  https://vchs.vmware.com/hybridity/api/gateways/gw-5/lb/config
Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: "d6eFLOqQYfuEn2MJTp7BQ2ISEO+ZYaEgTcqBy8wZQ6js="

Request body not required.

Response Body – List the Load Balancer Configuration 

{
  "featureType" : "loadbalancer_4.0"
  "version" : 2,
  "enabled" : true,
  "enableServiceInsertion" : false,
  "accelerationEnabled" : false,
  "virtualServer" : [ {
      "virtualServerId" : "virtualServer-1",
      "name" : "http_vip",
      "description" : "http virtualServer",
      "enabled" : true,
      "ipAddress" : "192.168.4.49",
      "protocol" : "http",
      "port" : "443",
      "connectionLimit" : 123,
      "connectionRateLimit" : 123,
      "defaultPoolId" : "pool-1",
      "applicationProfileId" : "applicationProfile-1",
      "accelerationEnabled" : false,
      "applicationRuleId" : [ ]
    }, ]
  "pool" : [ {
     "poolId" : "pool-2",
     "name" : "pool-https",
     "description" : "pool-https",
     "algorithm" : "round-robin",
     "transparent" : false,
     "monitorId" : "monitor-1",
     "applicationRuleId" : [ ],
     "member" : [ {   
        "memberId" : "member-1",
        "ipAddress" : "192.168.33.101",
        "groupingObjectId" : "network-25",
        "weight" : 1,
        "monitorPort" : 443,
        "port" : 443,
        "maxConn" : 100,
        "minConn" : 10,
        "condition" : "enabled",
        "name" : "m1"
        }, ]
  } ]
  "applicationProfile" : [ ],
  "applicationRule" : [ {
    "applicationRuleId" : "applicationRule-1",
    "name" : redirection_rule,
    "script" : acl google_page url_beg /google
redirect location https://www.google.com/ if google_page
  } ]
  "monitor" : [ {
    "monitorId" : "monitor-1",
    "type" : "tcp",
    "interval" : 5,
    "timeout" : 15,
    "maxRetries" : 3,
    "method" : "GET",
    "url" : "/",
    "expected" : "HTTP/1.1",
    "name" : "default_tcp_monitor",
    "send" : "hello",
    "receive" : "ok",
    "extension" : null
  }, {
    "monitorId" : "monitor-2",
    "type" : "http",
    "interval" : 5,
    "timeout" : 15,
    "maxRetries" : 3,
    "method" : "GET",
    "url" : "/",
    "expected" : null,
    "name" : "default_http_monitor",
    "send" : null,
    "receive" : null,
    "extension" : null
  } ],
  "logging" : {
    "enable" : false,
    "logLevel" : "info"
  },
}