nova/api-ref/source/os-availability-zone.inc
jichenjc ffee1b3444 Complet Method Verification of availability-zone
verified the API doc for os-availability-zone, Added
one description for default policy
Also, remove some common error code like 500, 503 etc

detail log: http://paste.openstack.org/show/495423/

Part of bp:api-ref-in-rst

Change-Id: Icb898f0482e8a17289cd5047ef1c64a2481ccabb
2016-04-23 01:56:55 +08:00

65 lines
1.5 KiB
ReStructuredText

.. -*- rst -*-
.. 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: unauthorized(401), forbidden(403)
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.
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
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