nova/api-ref/source/servers-action-fixed-ip.inc
He Jie Xu 03ce169884 Deprecate Multinic, floatingip action and os-virtual-interface API
The following APIs which are considered as proxies of Neutron networking
API, are deprecated and will result in a 404 error response in new
Microversion:

     POST /servers/{server_uuid}/action
     {
         "addFixedIp": {...}
     }
     POST /servers/{server_uuid}/action
     {
         "removeFixedIp": {...}
     }
     POST /servers/{server_uuid}/action
     {
         "addFloatingIp": {...}
     }
     POST /servers/{server_uuid}/action
     {
         "removeFloatingIp": {...}

And the nova-network specific API for query server's interfaces is
deprecated also:

     GET /servers/{server_uuid}/os-virtual-interfaces

Partial implement blueprint deprecate-multinic-proxy-api

Change-Id: I1848db384a825d3b166f113b30ebad92113af8e5
2017-04-25 12:04:05 -04:00

88 lines
2.5 KiB
ReStructuredText

.. -*- rst -*-
Add (Associate) Fixed Ip (addFixedIp Action) (DEPRECATED)
==========================================================
.. warning:: This API is deprecated and will fail with a 404 starting
from microversion 2.44. This is replaced with using the
Neutron networking service API.
.. rest_method:: POST /servers/{server_id}/action
Adds a fixed IP address to a server instance, which associates that
address with the server. The fixed IP address is retrieved from the
network that you specify in the request.
Specify the ``addFixedIp`` action and the network ID in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- addFixedIp: addFixedIp
- networkId: net_id_resp
**Example Add (Associate) Fixed Ip (addFixedIp Action)**
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-add-fixed-ip-req.json
:language: javascript
Response
--------
No response body is returned after a successful addFixedIp action.
Remove (Disassociate) Fixed Ip (removeFixedIp Action) (DEPRECATED)
===================================================================
.. warning:: This API is deprecated and will fail with a 404 starting
from microversion 2.44. This is replaced with using the
Neutron networking service API.
.. rest_method:: POST /servers/{server_id}/action
Removes, or disassociates, a fixed IP address from a server.
Specify the ``removeFixedIp`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- removeFixedIp: removeFixedIp
- address: ip_address
**Example Remove (Disassociate) Fixed Ip (removeFixedIp Action)**
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-remove-fixed-ip-req.json
:language: javascript
Response
--------
No response body is returned after a successful removeFixedIp action.