Apache CloudStack v4.4.0 Domain Admin API Reference

updateIpAddress

Updates an ip address

Request parameters

Parameter NameDescriptionRequired
idthe id of the public ip address to updatetrue
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayan optional field, whether to the display the ip to the end user or notfalse

Response Tags

Response NameDescription
idpublic IP address id
accountthe account the public IP address is associated with
allocateddate the public IP address was acquired
associatednetworkidthe ID of the Network associated with the IP address
associatednetworknamethe name of the Network associated with the IP address
domainthe domain the public IP address is associated with
domainidthe domain ID the public IP address is associated with
fordisplayis public ip for display to the regular user
forvirtualnetworkthe virtual network for the IP address
ipaddresspublic IP address
isportableis public IP portable across the zones
issourcenattrue if the IP address is a source nat address, false otherwise
isstaticnattrue if this ip is for static nat, false otherwise
issystemtrue if this ip is system ip (was allocated as a part of deployVm or createLbRule)
networkidthe ID of the Network where ip belongs to
physicalnetworkidthe physical network this belongs to
projectthe project name of the address
projectidthe project id of the ipaddress
purposepurpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
stateState of the ip address. Can be: Allocatin, Allocated and Releasing
virtualmachinedisplaynamevirutal machine display name the ip address is assigned to (not null only for static nat Ip)
virtualmachineidvirutal machine id the ip address is assigned to (not null only for static nat Ip)
virtualmachinenamevirutal machine name the ip address is assigned to (not null only for static nat Ip)
vlanidthe ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlannamethe VLAN associated with the IP address
vmipaddressvirutal machine (dnat) ip address (not null only for static nat Ip)
vpcidVPC the ip belongs to
zoneidthe ID of the zone the public IP address belongs to
zonenamethe name of the zone the public IP address belongs to
tags(*)the list of resource tags associated with ip address
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object