nova/api-ref/source/os-floating-ip-pools.inc
jichenjc 797e7094eb api-ref verify os-floating-ip-pools.inc
verified the API doc for os-floating-ip-pools,
adjus the wording for 'owner' of the server, Also,
remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: Id8bd213282bc53f1f9fbc24d1d2b03ea135c376e
2016-04-26 15:37:33 +08:00

45 lines
1013 B
ReStructuredText

.. -*- rst -*-
==========================================
Floating IP pools (os-floating-ip-pools)
==========================================
Manages groups of floating IPs.
List Floating Ip Pools
======================
.. rest_method:: GET /v2.1/{tenant_id}/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)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
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