File: os-vol-pool-v3.inc

package info (click to toggle)
cinder 2%3A17.0.1-1%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 36,796 kB
  • sloc: python: 395,277; pascal: 2,085; sh: 585; makefile: 111; xml: 26; sql: 5
file content (59 lines) | stat: -rw-r--r-- 1,251 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
.. -*- 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