LoadBalancerAddressesResource


List load balancer addresses in a location


Retrieve all load balancer addresses created in a location.

GET https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/addresses

Roles : [ROLE_MANAGE_LOADBALANCERS]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String endpoint Order by
has String If present filter to apply in the search.
limit Integer 25 The number of entities to retrieve
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)
uniqueendpoint Boolean false If true, the response omits duplicated ''endpoints'' (multiple load balancer addresses can use the same endpoint but the LBs have different providerId values)
vdc Integer Filter to only return load balancer addresses suitable to be used in the virtual datacenter with this identifier value

Error Codes

  • LOCATION-4 - The location does not exist
  • NETDEVICE-1 - The device does not exist

Example

Get a load balancer address in a location


Retrieve a load balancer address in the location

GET https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/addresses/{loadbalanceraddress}

Roles : [ROLE_MANAGE_LOADBALANCERS]

Error Codes

  • LOADBALANCER-8 - The requested load balancer address does not exist
  • LOCATION-4 - The location does not exist

Example

Update a load balancer address in a location


Only possible if the address is in use and it is not managed by the provider.

PUT https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/addresses/{loadbalanceraddress}

Roles : [ROLE_MANAGE_LOADBALANCERS]

Content-Type : loadbalanceraddress Accept : loadbalanceraddress

Error Codes

  • LOADBALANCER-26 - Cannot modify load balancer address because it is not associated with a load balancer or is managed by the provider

Example