Apache CloudStack v4.8.0 User API Reference

listPublicIpAddresses

Lists all public ip addresses

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
allocatedonly	limits search results to allocated public IP addresses	false
associatednetworkid	lists all public IP addresses associated to the network specified	false
domainid	list only resources belonging to the domain specified	false
fordisplay	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
forloadbalancing	list only IPs used for load balancing	false
forvirtualnetwork	the virtual network for the IP address	false
id	lists IP address by ID	false
ipaddress	lists the specified IP address	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
issourcenat	list only source NAT IP addresses	false
isstaticnat	list only static NAT IP addresses	false
keyword	List by keyword	false
listall	If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false	false
page		false
pagesize		false
physicalnetworkid	lists all public IP addresses by physical network ID	false
projectid	list objects by project	false
state	lists all public IP addresses by state	false
tags	List resources by tags (key/value pairs)	false
vlanid	lists all public IP addresses by VLAN ID	false
vpcid	List IPs belonging to the VPC	false
zoneid	lists all public IP addresses by zone ID	false

Response Tags

Response Name	Description
id	public IP address id
account	the account the public IP address is associated with
allocated	date the public IP address was acquired
associatednetworkid	the ID of the Network associated with the IP address
associatednetworkname	the name of the Network associated with the IP address
domain	the domain the public IP address is associated with
domainid	the domain ID the public IP address is associated with
fordisplay	is public ip for display to the regular user
forvirtualnetwork	the virtual network for the IP address
ipaddress	public IP address
isportable	is public IP portable across the zones
issourcenat	true if the IP address is a source nat address, false otherwise
isstaticnat	true if this ip is for static nat, false otherwise
issystem	true if this ip is system ip (was allocated as a part of deployVm or createLbRule)
networkid	the ID of the Network where ip belongs to
physicalnetworkid	the physical network this belongs to
project	the project name of the address
projectid	the project id of the ipaddress
purpose	purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
state	State of the ip address. Can be: Allocatin, Allocated and Releasing
virtualmachinedisplayname	virutal machine display name the ip address is assigned to (not null only for static nat Ip)
virtualmachineid	virutal machine id the ip address is assigned to (not null only for static nat Ip)
virtualmachinename	virutal machine name the ip address is assigned to (not null only for static nat Ip)
vlanid	the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlanname	the VLAN associated with the IP address
vmipaddress	virutal machine (dnat) ip address (not null only for static nat Ip)
vpcid	VPC the ip belongs to
zoneid	the ID of the zone the public IP address belongs to
zonename	the name of the zone the public IP address belongs to
*tags()**	the list of resource tags associated with ip address
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object