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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
.. -*- rst -*-
Group snapshots (group_snapshots)
=================================
Lists all, lists all with details, shows details for, creates, and
deletes group snapshots.
Delete group snapshot
~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v3/{project_id}/group_snapshots/{group_snapshot_id}
Deletes a group snapshot.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
- 400
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
Show group snapshot details
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/group_snapshots/{group_snapshot_id}
Shows details for a group snapshot.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 200
.. rest_status_code:: error ../status.yaml
- 400
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- group_snapshot: group_snapshot
- created_at: created_at
- group_id: source_group_id_req
- id: group_snapshot_id_req
- name: name_group_snap_req
- status: status_group_snap
- description: description_group_snap_req
- group_type_id: group_type_id
- project_id: project_id_group_snapshot
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-show-response.json
:language: javascript
List group snapshots with details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/group_snapshots/detail
Lists all group snapshots with details. 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
- all_tenants: all-tenants
- sort_key: sort_key_group_snapshot
- sort_dir: sort_dir_group_snapshot
- limit: limit_group_snapshot
- offset: offset_group_snapshot
- marker: marker_group_snapshot
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- group_snapshots: group_snapshots
- id: group_snapshot_id_req
- name: name_group_snap_req
- status: status_group_snap
- description: description_group_snap_req
- created_at: created_at
- group_id: group_id
- group_type_id: group_type_id
- project_id: project_id_group_snapshot
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-list-detailed-response.json
:language: javascript
List group snapshots
~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/group_snapshots
Lists all group snapshots, 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
- all_tenants: all-tenants
- sort_key: sort_key_group_snapshot
- sort_dir: sort_dir_group_snapshot
- limit: limit_group_snapshot
- offset: offset_group_snapshot
- marker: marker_group_snapshot
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- group_snapshots: group_snapshots
- id: group_snapshot_id_req
- name: name_group_snap_req
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-list-response.json
:language: javascript
Create group snapshot
~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/group_snapshots
Creates a group snapshot.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
- 400
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- group_snapshot: group_snapshot
- name: name_group_snap
- description: description_group_snap
- group_id: group_id
Request Example
---------------
.. literalinclude:: ./samples/group-snapshots-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- group_snapshot: group_snapshot
- id: group_snapshot_id_req
- name: name_group_snap_req
- group_type_id: group_type_id
Response Example
----------------
.. literalinclude:: ./samples/group-snapshots-create-response.json
:language: javascript
Reset group snapshot status
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method::
POST /v3/{project_id}/group_snapshots/{group_snapshot_id}/action
Resets the status for a group snapshot. Specifies the ``reset_status`` action
in the request body.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
- 400
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
- reset_status: reset_status
- status: status_group_snap
Request Example
---------------
.. literalinclude:: ./samples/group-snapshot-reset-status-request.json
:language: javascript
|
