• Virtual Private Cloud

vpc
  1. Help Center
  2. Virtual Private Cloud
  3. API Reference
  4. OpenStack Neutron APIs
  5. Floating IP Address
  6. Floating IP Address API Overview

Floating IP Address API Overview

Object Introduction

Manage and perform operations on floating IP addresses, including querying floating IP addresses, creating floating IP addresses, querying a specified floating IP address, deleting a floating IP address, and updating a floating IP address.

NOTE:

The floating IP address API (native OpenStack API) provides functions similar to those provided by the API described in section Elastic IP Address. However, the floating IP address API cannot be used to configure the bandwidth parameter.

Object Model

Table 1 Floating IP address object

Attribute

Mandatory

Type

CRUD

Default Value

Constraint

Description

status

No

String

R

DOWN

N/A

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

id

Yes

Uuid-str

R

Automatically generated

N/A

Specifies the floating IP address ID.

This parameter is not required when you assign a floating IP address.

floating_ip_address

No

String(64)

CR

None

N/A

Specifies the floating IP address.

floating_network_id

No

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

No

Uuid-str

R

None

N/A

Specifies the ID of the belonged router.

port_id

No

Uuid-str

CRU

None

N/A

Specifies the port ID.

fixed_ip_address

No

String(64)

R

None

IP address or none

Specifies the private IP address of the associated port.

tenant_id

No

String(255)

R

ID of the authenticated tenant

N/A

Specifies the project ID.

dns_name

No

String(255)

R

None

N/A

Specifies the DNS name.

dns_domain

No

String(255)

R

None

N/A

Specifies the DNS domain.

project_id

No

String(64)

R

N/A

N/A

Specifies the project ID of a resource.

created_at

No

String(64)

R

Automatically generated

N/A

Specifies the time when the resource was created.

updated_at

No

String(64)

R

Automatically generated

N/A

Specifies the time when the resource was updated.