• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Floating IPs
  6. Querying Floating IP Address Pools

Querying Floating IP Address Pools

Function Description

This interface is used to query floating IP address pools.

There is only one network resource pool that can be queried through this interface by tenants in Open Telekom Cloud (OTC) live network environment.

URI

  • URI format

    GET /v2/{tenant_id}/os-floating-ip-pools

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

  • Parameter description

    Parameter

    Mandatory

    Description

    tenant_id

    Yes

    Specifies the tenant or project ID.

Restrictions

This interface will become invalid from micro version 2.36. Since this version, the system will return error 404 when you invoke this interface. Using the corresponding network service interface is recommended.

Request

Parameter

Type

Mandatory

Remarks

tenant_id

String

Yes

Specifies the tenant ID specified in the URI.

The value is in UUID format.

Response

Parameter

Type

Mandatory

Remarks

floating_ip_pools

List

Yes

Specifies the floating IP address pool.

name

String

Yes

Specifies the name of the floating IP address pool.

Request Example

GET /v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ip-pools
GET /v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ip-pools

Response Example

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

Returned Values

See General Request Returned Values.