nova/api-ref/source/os-availability-zone.inc
Sean Dague d929b9fc76 add tags to files for the content verification phase
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef

Part of bp:api-ref-in-rst

Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:21:58 -04:00

67 lines
1.6 KiB
ReStructuredText

.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
===========================================
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-list-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-detail-resp.json
:language: javascript