[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get Load Balancer Controller

Description

Retrieves a specific Load Balancer Controller.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/loadBalancer/controllers/{loadBalancerControllerId}
Copy

Path Parameters

Path Parameters

string
loadBalancerControllerId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns LoadBalancerController of type(s) application/json;version=36.3
{
	"description": "string",
	"id": "urn:vcloud:loadBalancerController:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"licenseType": "string",
	"name": "string",
	"password": "string",
	"url": "https://loadBalancerController.vmware.com",
	"username": "string",
	"version": "string"
}
string
username Required

Username to connect to the Load Balancer Controller.


string
name Required

The name of the Load Balancer Controller. Names for Load Balancer Controllers must be unique across the system.


string
password Required

Cleartext password to connect to the Load Balancer Controller.


string as uri
url Required

The URL of the Load Balancer Controller. URLs for Load Balancer Controllers must be unique across the system.


string
id Optional

The id of the Load Balancer Controller in URN format.


string
licenseType Optional

The license type of the Load Balancer Controller.

  • BASIC - Basic edition of the NSX Advanced Load Balancer.
  • ENTERPRISE - Full featured edition of the NSX Advanced Load Balancer.


string
description Optional

Description for the registered Load Balancer Controller.


string
version Optional

The version of the load balancer controller.

Errors

Errors

400

Invalid configuration.


404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/loadBalancer/controllers/{loadBalancerControllerId}


[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?