REST API - list
  1. Operations
  2. vcenter
  3. namespace management
  4. load balancers

vcenter namespace management load balancers: list

Returns information about all load balancers associated with the given cluster. This operation was added in vSphere API 7.0.1.0.

Request:

HTTP request

GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster the load balancers are associated with.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "provider" : "HA_PROXY",
        "id" : "obj-103"
    },
    {
        "provider" : "HA_PROXY",
        "id" : "obj-103"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[]
-[].id string An DNS compliant identifier for a load balancer, which can be used to query or configure the load balancer properties. This attribute was added in vSphere API 7.0.1.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.
-[].provider string Load balancer provider for the namespace. This attribute was added in vSphere API 7.0.1.0.

The provider enumerates the kinds of load balancers supported by vSphere Namespaces. This enumeration was added in vSphere API 7.0.1.0. Value is one of:
HA_PROXY: This constant was added in vSphere API 7.0.1.0.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if cluster cannot be located.
401 unauthenticated if the user cannot be authenticated.
403 unauthorized if the user does not have System.Read privilege.
400 unsupported if the specified cluster does not have vSphere Namespaces enabled.