Help Center> Elastic IP> API Reference> Out-of-Date APIs> Native OpenStack Neutron APIs V2.0> Floating IP Address> Querying Floating IP Addresses
View PDF

Querying Floating IP Addresses

Function

This API is used to query all floating IP addresses accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination.

You can query the detailed information about a specified floating IP address using the API for Querying a Floating IP Address.

URI

GET /v2.0/floatingips

Table 1 describes the parameters.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

id

No

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.

limit

String

No

Specifies the number of items displayed on each page.

marker

String

No

Specifies the ID of the last item on the previous page. If the marker value is invalid, error code 400 will be returned.

page_reverse

Boolean

No

Specifies the page direction. The value can be True or False.

Example:

GET https://{Endpoint}/v2.0/floatingips?id={fip_id}&router_id={router_id}&floating_network_id={net_id}&floating_ip_address={floating_ip}&port_id={port_id}&fixed_ip_address={fixed_ip}&tenant_id={tenant_id}

Request Message

None

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.

floatingips_links

Array of floatingips_link objects

Specifies the floating IP address object list. For details, see Table 4.
Table 3 floatingip objects

Parameter

Type

Description

status

String

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

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

id

String

Specifies the floating IP address ID.

project_id

String

Specifies the project ID.

floating_ip_address

String

Specifies the floating IP 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.

dns_name

String

Specifies the DNS name.

This parameter is available only in the CN South-Guangzhou region.

dns_domain

String

Specifies the DNS domain.

This parameter is available only in the CN South-Guangzhou region.

created_at

String

Specifies the time when the floating IP address was created.

UTC time is used.

Format: yyyy-MM-ddTHH:mm:ss

updated_at

String

Specifies the time when the floating IP address was updated.

UTC time is used.

Format: yyyy-MM-ddTHH:mm:ss
Table 4 floatingips_link object

Parameter

Type

Description

href

String

Specifies the API link.

rel

String

Specifies the relationship between the API link and the API version.

Example:

Example request

GET https://{Endpoint}/v2.0/floatingips?limit=1

Example response

{
    "floatingips": [
        {
            "id": "03a9abc0-bd98-4cb1-b0bd-58dda3dfd675",
            "status": "DOWN",
            "router_id": null,
            "tenant_id": "b3292dde618e40408e30cd87455a0652",
            "project_id": "b3292dde618e40408e30cd87455a0652",
            "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
            "fixed_ip_address": null,
            "floating_ip_address": "49.4.29.131",
            "port_id": null,
            "created_at": "2020-04-21T13:22:15",
            "updated_at": "2020-04-21T13:22:17"
        }
    ],
    "floatingips_links": [
        {
            "href": "https://vpc.cn-north-1.myhuaweicloud.com/v2.0/floatingips?limit=1&marker=03a9abc0-bd98-4cb1-b0bd-58dda3dfd675",
            "rel": "next"
        },
        {
            "href": "https://vpc.cn-north-1.myhuaweicloud.com/v2.0/floatingips?limit=1&marker=03a9abc0-bd98-4cb1-b0bd-58dda3dfd675&page_reverse=true",
            "rel": "previous"
        }
    ]
}

See Status Codes.

Error Code

See Error Codes.

Parent topic: Floating IP Address