cinder/api-ref/source/v3/availability-zones-v3.inc
TommyLike 8a80829552 Add API document for availability zone list
Add missing API document for list availability zone API.

Closes-Bug: #1783495
Change-Id: I04bf2063bd6d03fa509ff71e2fd66c1cb14e0fd5
2024-08-28 14:57:48 +00:00

46 lines
869 B
ReStructuredText

.. -*- rst -*-
Availability zones (os-availability-zone)
=========================================
List availability zone information.
List Availability Zone Information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/os-availability-zone
List availability zone information.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 200
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
Response Parameter
------------------
.. rest_parameters:: parameters.yaml
- project_id: project_id
- availabilityZoneInfo: availability_zone_info
- zoneName: availability_zone_required
- zoneState: availability_zone_state
- available: available
Response Example
----------------
.. literalinclude:: ./samples/availability-zone-list-response.json
:language: javascript