Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 8734 invoked by uid 99); 12 May 2015 07:20:27 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 12 May 2015 07:20:27 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id B6A46E0B3F; Tue, 12 May 2015 07:20:27 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Tue, 12 May 2015 07:20:38 -0000 Message-Id: <273fc20bf25040c7806eb756c7a9cf3c@git.apache.org> In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [12/51] [partial] cloudstack-www git commit: Adding API html pages http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/updateVirtualMachine.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/updateVirtualMachine.html b/source/api/apidocs-4.0.0/root_admin/updateVirtualMachine.html new file mode 100644 index 0000000..3b78b5e --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/updateVirtualMachine.html @@ -0,0 +1,418 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

updateVirtualMachine

Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	The ID of the virtual machine	true
displayname	user generated name	false
group	group of the virtual machine	false
haenable	true if high-availability is enabled for the virtual machine, false otherwise	false
ostypeid	the ID of the OS type that best represents this VM.	false
userdata	an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Currently only HTTP GET is supported. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding.	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the virtual machine
account	the account associated with the virtual machine
cpunumber	the number of cpu this virtual machine is running with
cpuspeed	the speed of each cpu
cpuused	the amount of the vm's CPU currently used
created	the date when this virtual machine was created
displayname	user generated name. The name of the virtual machine is returned if no displayname exists.
domain	the name of the domain in which the virtual machine exists
domainid	the ID of the domain in which the virtual machine exists
forvirtualnetwork	the virtual network for the service offering
group	the group name of the virtual machine
groupid	the group ID of the virtual machine
guestosid	Os type ID of the virtual machine
haenable	true if high-availability is enabled, false otherwise
hostid	the ID of the host for the virtual machine
hostname	the name of the host for the virtual machine
hypervisor	the hypervisor on which the template runs
instancename	instance name of the user vm; this parameter is returned to the ROOT admin only
isodisplaytext	an alternate display text of the ISO attached to the virtual machine
isoid	the ID of the ISO attached to the virtual machine
isoname	the name of the ISO attached to the virtual machine
keypair	ssh key-pair
memory	the memory allocated for the virtual machine
name	the name of the virtual machine
networkkbsread	the incoming network traffic on the vm
networkkbswrite	the outgoing network traffic on the host
password	the password (if exists) of the virtual machine
passwordenabled	true if the password rest feature is enabled, false otherwise
project	the project name of the vm
projectid	the project id of the vm
publicip	public IP address id associated with vm via Static nat rule
publicipid	public IP address id associated with vm via Static nat rule
rootdeviceid	device ID of the root volume
rootdevicetype	device type of the root volume
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
state	the state of the virtual machine
templatedisplaytext	an alternate display text of the template for the virtual machine
templateid	the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatename	the name of the template for the virtual machine
zoneid	the ID of the availablility zone for the virtual machine
zonename	the name of the availability zone for the virtual machine
*nic()**	the list of nics associated with vm
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
gateway	the gateway of the nic
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
traffictype	the traffic type of the nic
type	the type of the nic
*securitygroup()**	list of security groups associated with the virtual machine
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*tags()**	the list of resource tags associated with the rule
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
*tags()**	the list of resource tags associated with vm
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/updateVpnCustomerGateway.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/updateVpnCustomerGateway.html b/source/api/apidocs-4.0.0/root_admin/updateVpnCustomerGateway.html new file mode 100644 index 0000000..d5a8dd9 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/updateVpnCustomerGateway.html @@ -0,0 +1,157 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

updateVpnCustomerGateway

Update site to site vpn customer gateway

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	id of customer gateway	true
cidrlist	guest cidr of the customer gateway	true
esppolicy	ESP policy of the customer gateway	true
gateway	public ip address id of the customer gateway	true
ikepolicy	IKE policy of the customer gateway	true
ipsecpsk	IPsec Preshared-Key of the customer gateway	true
account	the account associated with the gateway. Must be used with the domainId parameter.	false
domainid	the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.	false
dpd	If DPD is enabled for VPN connection	false
esplifetime	Lifetime of phase 2 VPN connection to the customer gateway, in seconds	false
ikelifetime	Lifetime of phase 1 VPN connection to the customer gateway, in seconds	false
name	name of this customer gateway	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the vpn gateway ID
account	the owner
cidrlist	guest cidr list of the customer gateway
domain	the domain name of the owner
domainid	the domain id of the owner
dpd	if DPD is enabled for customer gateway
esplifetime	Lifetime of ESP SA of customer gateway
esppolicy	IPsec policy of customer gateway
gateway	public ip address id of the customer gateway
ikelifetime	Lifetime of IKE SA of customer gateway
ikepolicy	IKE policy of customer gateway
ipaddress	guest ip of the customer gateway
ipsecpsk	IPsec preshared-key of customer gateway
name	name of the customer gateway
project	the project name
projectid	the project id
removed	the date and time the host was removed

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/updateZone.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/updateZone.html b/source/api/apidocs-4.0.0/root_admin/updateZone.html new file mode 100644 index 0000000..b8d87ef --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/updateZone.html @@ -0,0 +1,202 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

