REST API - get

vcenter namespace management load balancers: get

Returns information vcenter.namespace_management.load_balancers.info about the load balancer 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/{id}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier of the cluster the load balancer is associated with.
id	string	Identifier of the load balancer vcenter.namespace_management.load_balancers.config_spec.id.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "address_ranges" : [
        {
            "address" : "string",
            "count" : 1
        },
        {
            "address" : "string",
            "count" : 1
        }
    ],
    "provider" : "HA_PROXY",
    "id" : "obj-103",
    "ha_proxy_info" : {
        "servers" : [
            {
                "port" : 1,
                "host" : "string"
            },
            {
                "port" : 1,
                "host" : "string"
            }
        ],
        "certificate_authority_chain" : "string",
        "username" : "string"
    }
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info
-.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`.
-.address_ranges	IP_range[]	IP address range from which virtual servers are assigned their IPs. This attribute was added in vSphere API 7.0.1.0.
-.address_ranges[].address	string	The starting address of the range. This attribute was added in vSphere API 7.0.1.0.
-.address_ranges[].count	long	The number of IP addresses in the range. This attribute was added in vSphere API 7.0.1.0.
-.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.
-.ha_proxy_info	HA_proxy_info	The `HA_proxy_info` is a conditional configuration made available upon selecting the HA_PROXY load balancer provider. It is used to configure the load balancer at run time. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when provider has value HA_PROXY. This field is optional and it is only relevant when the value of `provider` is HA_PROXY.
-.ha_proxy_info.servers	server[]	A list of the addresses for the DataPlane API servers used to configure HAProxy. This attribute was added in vSphere API 7.0.1.0.
-.ha_proxy_info.servers[].host	string	Load balancer hostname or IPv4 address. This attribute was added in vSphere API 7.0.1.0.
-.ha_proxy_info.servers[].port	long	Load balancer port. This attribute was added in vSphere API 7.0.1.0.
-.ha_proxy_info.username	string	An administrator user name for accessing the HAProxy Data Plane API server. This attribute was added in vSphere API 7.0.1.0.
-.ha_proxy_info.certificate_authority_chain	string	PEM-encoded CA certificate chain which is used to verify x509 certificates received from the server. This attribute 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` or `id` 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.