40ea165e81
As first step to deprecate the proxy APIs, this commit publish the deprecation of proxy APIs in api ref doc. Partially implements blueprint deprecate-api-proxies Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f
45 lines
1.2 KiB
ReStructuredText
45 lines
1.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
======================================================
|
|
Floating IP pools (os-floating-ip-pools) (DEPRECATED)
|
|
======================================================
|
|
|
|
.. warning::
|
|
|
|
These APIs are proxy calls to the Network service. Nova has
|
|
deprecated all the proxy APIs and users should use the native APIs
|
|
instead.
|
|
See: `Relevant Network APIs
|
|
<http://developer.openstack.org/api-ref-networking-v2-ext.html>`__.
|
|
|
|
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
|
|
|
|
**Example List Floating Ip Pools: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-floating-ip-pools/floatingippools-list-resp.json
|
|
:language: javascript
|