Api-ref: add 'all_tenants' API query option
Cinder REST API allows one to use a special query parameter
named "all_tenants" to list resources from all projects (tenants)
through the REST API:
`/v3/{project_id}/volumes/detail?all_tenants=1`
However, this option is hardly documented anywhere besides
`/v3/{project_id}/volumes/summary`. So add them.
Change-Id: Ia9cc9e20c3b333a054c90f07e952b61dfad8529e
Closes-Bug: #1743800
This commit is contained in:
@@ -31,6 +31,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
@@ -209,6 +210,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
|
|||||||
@@ -54,6 +54,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
@@ -270,6 +271,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
|
|||||||
@@ -81,6 +81,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@@ -118,6 +119,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
|
|||||||
@@ -110,6 +110,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@@ -204,6 +205,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|||||||
@@ -51,6 +51,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@@ -137,6 +138,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
|
|||||||
@@ -76,6 +76,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@@ -247,6 +248,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
|
|||||||
@@ -98,6 +98,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@@ -145,6 +146,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- marker: marker
|
- marker: marker
|
||||||
@@ -213,6 +214,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- marker: marker
|
- marker: marker
|
||||||
|
|||||||
@@ -58,6 +58,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@@ -334,6 +335,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- marker: marker
|
- marker: marker
|
||||||
|
|||||||
@@ -90,6 +90,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort_key: sort_key_group_snapshot
|
- sort_key: sort_key_group_snapshot
|
||||||
- sort_dir: sort_dir_group_snapshot
|
- sort_dir: sort_dir_group_snapshot
|
||||||
- limit: limit_group_snapshot
|
- limit: limit_group_snapshot
|
||||||
@@ -137,6 +138,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort_key: sort_key_group_snapshot
|
- sort_key: sort_key_group_snapshot
|
||||||
- sort_dir: sort_dir_group_snapshot
|
- sort_dir: sort_dir_group_snapshot
|
||||||
- limit: limit_group_snapshot
|
- limit: limit_group_snapshot
|
||||||
|
|||||||
@@ -37,6 +37,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@@ -213,6 +214,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
|
|||||||
@@ -82,6 +82,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@@ -120,6 +121,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
|
|||||||
@@ -111,6 +111,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@@ -205,6 +206,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|||||||
@@ -55,6 +55,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@@ -162,6 +163,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
|
|||||||
@@ -82,6 +82,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@@ -260,6 +261,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
|
- all_tenants: all-tenants
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@@ -717,7 +719,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
- all_tenants: all_tenants
|
- all_tenants: all-tenants
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|||||||
Reference in New Issue
Block a user