File: quota-classes.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 (131 lines) | stat: -rw-r--r-- 3,153 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
.. -*- rst -*-

Quota class set extension (os-quota-class-sets)
===============================================

Administrators only, depending on policy settings.

Shows and updates quota classes for a project.

Show quota classes for a project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::
   GET /v3/{admin_project_id}/os-quota-class-sets/{quota_class_name}

Shows quota class set for a project. If no specific value for the quota class
resource exists, then the default value will be reported.

Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 200

.. rest_status_code:: error ../status.yaml

   - 403
   - 404


Request
-------

.. rest_parameters:: parameters.yaml

   - quota_class_name: quota_class_name
   - admin_project_id: admin_project_id


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - quota_class_set: quota_class_set
   - backup_gigabytes: maxTotalBackupGigabytes
   - backups: maxTotalBackups
   - gigabytes: maxTotalVolumeGigabytes
   - gigabytes_{volume_type}: gigabytes_for_type
   - groups: maxTotalGroups
   - per_volume_gigabytes: per_volume_gigabytes
   - snapshots: maxTotalSnapshots
   - snapshots_{volume_type}: snapshots_number_for_type
   - volumes: maxTotalVolumes
   - volumes_{volume_type}: volumes_number_for_type
   - id: quota_class_id


Response Example
----------------

.. literalinclude:: ./samples/quota_classes/quota-classes-show-response.json
   :language: javascript

Update quota classes for a project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::
   PUT /v3/{admin_project_id}/os-quota-class-sets/{quota_class_name}

Updates quota class set for a project. If the ``quota_class_name`` key does not
exist, then the API will create one.

Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 200

.. rest_status_code:: error ../status.yaml

   - 400
   - 403
   - 404


Request
-------

.. rest_parameters:: parameters.yaml

   - admin_project_id: admin_project_id
   - quota_class_name: quota_class_name
   - gigabytes: maxTotalVolumeGigabytesOptional
   - gigabytes_{volume_type}: gigabytes_for_type
   - snapshots: maxTotalSnapshotsOptional
   - snapshots_{volume_type}: snapshots_number_for_type
   - volumes: maxTotalVolumesOptional
   - volumes_{volume_type}: volumes_number_for_type

Request Example
---------------

.. literalinclude:: ./samples/quota_classes/quota-classes-update-request.json
   :language: javascript


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - quota_class_set: quota_class_set
   - backup_gigabytes: maxTotalBackupGigabytes
   - backups: maxTotalBackups
   - gigabytes: maxTotalVolumeGigabytes
   - gigabytes_{volume_type}: gigabytes_for_type
   - groups: maxTotalGroups
   - per_volume_gigabytes: per_volume_gigabytes
   - snapshots: maxTotalSnapshots
   - snapshots_{volume_type}: snapshots_number_for_type
   - volumes: maxTotalVolumes
   - volumes_{volume_type}: volumes_number_for_type

Response Example
----------------

.. literalinclude:: ./samples/quota_classes/quota-classes-update-response.json
   :language: javascript