Querying Floating IP Addresses

Function

This API is used to query all floating IP addresses accessible to the tenant submitting the request.

URI

GET /v2.0/eip/floatingips_v6

Example:

GET https://{Endpoint}/v2.0/eip/floatingips_v6?id={id}&router_id={router_id}&floating_network_id={floating_network_id}&floating_ip_address={floating_ip_address}&port_id={port_id }&fixed_ip_address={fixed_ip_address}&tenant_id={tenant_id}

Table 1 describes the parameters.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the floating IP address ID.

floating_ip_address

No

String

Specifies the floating IPv6 address.

floating_network_id

No

String

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

String

Specifies the ID of the belonged router.

port_id

No

String

Specifies the port ID.

fixed_ip_address

No

String

Specifies the private IP address of the associated port.

tenant_id

No

String

Specifies the project ID.

Request Message

Response Message

Table 2 Response parameter

Parameter

Type

Description

floatingips

Array of floatingip objects

Specifies the floating IP address list. For details, see Table 3.

Table 3 floatingip objects

Parameter

Type

Description

status

String

Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

  • ACTIVE indicates that the floating IP address has been bound.
  • ERROR indicates that the floating IP address is abnormal.
  • DOWN indicates that the floating IP address has not been bound.

id

String

Specifies the floating IP address ID.

floating_ip_address

String

Specifies the floating IPv6 address.

floating_network_id

String

Specifies the external network ID.

router_id

String

Specifies the ID of the belonged router.

port_id

String

Specifies the port ID.

fixed_ip_address

String

Specifies the private IP address of the associated port.

tenant_id

String

Specifies the project ID.

floatingips_links

Array of strings

Specifies the request URL.

Status Code

See Status Codes.

Error Code

See Error Codes.