updateZone

Updates a Zone.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the Zone	true
allocationstate	Allocation state of this cluster for allocation of new resources	false
details	the details for the Zone	false
dhcpprovider	the dhcp Provider for the Zone	false
dns1	the first DNS for the Zone	false
dns2	the second DNS for the Zone	false
dnssearchorder	the dns search order list	false
domain	Network domain name for the networks in the zone; empty string will update domain with NULL value	false
guestcidraddress	the guest CIDR address for the Zone	false
internaldns1	the first internal DNS for the Zone	false
internaldns2	the second internal DNS for the Zone	false
ispublic	updates a private zone to public if set, but not vice-versa	false
localstorageenabled	true if local storage offering enabled, false otherwise	false
name	the name of the Zone	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	Zone id
allocationstate	the allocation state of the cluster
description	Zone description
dhcpprovider	the dhcp Provider for the Zone
displaytext	the display text of the zone
dns1	the first DNS for the Zone
dns2	the second DNS for the Zone
domain	Network domain name for the networks in the zone
domainid	the ID of the containing domain, null for public zones
domainname	the name of the containing domain, null for public zones
guestcidraddress	the guest CIDR address for the Zone
internaldns1	the first internal DNS for the Zone
internaldns2	the second internal DNS for the Zone
localstorageenabled	true if local storage offering enabled, false otherwise
name	Zone name
networktype	the network type of the zone; can be Basic or Advanced
securitygroupsenabled	true if security groups support is enabled, false otherwise
vlan	the vlan range of the zone
zonetoken	Zone Token
*capacity()**	the capacity of the Zone
capacitytotal	the total capacity available
capacityused	the capacity currently in use
clusterid	the Cluster ID
clustername	the Cluster name
percentused	the percentage of capacity currently in use
podid	the Pod ID
podname	the Pod name
type	the capacity type
zoneid	the Zone ID
zonename	the Zone name

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/uploadCustomCertificate.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/uploadCustomCertificate.html b/source/api/apidocs-4.0.0/root_admin/uploadCustomCertificate.html new file mode 100644 index 0000000..dca2c96 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/uploadCustomCertificate.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

uploadCustomCertificate

Uploads custom certificate

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
certificate	the custom cert to be uploaded	true
domainsuffix	DNS domain suffix that the certificate is granted for	true
id	the custom cert id in the chain	false
name	the alias of the certificate	false
privatekey	the private key for the certificate	false

Response Tags

+ + + + + + + +

Response Name	Description
message	message of the certificate upload operation

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/root_admin/uploadVolume.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/uploadVolume.html b/source/api/apidocs-4.0.0/root_admin/uploadVolume.html new file mode 100644 index 0000000..7d3fb3f --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/uploadVolume.html @@ -0,0 +1,226 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

uploadVolume

