609412fcd2
The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
60 lines
1.2 KiB
ReStructuredText
60 lines
1.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Back-end storage pools
|
|
======================
|
|
|
|
Administrator only. Lists all back-end storage pools that are known
|
|
to the scheduler service.
|
|
|
|
|
|
List all back-end storage pools
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{project_id}/scheduler-stats/get_pools
|
|
|
|
Lists all back-end storage pools. Since v3.31 if non-admin users
|
|
specify invalid filters in the url, API will return bad request.
|
|
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
- 400
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- detail: detail
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- pools: pools
|
|
- updated: updated
|
|
- QoS_support: QoS_support
|
|
- name: name_backend_pool
|
|
- total_capacity_gb: total_capacity
|
|
- volume_backend_name: volume_backend_name
|
|
- capabilities: capabilities
|
|
- free_capacity_gb: free_capacity
|
|
- driver_version: driver_version
|
|
- reserved_percentage: reserved_percentage
|
|
- storage_protocol: storage_protocol
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/pools-list-detailed-response.json
|
|
:language: javascript
|