Help Center/ Elastic Cloud Server/ API Reference/ Out-of-Date APIs/ Floating IP Address Management (OpenStack Nova APIs)/ Querying Floating IP Address Pools (Discarded)
Updated on 2022-09-23 GMT+08:00
View PDF

Querying Floating IP Address Pools (Discarded)

Function

This API is used to query floating IP address pools.

This API has been discarded. Use the API described in Querying Networks.

Constraints

The API parameter is as follows: router:external=True

GET /networks?router:external=True //Name in the result is returned.

URI

GET /v2.1/{project_id}/os-floating-ip-pools

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Mandatory

Type

Description

floating_ip_pools

Yes

Array of objects

Specifies the floating IP address pool.

name

Yes

String

Specifies the name of the floating IP address pool.

Example Request

GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ip-pools

Example Response

{
    "floating_ip_pools": [
        {
            "name": "pool1"
        },
        {
            "name": "pool2"
        }
    ]
}

Returned Values

See Returned Values for General Requests.