c9f5ad3bcf
As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
76 lines
2.0 KiB
ReStructuredText
76 lines
2.0 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
Add (Associate) Fixed Ip (Addfixedip Action)
|
|
============================================
|
|
|
|
.. 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
|
|
- addFixedIp: addFixedIp
|
|
|
|
**Example Add (Associate) Fixed Ip (Addfixedip Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-add-fixed-ip-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
Remove (Disassociate) Fixed Ip (Removefixedip Action)
|
|
=====================================================
|
|
|
|
.. 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
|
|
- removeFixedIp: removeFixedIp
|
|
|
|
**Example Remove (Disassociate) Fixed Ip (Removefixedip Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-remove-fixed-ip-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|