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
69 lines
1.4 KiB
ReStructuredText
69 lines
1.4 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 /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
|
|
|
|
|
|
- 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 /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
|
|
|
|
|
|
- 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
|
|
--------
|
|
|