Package org.jclouds.cloudstack.features

Interface AddressApi

public interface AddressApi

Provides synchronous access to cloudstack via their REST API.

See Also:

Method Summary

Modifier and Type	Method	Description
AsyncCreateResponse	associateIPAddressInZone(String zoneId, AssociateIPAddressOptions... options)	Acquires and associates a public IP to an account.
void	disassociateIPAddress(String id)	Disassociates an ip address from the account.
PublicIPAddress	getPublicIPAddress(String id)	get a specific IPAddress by id
Set<PublicIPAddress>	listPublicIPAddresses(ListPublicIPAddressesOptions... options)	Lists IPAddresses

Method Detail

listPublicIPAddresses

@Named("listPublicIpAddresses")
@GET
@Consumes("application/json")
Set<PublicIPAddress> listPublicIPAddresses(ListPublicIPAddressesOptions... options)

Lists IPAddresses

Parameters:

options - if present, how to constrain the list.

Returns:

IPAddresses matching query, or empty set, if no IPAddresses are found

getPublicIPAddress

@Named("listPublicIpAddresses")
@GET
@Consumes("application/json")
PublicIPAddress getPublicIPAddress(@QueryParam("id")
                                   String id)

get a specific IPAddress by id

Parameters:

id - IPAddress to get

Returns:

IPAddress or null if not found

associateIPAddressInZone

@Named("associateIpAddress")
@GET
@Consumes("application/json")
AsyncCreateResponse associateIPAddressInZone(@QueryParam("zoneid")
                                             String zoneId,
                                             AssociateIPAddressOptions... options)

Acquires and associates a public IP to an account.

Parameters:

zoneId - the ID of the availability zone you want to acquire an public IP address from

Returns:

IPAddress

disassociateIPAddress

@Named("disassociateIpAddress")
@GET
void disassociateIPAddress(@QueryParam("id")
                           String id)

Disassociates an ip address from the account.

Parameters:

id - the id of the public ip address to disassociate