nova/api-ref/source/os-fixed-ips.inc
Ronald Bradford 04fb00d539 Complete method verification of os-fixed-ips
Verified the API document for os-fixed-ips with source for methods
available and response codes.

Part of bp:api-ref-in-rst

Change-Id: I60096911a7895d989e056958e175477987cc72f8
2016-05-06 12:30:28 -04:00

69 lines
1.5 KiB
ReStructuredText

.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
==========================
Fixed IPs (os-fixed-ips)
==========================
Shows data for a fixed IP, such as host name, CIDR, and address. Also,
reserves and releases a fixed IP address.
Show Fixed Ip Details
=====================
.. rest_method:: GET /v2.1/{tenant_id}/os-fixed-ips/{fixed_ip}
Shows details for a fixed IP address.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- fixed_ip: fixed_ip
Response
--------
**Example Show Fixed Ip Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-fixed-ips/fixedips-get-resp.json
:language: javascript
Reserve Or Release A Fixed Ip
=============================
.. rest_method:: POST /v2.1/{tenant_id}/os-fixed-ips/{fixed_ip}/action
Reserves or releases a fixed IP.
To reserve a fixed IP address, specify ``reserve`` in the request body. To release a fixed IP address, specify ``unreserve`` in the request body.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- fixed_ip: fixed_ip
**Example Reserve Or Release A Fixed Ip: JSON request**
.. literalinclude:: ../../doc/api_samples/os-fixed-ips/fixedip-post-req.json
:language: javascript
Response
--------