FloatingIp

Floating IP that is associated to a Domain. This floating IP could be used in the VM interface for NAT functionality.

Overview

accessControl boolean
address string filterable   orderable  
assigned boolean filterable  
assignedToObjectType string filterable   orderable  
associatedSharedNetworkResourceID string required  
creationDate string read only   autogenerated   orderable  
egressRateLimiterID string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
ingressRateLimiterID string
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
owner string autogenerated  

API Resource

/floatingips/id
delete get put

Parents

/floatingips
get
/domains/id/floatingips
get post
/aggregateddomains/id/floatingips
get post

Children

/floatingips/id/permissions
delete get post put
/floatingips/id/metadatas
get post
/floatingips/id/globalmetadatas
get post put
/floatingips/id/vports
get
/floatingips/id/eventlogs
get

Members

This object has no members.

Attributes documentation

accessControl boolean
Discussion

If access control is enabled this FIP is part of the Internet PG.

Charateristics

SDK attribute: accessControl

address string filterable   orderable  
Discussion

Floating IP address assigned to the Domain

Charateristics

Format: free
SDK attribute: address

assigned boolean filterable  
Discussion

True if this floating IP is assigned to a network interface else the value is false

Charateristics

SDK attribute: assigned

assignedToObjectType string filterable   orderable  
Discussion

The object type to which this floating ip is assigned. Eg. vport or virtualip

Charateristics

Format: free
SDK attribute: assignedToObjectType

associatedSharedNetworkResourceID string required  
Discussion

Id of the shared network resource subnet which was used to get this floating IP address

Charateristics

Format: free
SDK attribute: associatedSharedNetworkResourceID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

egressRateLimiterID string
Discussion

ID of the Egress Rate Limiter for this FloatingIP.

Charateristics

Format: free
Max length: 255
SDK attribute: egressRateLimiterID

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

ingressRateLimiterID string
Discussion

ID of the Ingress Rate Limiter for this FloatingIP.

Charateristics

Format: free
Max length: 255
SDK attribute: ingressRateLimiterID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner