nova/api-ref/source/os-floating-ips-bulk.inc
ghanshyam b4d0b9a11c Mention proxy API deprecation microversion in api-ref
Proxy APIs are deprecated in microversion 2.36 which means
all proxy APIs will return 404 after 2.35 version.

It will be nice to mention that explicitly in api-ref too.

Partially implements blueprint deprecate-api-proxies

Change-Id: Iad210d215fb98bc247f049b23b97d8d7d4265c82
2016-08-01 14:59:53 +09:00

164 lines
3.8 KiB
ReStructuredText

.. -*- rst -*-
======================================================
Floating IPs bulk (os-floating-ips-bulk) (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. These will fail with a 404 after microversion 2.35.
See: `Relevant Network APIs
<http://developer.openstack.org/api-ref-networking-v2-ext.html>`__.
(nova-network only) Bulk-creates, deletes, and lists floating IPs.
Default pool name is ``nova``.
To view available pools, use the ``os-floating-ip-pools`` extension.
List Floating Ips
=================
.. rest_method:: GET /os-floating-ips-bulk
Lists all floating IPs.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ip_info : floating_ips_list
- address : floating_ip
- fixed_ip : fixed_ip_address
- instance_uuid : server_id
- interface : virtual_interface
- pool: floating_ip_pool_name
- project_id : project_id_value
**Example List Floating Ips: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json
:language: javascript
Create Floating Ips
===================
.. rest_method:: POST /os-floating-ips-bulk
Bulk-creates floating IPs.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409)
Request
-------
.. rest_parameters:: parameters.yaml
- floating_ips_bulk_create : floating_ip_bulk_object
- ip_range : ip_range
- interface : virtual_interface_id_optional
- pool: floating_ip_pool_name_optional
**Example Create Floating Ips: JSON request**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ips_bulk_create : floating_ip_bulk_object
- interface : virtual_interface
- ip_range : ip_range
- pool: floating_ip_pool_name
**Example Create Floating Ips: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json
:language: javascript
Bulk-Delete Floating Ips
========================
.. rest_method:: PUT /os-floating-ips-bulk/delete
Bulk-deletes floating IPs.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- ip_range: ip_range_delete
**Example Bulk-Delete Floating Ips: JSON request**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ips_bulk_delete : ip_range_delete
**Example Bulk-Delete Floating Ips: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json
:language: javascript
List Floating Ips By Host
=========================
.. rest_method:: GET /os-floating-ips-bulk/{host_name}
Lists all floating IPs for a host.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- host_name: host_name
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ip_info : floating_ips_list
- address : floating_ip
- fixed_ip : fixed_ip_address
- instance_uuid : server_id
- interface : virtual_interface
- pool: floating_ip_pool_name
- project_id : project_id_value
**Example List Floating Ips By Host: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json
:language: javascript