summaryrefslogtreecommitdiff
path: root/api-ref/source/os-floating-ip-pools.inc
blob: 7860560269c06e3803642efaa27ce282a4885356 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
.. -*- rst -*-

======================================================
 Floating IP pools (os-floating-ip-pools) (DEPRECATED)
======================================================

.. warning::

   This API is a proxy call to the Network service. Nova has
   deprecated all the proxy APIs and users should use the native APIs
   instead. This API will fail with a 404 starting from microversion 2.36.

   For the equivalent functionality in the Network service, one can request::

     GET /networks?router:external=True&fields=name

Manages groups of floating IPs.

List Floating Ip Pools
======================

.. rest_method:: GET /os-floating-ip-pools

Lists floating IP pools.

Policy defaults enable only users with the administrative role or user
who is authorized to operate on tenant <tenant_id> to perform this
operation. Cloud providers can change these permissions through the
``policy.json`` file.

Normal response codes: 200

Error response codes: unauthorized(401), forbidden(403)

Response
--------

.. rest_parameters:: parameters.yaml

  - floating_ip_pools: floating_ip_pools
  - name: floating_ip_pool_name_or_id

**Example List Floating Ip Pools: JSON response**

.. literalinclude:: ../../doc/api_samples/os-floating-ip-pools/floatingippools-list-resp.json
   :language: javascript