• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. Floating IP
  6. Introduction

Introduction

Object

This interface is used to manage and perform operations on floating IP addresses, including querying floating IP addresses, creating a floating IP address, querying a specified floating IP address, deleting a floating IP address, and updating floating IP addresses.

Object Model

Table 1 Floating IP address object

Attribute

Type

CRUD

Default Value

Restriction

Description

status

String

R

DOWN

N/A

Specifies the network status. The value can be ACTIVE, DOWN, or ERROR.

id

Uuid-str

R

Automatically generated

N/A

Specifies the floating IP address ID.

floating_ip_address

String(64)

CR

N/A

N/A

Specifies the floating IP address.

floating_network_id

Uuid-str

CR

N/A

N/A

Specifies the external network ID.

You can only use fixed external network. You can use GET /v2.0/networks?router:external=True or GET /v2.0/networks?name={floating_network} or run the neutron net-external-list command to obtain information about the external network.

router_id

Uuid-str

CR

N/A

N/A

Specifies the router ID.

port_id

Uuid-str

CRU

N/A

N/A

Specifies the port ID.

fixed_ip_address

String(64)

CRU

N/A

IP address or none

Specifies the private IP address of the associated port.

User input is ignored.

tenant_id

String(255)

CR

ID of the authenticated tenant

N/A

Specifies the tenant ID. Only the administrator can specify tenant_id of other tenants.