• Virtual Private Cloud

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

Floating IP Address API Overview

Object Introduction

Manage and perform operations on floating IPv6 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.

Object Model

Table 1 floatingip 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.

floating_ip_address

No

String(64)

CR

None

N/A

Specifies the floating IPv6 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)

CRU

None

IP address or none

Specifies the private IP address of the associated port.

Content entered by users will be ignored.

tenant_id

No

String(255)

CR

ID of the authenticated tenant

N/A

Specifies the project ID.