8a80829552
Add missing API document for list availability zone API. Closes-Bug: #1783495 Change-Id: I04bf2063bd6d03fa509ff71e2fd66c1cb14e0fd5
82 lines
2.8 KiB
ReStructuredText
82 lines
2.8 KiB
ReStructuredText
:tocdepth: 2
|
|
|
|
==============================
|
|
Block Storage API V3 (CURRENT)
|
|
==============================
|
|
|
|
.. note::
|
|
|
|
The URL for most API methods includes a ``{project_id}`` placeholder that
|
|
represents the caller's project ID. As of v3.67, the project_id is optional
|
|
in the URL, and the following are equivalent:
|
|
|
|
* ``GET /v3/{project_id}/volumes``
|
|
* ``GET /v3/volumes``
|
|
|
|
In both instances, the actual project ID used by the API method is the one
|
|
in the caller's keystone context. For that reason, including a project ID in
|
|
the URL is redundant.
|
|
|
|
The v3.67 microversion is only used as an indicator that the API accepts a
|
|
URL without a ``{project_id}`` segment, and this applies to all requests
|
|
regardless of the microversion in the request. For example, an API node
|
|
serving v3.67 or greater will accept a URL without a ``{project_id}``
|
|
segment even if the request asks for v3.0. Likewise, it will accept a URL
|
|
containing a ``{project_id}`` segment even if the request asks for v3.67.
|
|
|
|
.. rest_expand_all::
|
|
|
|
.. First thing we want to see is the version discovery document.
|
|
.. include:: api-versions.inc
|
|
.. include:: volumes-v3-versions.inc
|
|
|
|
.. Next top-level thing could be listing extensions available on this endpoint.
|
|
.. include:: volumes-v3-extensions.inc
|
|
|
|
.. To create a volume, I might need a volume type, so list those next.
|
|
.. include:: volumes-v3-types.inc
|
|
.. include:: volume-type-access.inc
|
|
.. include:: default-types.inc
|
|
|
|
.. Now my primary focus is on volumes and what I can do with them.
|
|
.. include:: volumes-v3-volumes.inc
|
|
.. include:: volumes-v3-volumes-actions.inc
|
|
|
|
.. List the other random volume APIs in just alphabetical order.
|
|
.. include:: volume-manage.inc
|
|
.. include:: volumes-v3-snapshots.inc
|
|
.. include:: volumes-v3-snapshots-actions.inc
|
|
.. include:: snapshot-manage.inc
|
|
.. include:: os-vol-transfer-v3.inc
|
|
.. include:: vol-transfer-v3.inc
|
|
|
|
.. Now the other random things in alphabetical order.
|
|
.. include:: attachments.inc
|
|
.. include:: availability-zones-v3.inc
|
|
.. include:: os-vol-pool-v3.inc
|
|
.. include:: ext-backups.inc
|
|
.. include:: ext-backups-actions-v3.inc
|
|
.. include:: capabilities-v3.inc
|
|
.. include:: clusters.inc
|
|
.. include:: consistencygroups-v3.inc
|
|
.. include:: os-cgsnapshots-v3.inc
|
|
.. include:: os-services.inc
|
|
.. include:: groups.inc
|
|
.. include:: group-replication.inc
|
|
.. include:: group-snapshots.inc
|
|
.. include:: group-types.inc
|
|
.. include:: group-type-specs.inc
|
|
.. include:: hosts.inc
|
|
.. include:: limits.inc
|
|
.. include:: messages.inc
|
|
.. include:: resource-filters.inc
|
|
.. include:: qos-specs-v3-qos-specs.inc
|
|
.. quota-sets should arguably live closer to limits, but that would mess up
|
|
our nice alphabetical ordering
|
|
.. include:: quota-classes.inc
|
|
.. include:: quota-sets.inc
|
|
.. include:: worker-cleanup.inc
|
|
|
|
.. valid values for boolean parameters.
|
|
.. include:: valid-boolean-values.inc
|