nova/api-ref/source/os-availability-zone.inc
Sean Dague d4e2771440 Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.

Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-13 07:34:45 -04:00

63 lines
1.5 KiB
ReStructuredText

.. -*- rst -*-
===========================================
Availability zones (os-availability-zone)
===========================================
Shows availability zone information.
Get Availability Zone Information
=================================
.. rest_method:: GET /v2.1/{tenant_id}/os-availability-zone
Gets availability zone information.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
**Example Get availability zone information: JSON response**
.. literalinclude:: ../../doc/api_samples/os-availability-zone/availability-zone-show-resp.json
:language: javascript
Get Detailed Availability Zone Information
==========================================
.. rest_method:: GET /v2.1/{tenant_id}/os-availability-zone/detail
Gets detailed availability zone information.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
**Example Get detailed availability zone information: JSON response**
.. literalinclude:: ../../doc/api_samples/os-availability-zone/availability-zone-show-details-resp.json
:language: javascript