manila/api-ref/source/availability-zones.inc
Goutham Pacha Ravi f185ff0f44 [api-ref] De-duplicate date and time parameters
Many APIs present information when the resource
in question was 'created_at' and 'updated_at'.

Having common parameters is easier to maintain in
the documentation since the description is the same
across the board.

Change-Id: Ia5d4ac399fe0d7983c61f5c5e0245d0987e97d6a
Partial-Bug: #1760644
2019-04-04 15:59:32 +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/{project_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
- project_id: project_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- availability_zones: availability_zones
- id: availability_zone_id
- name: availability_zone_name
- created_at: created_at
- updated_at: updated_at
Response example
----------------
.. literalinclude:: samples/availability-zones-list-response.json
:language: javascript