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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
|
.. -*- rst -*-
===============
Volume (volume)
===============
.. versionadded:: 1.32
Information for connecting remote volumes to a node can be associated with a
Node. There are two types of resources, Volume connectors and Volume targets.
Volume connectors contain initiator information of Nodes. Volume targets
contain target information of remote volumes.
Listing, Searching, Creating, Updating, and Deleting of Volume connector
resources are done through the ``v1/volume/connectors`` resource. The same
operations for Volume targets are done through the ``v1/volume/targets``
resources.
List Links of Volume Resources
==============================
.. rest_method:: GET /v1/volume
Return a list of links to all volume resources.
Normal response code: 200
Request
-------
Response
--------
.. rest_parameters:: parameters.yaml
- connectors: volume_connectors_link
- targets: volume_targets_link
- links: links
**Example Volume list response:**
.. literalinclude:: samples/volume-list-response.json
:language: javascript
List Volume Connectors
======================
.. rest_method:: GET /v1/volume/connectors
Return a list of Volume connectors for all nodes.
By default, this query will return the UUID, node UUID, type, and connector ID
for each Volume connector.
Normal response code: 200
Error codes: 400,401,403,404
Request
-------
.. rest_parameters:: parameters.yaml
- node: r_volume_connector_node_ident
- fields: fields
- detail: detail
- limit: limit
- marker: marker
- sort_dir: sort_dir
- sort_key: sort_key
Response
--------
.. rest_parameters:: parameters.yaml
- connectors: volume_connectors
- uuid: uuid
- type: volume_connector_type
- connector_id: volume_connector_connector_id
- node_uuid: node_uuid
- extra: extra
- links: links
- next: next
**Example Volume connector list response:**
.. literalinclude:: samples/volume-connector-list-response.json
:language: javascript
**Example detailed Volume connector list response:**
.. literalinclude:: samples/volume-connector-list-detail-response.json
:language: javascript
Create Volume Connector
=======================
.. rest_method:: POST /v1/volume/connectors
Creates a new Volume connector resource.
This method requires a Node UUID, a connector type and a connector ID.
Normal response code: 201
Error codes: 400,401,403,404,409
Request
-------
.. rest_parameters:: parameters.yaml
- node_uuid: req_node_uuid
- type: volume_connector_type
- connector_id: volume_connector_connector_id
- extra: req_extra
- uuid: req_uuid
**Example Volume connector creation request:**
.. literalinclude:: samples/volume-connector-create-request.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- type: volume_connector_type
- connector_id: volume_connector_connector_id
- node_uuid: node_uuid
- extra: extra
- links: links
**Example Volume connector creation response:**
.. literalinclude:: samples/volume-connector-create-response.json
:language: javascript
Show Volume Connector Details
=============================
.. rest_method:: GET /v1/volume/connectors/{volume_connector_id}
Show details for the given Volume connector.
Normal response code: 200
Error codes: 400,401,403,404
Request
-------
.. rest_parameters:: parameters.yaml
- volume_connector_id: volume_connector_id
- fields: fields
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- type: volume_connector_type
- connector_id: volume_connector_connector_id
- node_uuid: node_uuid
- extra: extra
- links: links
**Example Volume connector details:**
.. literalinclude:: samples/volume-connector-create-response.json
:language: javascript
Update a Volume Connector
=========================
.. rest_method:: PATCH /v1/volume/connectors/{volume_connector_id}
Update a Volume connector.
A Volume connector can be updated only while a node associated with the Volume
connector is powered off.
Normal response code: 200
Error codes: 400,401,403,404,409
Request
-------
The BODY of the PATCH request must be a JSON PATCH document, adhering to
`RFC 6902 <https://tools.ietf.org/html/rfc6902>`_.
.. rest_parameters:: parameters.yaml
- volume_connector_id: volume_connector_id
**Example Volume connector update request:**
.. literalinclude:: samples/volume-connector-update-request.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- type: volume_connector_type
- connector_id: volume_connector_connector_id
- node_uuid: node_uuid
- extra: extra
- links: links
**Example Volume connector update response:**
.. literalinclude:: samples/volume-connector-update-response.json
:language: javascript
Delete Volume Connector
=======================
.. rest_method:: DELETE /v1/volume/connector/{volume_connector_id}
Delete a Volume connector.
A Volume connector can be deleted only while a node associated with the Volume
connector is powered off.
Normal response code: 204
Error codes: 400,401,403,404,409
Request
-------
.. rest_parameters:: parameters.yaml
- volume_connector_id: volume_connector_id
List Volume Targets
===================
.. rest_method:: GET /v1/volume/targets
Return a list of Volume targets for all nodes.
By default, this query will return the UUID, node UUID, volume type, boot
index, and volume ID for each Volume target.
Normal response code: 200
Error codes: 400,401,403,404
Request
-------
.. rest_parameters:: parameters.yaml
- node: r_volume_target_node_ident
- fields: fields
- detail: detail
- limit: limit
- marker: marker
- sort_dir: sort_dir
- sort_key: sort_key
Response
--------
.. rest_parameters:: parameters.yaml
- targets: volume_targets
- uuid: uuid
- volume_type: volume_target_volume_type
- properties: volume_target_properties
- boot_index: volume_target_boot_index
- volume_id: volume_target_volume_id
- extra: extra
- node_uuid: node_uuid
- links: links
- next: next
**Example Volume target list response:**
.. literalinclude:: samples/volume-target-list-response.json
:language: javascript
**Example detailed Volume target list response:**
.. literalinclude:: samples/volume-target-list-detail-response.json
:language: javascript
Create Volume Target
====================
.. rest_method:: POST /v1/volume/targets
Creates a new Volume target resource.
This method requires a Node UUID, volume type, volume ID, and boot index..
Normal response code: 201
Error codes: 400,401,403,404,409
Request
-------
.. rest_parameters:: parameters.yaml
- node_uuid: req_node_uuid
- volume_type: volume_target_volume_type
- properties: req_volume_target_properties
- boot_index: volume_target_boot_index
- volume_id: volume_target_volume_id
- extra: req_extra
- uuid: req_uuid
**Example Volume target creation request:**
.. literalinclude:: samples/volume-target-create-request.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- volume_type: volume_target_volume_type
- properties: volume_target_properties
- boot_index: volume_target_boot_index
- volume_id: volume_target_volume_id
- extra: extra
- node_uuid: node_uuid
- links: links
**Example Volume target creation response:**
.. literalinclude:: samples/volume-target-create-response.json
:language: javascript
Show Volume Target Details
==========================
.. rest_method:: GET /v1/volume/targets/{volume_target_id}
Show details for the given Volume target.
Normal response code: 200
Error codes: 400,401,403,404
Request
-------
.. rest_parameters:: parameters.yaml
- volume_target_id: volume_target_id
- fields: fields
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- volume_type: volume_target_volume_type
- properties: volume_target_properties
- boot_index: volume_target_boot_index
- volume_id: volume_target_volume_id
- extra: extra
- node_uuid: node_uuid
- links: links
**Example Volume target details:**
.. literalinclude:: samples/volume-target-create-response.json
:language: javascript
Update a Volume Target
======================
.. rest_method:: PATCH /v1/volume/targets/{volume_target_id}
Update a Volume target.
A Volume target can be updated only while a node associated with the Volume
target is powered off.
Normal response code: 200
Error codes: 400,401,403,404,409
Request
-------
The BODY of the PATCH request must be a JSON PATCH document, adhering to
`RFC 6902 <https://tools.ietf.org/html/rfc6902>`_.
.. rest_parameters:: parameters.yaml
- volume_target_id: volume_target_id
**Example Volume target update request:**
.. literalinclude:: samples/volume-target-update-request.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- volume_type: volume_target_volume_type
- properties: volume_target_properties
- boot_index: volume_target_boot_index
- volume_id: volume_target_volume_id
- extra: extra
- node_uuid: node_uuid
- links: links
**Example Volume target update response:**
.. literalinclude:: samples/volume-target-update-response.json
:language: javascript
Delete Volume Target
====================
.. rest_method:: DELETE /v1/volume/target/{volume_target_id}
Delete a Volume target.
A Volume target can be deleted only while a node associated with the Volume
target is powered off.
Normal response code: 204
Error codes: 400,401,403,404,409
Request
-------
.. rest_parameters:: parameters.yaml
- volume_target_id: volume_target_id
|
