List Load Balancers
DescriptionReturns information about all load balancers associated with the given cluster.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster the load balancers are associated with.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementLoadBalancersSummary of type application/json
List of summary of all load balancers associated with a clusters.
[
{
"id": "string",
"provider": "enum"
}
]
string
id
Required
An DNS compliant identifier for a load balancer, which can be used to query or configure the load balancer properties. 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
Required
Load balancer provider for the namespace.
Possible values are: HA_PROXY , AVI
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers
Errors
400
com.vmware.vapi.std.errors.unsupported : if the specified cluster does not have vSphere Namespaces enabled.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Availability
Added in 7.0.1.0
