manila/api-ref/source/availability-zones.inc
junboli acf8c99e9b Use rest_status_code for api-ref response codes
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.

https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code

Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-24 01:07:16 +00:00

59 lines
1.0 KiB
ReStructuredText

.. -*- rst -*-
==================
Availability zones
==================
Describes availability zones that the Shared File Systems service is
configured with.
.. important::
For API versions 2.6 and prior, replace ``availability-zones`` in the URLs
with ``os-availability-zone``.
List availability zones
=======================
.. rest_method:: GET /v2/{tenant_id}/availability-zones
Lists all availability zones.
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- availability_zones: availability_zones
- id: availability_zone_id
- name: availability_zone_name
- created_at: availability_zone_created_at
- updated_at: availability_zone_updated_at
Response example
----------------
.. literalinclude:: samples/availability-zones-list-response.json
:language: javascript