cinder/api-ref/source/v3/index.rst
Stephen Finucane 1074e2c0e7 api-ref: Add docs for clusters
This API is currently undocumented, as I noticed while working on OSC
changes. There isn't anything too unusual going on here. The API was
first introduced in microversion 3.7 and was then extended with
replication-related information in 3.36. Both are accounted for here.

Change-Id: I86dc774c8d203839f4dadb13e93a416d112fc7b5
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Co-authored-by: Lucas de Oliveira <lucasmoliveira059@gmail.com>
Closes-Bug: 1885544
2022-08-31 10:02:20 +01:00

2.7 KiB

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, 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 even if the request asks for V3.0. Likewise, it will accept a URL containing a project_id even if the request asks for V3.67.