summaryrefslogtreecommitdiff
path: root/api-ref/source/dns-api-v2-quota.inc
blob: f9f48b534b3d642d765adcdde7b2dc1170f0aaf3 (plain)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
======
Quotas
======

Quota operations.


View Quotas
===========

.. rest_method::  GET /v2/quotas/{project_id}

View a projects quotas

This returns a key:value set of quotas on the system.

.. note::

   If a user is viewing another projects quotas, they will need to set
   ``x-auth-all-projects`` to ``True``


   They will need a role with the ``All-Projects`` permission to do this.


.. rest_status_code:: success status.yaml

   - 200


.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 403
   - 404
   - 405
   - 409
   - 503


Request
-------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - project_id: path_project_id


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

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id


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

.. literalinclude:: samples/quotas/get-quotas-response.json
   :language: javascript


View Current Project's Quotas
=============================

.. rest_method::  GET /v2/quotas/

View the quotas for the current project

This returns a key:value set of quotas on the system.


.. rest_status_code:: success status.yaml

   - 200


.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 403
   - 404
   - 409
   - 503


Request
-------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - project_id: path_project_id


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

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id


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

.. literalinclude:: samples/quotas/get-quotas-response.json
   :language: javascript


Set Quotas
==========

.. rest_method::  PATCH /v2/quotas/{project_id}

Set a projects quotas

The request should be a key:value set of quotas to be set

This returns a key:value set of quotas on the system.

.. note::

   If a user is updating another projects quotas, they will need to set
   ``x-auth-all-projects`` to ``True``


   They will need a role with the "All-Projects" and "set-quotas"
   permission to do this.



.. rest_status_code:: success status.yaml

   - 200


.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 403
   - 404
   - 405
   - 409
   - 503


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

.. literalinclude:: samples/quotas/set-quotas-request.json
   :language: javascript

Request
-------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - project_id: path_project_id


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

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id


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

.. literalinclude:: samples/quotas/set-quotas-response.json
   :language: javascript





Reset Quotas
============

.. rest_method::  DELETE /v2/quotas/{project_id}

Reset all quotas for a project to default

.. note::

   If a user is resetting another projects quotas, they will need to set
   ``x-auth-all-projects`` to ``True``

   They will need a role with the ``All-Projects`` and "set-quotas"
   permission to do this.



.. rest_status_code:: success status.yaml

   - 204


.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 403
   - 404
   - 405
   - 409
   - 503


Request
-------

.. rest_parameters:: parameters.yaml

   - x-auth-token: x-auth-token
   - x-auth-all-projects: x-auth-all-projects
   - x-auth-sudo-project-id: x-auth-sudo-project-id
   - project_id: path_project_id


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

.. rest_parameters:: parameters.yaml

   - x-openstack-request-id: x-openstack-request-id