Uploads a data disk.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
format	the format for the volume. Possible values include QCOW2, OVA, and VHD.	true
name	the name of the volume	true
url	the URL of where the volume is hosted. Possible URL include http:// and https://	true
zoneid	the ID of the zone the volume is to be hosted on	true
account	an optional accountName. Must be used with domainId.	false
checksum	the MD5 checksum value of this volume	false
domainid	an optional domainId. If the account parameter is used, domainId must also be used.	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	ID of the disk volume
account	the account associated with the disk volume
attached	the date the volume was attached to a VM instance
created	the date the disk volume was created
destroyed	the boolean state of whether the volume is destroyed or not
deviceid	the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskofferingdisplaytext	the display text of the disk offering
diskofferingid	ID of the disk offering
diskofferingname	name of the disk offering
domain	the domain associated with the disk volume
domainid	the ID of the domain associated with the disk volume
hypervisor	Hypervisor the volume belongs to
isextractable	true if the volume is extractable, false otherwise
name	name of the disk volume
project	the project name of the vpn
projectid	the project id of the vpn
serviceofferingdisplaytext	the display text of the service offering for root disk
serviceofferingid	ID of the service offering for root disk
serviceofferingname	name of the service offering for root disk
size	size of the disk volume
snapshotid	ID of the snapshot from which this volume was created
state	the state of the disk volume
status	the status of the volume
storage	name of the primary storage hosting the disk volume
storagetype	shared or local storage
type	type of the disk volume (ROOT or DATADISK)
virtualmachineid	id of the virtual machine
vmdisplayname	display name of the virtual machine
vmname	name of the virtual machine
vmstate	state of the virtual machine
zoneid	ID of the availability zone
zonename	name of the availability zone
*tags()**	the list of resource tags associated with volume
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/user/activateProject.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/user/activateProject.html b/source/api/apidocs-4.0.0/user/activateProject.html new file mode 100644 index 0000000..fb12905 --- /dev/null +++ b/source/api/apidocs-4.0.0/user/activateProject.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

activateProject

Activates a project

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	id of the project to be modified	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the project
account	the account name of the project's owner
displaytext	the displaytext of the project
domain	the domain name where the project belongs to
domainid	the domain id the project belongs to
name	the name of the project
state	the state of the project
*tags()**	the list of resource tags associated with vm
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/user/addAccountToProject.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/user/addAccountToProject.html b/source/api/apidocs-4.0.0/user/addAccountToProject.html new file mode 100644 index 0000000..6906f88 --- /dev/null +++ b/source/api/apidocs-4.0.0/user/addAccountToProject.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

addAccountToProject

Adds acoount to a project

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
projectid	id of the project to add the account to	true
account	name of the account to be added to the project	false
email	email to which invitation to the project is going to be sent	false

Response Tags

+ + + + + + + + + + +

Response Name	Description
displaytext	any text associated with the success or failure
success	true if operation is executed successfully

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/user/addVpnUser.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/user/addVpnUser.html b/source/api/apidocs-4.0.0/user/addVpnUser.html new file mode 100644 index 0000000..df8dbdb --- /dev/null +++ b/source/api/apidocs-4.0.0/user/addVpnUser.html @@ -0,0 +1,106 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

addVpnUser

Adds vpn users

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
password	password for the username	true
username	username for the vpn user	true
account	an optional account for the vpn user. Must be used with domainId.	false
domainid	an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.	false
projectid	add vpn user to the specific project	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the vpn userID
account	the account of the remote access vpn
domain	the domain name of the account of the remote access vpn
domainid	the domain id of the account of the remote access vpn
project	the project name of the vpn
projectid	the project id of the vpn
username	the username of the vpn user

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/user/assignToLoadBalancerRule.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/user/assignToLoadBalancerRule.html b/source/api/apidocs-4.0.0/user/assignToLoadBalancerRule.html new file mode 100644 index 0000000..fad0ab9 --- /dev/null +++ b/source/api/apidocs-4.0.0/user/assignToLoadBalancerRule.html @@ -0,0 +1,82 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

assignToLoadBalancerRule

Assigns virtual machine or a list of virtual machines to a load balancer rule.

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the load balancer rule	true
virtualmachineids	the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)	true

Response Tags

+ + + + + + + + + + +

Response Name	Description
displaytext	any text associated with the success or failure
success	true if operation is executed successfully

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/user/associateIpAddress.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/user/associateIpAddress.html b/source/api/apidocs-4.0.0/user/associateIpAddress.html new file mode 100644 index 0000000..6e5a798 --- /dev/null +++ b/source/api/apidocs-4.0.0/user/associateIpAddress.html @@ -0,0 +1,205 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

associateIpAddress

Acquires and associates a public IP to an account.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
account	the account to associate with this IP address	false
domainid	the ID of the domain to associate with this IP address	false
networkid	The network this ip address should be associated to.	false
projectid	Deploy vm for the project	false
vpcid	the VPC you want the ip address to be associated with	false
zoneid	the ID of the availability zone you want to acquire an public IP address from	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
forvirtualnetwork	the virtual network for the IP address
ipaddress	public IP address
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
vlanname	the VLAN associated with the IP address
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

+ +