0b1a33ec9c
As highlighted in I77b1cfeab3c00c6c3d7743ba51e12414806b71d2, filtering either floating IPs or floating IP pools by floating IP name will actually fallback to filtering by ID. Update the API ref to reflect this. Change-Id: I00443ae111cbd1e1ec4d2c2ae1828ddaa095fd1a Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
47 lines
1.3 KiB
ReStructuredText
47 lines
1.3 KiB
ReStructuredText
.. -*- 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
|