Apache CloudStack 4.23.0.0 Root Admin API Reference
reserveIpAddress
Reserve a public IP to an Account.
Request parameters
| Parameter Name | Description | Required |
| id | The ID of the public IP address to reserve | true |
| account | The Account to reserve with this IP address | false |
| domainid | The ID of the domain to reserve with this IP address | false |
| fordisplay | An optional field, whether to the display the IP to the end User or not | false |
| projectid | The ID of the project to reserve with this IP address | 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 |
| domainpath | path of the domain to which the public IP address belongs |
| fordisplay | Is public IP for display to the regular user |
| forprovider | true if range is dedicated for external network providers |
| forsystemvms | true if range is dedicated for System VMs |
| forvirtualnetwork | The virtual Network for the IP address |
| hasrules | Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined |
| 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 |
| networkname | The name 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 IP address |
| 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: Allocating, Allocated, Releasing, Reserved and Free |
| virtualmachinedisplayname | Instance display name the IP address is assigned to (not null only for static NAT IP) |
| virtualmachineid | Instance id the IP address is assigned to |
| virtualmachinename | Instance name the IP address is assigned to |
| virtualmachinetype | Instance type the IP address is assigned to |
| 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 | Instance (DNAT) IP address (not null only for static NAT IP) |
| vpcid | VPC ID the IP belongs to |
| vpcname | VPC name 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 |
| domainpath | Path 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 |