Update css file name in conf.py
[multicloud/framework.git] / docs / MultiCloud-APIv0-Specification.rst
1 ..
2  This work is licensed under a Creative Commons Attribution 4.0
3  International License.
4
5 ================================
6 MultiCloud API v0 Specification
7 ================================
8
9 API in json swagger
10 ===================
11
12 ":download:`MultiCloud Broker API v0 <https://wiki.onap.org/download/attachments/25435675/multicloud.broker.v0.swagger.json?version=1&modificationDate=1557892177024&api=v2>`"
13
14 API Catalog
15 ===========
16
17 1. **Scope**
18 ^^^^^^^^^^^^
19
20 The scope of the present document is to describe the VIM Driver API
21 specification.
22
23 2. **Terms, Definitions and Abbreviations**
24 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25
26 For the purposes of the present document, the following abbreviations
27 apply:
28
29 +--------------------+-------------------------------------------------------------+
30 | **Abbreviation**   |                                                             |
31 +====================+=============================================================+
32 | NFVO               | Network Functions Virtualization Orchestrator               |
33 +--------------------+-------------------------------------------------------------+
34 | VNFM               | Virtual Network Function Management                         |
35 +--------------------+-------------------------------------------------------------+
36 | VIM                | Virtualized Infrastructure Manager                          |
37 +--------------------+-------------------------------------------------------------+
38 | MultiVIM           | MultVIM driver services for OPEN-O to drive VIM instances   |
39 +--------------------+-------------------------------------------------------------+
40
41 3. **Image Management**
42 ^^^^^^^^^^^^^^^^^^^^^^^
43
44 3.1. **Create Image**
45 ---------------------
46
47 +---------------------+-------------------------------------------------------------------------------+
48 | **IF Definition**   | **Description**                                                               |
49 +=====================+===============================================================================+
50 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images    |
51 +---------------------+-------------------------------------------------------------------------------+
52 | Operation           | POST                                                                          |
53 +---------------------+-------------------------------------------------------------------------------+
54 | Direction           | NSLCM->MULTIVIM                                                               |
55 +---------------------+-------------------------------------------------------------------------------+
56 | Description         | Create Image and Upload the image file to the VIM                             |
57 +---------------------+-------------------------------------------------------------------------------+
58
59 3.1.1. **Request**
60 >>>>>>>>>>>>>>>>>>
61
62 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
63 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                  |
64 +===================+=================+===================+===========================+==================================================================================================+
65 | name              | M               | 1                 | String                    | Image Name                                                                                       |
66 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
67 | imagePath         | M               | 1                 | String                    | Image Local Path from catalog                                                                    |
68 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
69 | imageType         | M               | 1                 | String                    | Image Type                                                                                       |
70 |                   |                 |                   |                           |                                                                                                  |
71 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso                                             |
72 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
73 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                                                           |
74 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
75 | visibility        | O               | 1                 | string                    | Visibility for this image.                                                                       |
76 |                   |                 |                   |                           |                                                                                                  |
77 |                   |                 |                   |                           | public, private, shared, or community                                                            |
78 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
79 | properties        | O               | 0..N              | List of key-value pairs   | Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic"     |
80 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
81
82 ::
83
84     {
85
86     "imageName": "cirros",
87
88     "imagePath": "/home/cirros.qcow2",
89
90     "imageType": "qcow2"
91
92     "containerFormat":"bare"
93
94     }
95
96 3.1.2. **Response**
97 >>>>>>>>>>>>>>>>>>>
98
99 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
100 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                        |
101 +===================+=================+===================+===========================+========================================================+
102 | id                | M               | 1                 | String                    | Image UUID in the VIM                                  |
103 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
104 | name              | M               | 1                 | String                    | Image Name                                             |
105 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
106 | returnCode        | M               | 1                 | Int                       | 0: Already exist 1: Newly created                      |
107 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
108 | imageType         | M               | 1                 | String                    | Image Type                                             |
109 |                   |                 |                   |                           |                                                        |
110 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
111 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
112 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                 |
113 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
114 | visibility        | O               | 1                 | string                    | Visibility for this image.                             |
115 |                   |                 |                   |                           |                                                        |
116 |                   |                 |                   |                           | public, private, shared, or community                  |
117 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
118 | properties        | O               | 0..N              | List of key-value pairs   |                                                        |
119 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
120 | vimid             | M               | 1                 | String                    | vim id                                                 |
121 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
122 | vimName           | O               | 1                 | string                    | vim name                                               |
123 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
124 | tenantId          | M               | 1                 | String                    | Tenant UUID                                            |
125 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
126
127 *202*: accepted
128
129 500: failed
130
131 ::
132
133     {
134         "id": "3c9eebdbbfd345658269340b9ea6fb73",
135         "name": "cirros",
136         "returnCode": 1
137     }
138
139 3.2. **Delete Image**
140 ---------------------
141
142 +---------------------+-----------------------------------------------------------------------------------------+
143 | **IF Definition**   | **Description**                                                                         |
144 +=====================+=========================================================================================+
145 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images/{imageId}    |
146 +---------------------+-----------------------------------------------------------------------------------------+
147 | Operation           | Delete                                                                                  |
148 +---------------------+-----------------------------------------------------------------------------------------+
149 | Direction           | NSLCM->MULTIVIM                                                                         |
150 +---------------------+-----------------------------------------------------------------------------------------+
151 | Description         | Delete Image                                                                            |
152 +---------------------+-----------------------------------------------------------------------------------------+
153
154 3.2.1. **Request**
155 >>>>>>>>>>>>>>>>>>
156
157 N/A
158
159 3.2.2. **Response**
160 >>>>>>>>>>>>>>>>>>>
161
162 204: no content
163
164 3.3. **List Images**
165 --------------------
166
167 +---------------------+-------------------------------------------------------------------------------+
168 | **IF Definition**   | **Description**                                                               |
169 +=====================+===============================================================================+
170 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud_owner}\_{region}/{tenantid}/images   |
171 +---------------------+-------------------------------------------------------------------------------+
172 | Operation           | GET                                                                           |
173 +---------------------+-------------------------------------------------------------------------------+
174 | Direction           | NSLCM->MULTIVIM                                                               |
175 +---------------------+-------------------------------------------------------------------------------+
176 | Description         | Query Image list                                                              |
177 +---------------------+-------------------------------------------------------------------------------+
178
179 3.3.1. **Request**
180 >>>>>>>>>>>>>>>>>>
181
182 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
183 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                  |
184 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
185 | limit           | O               | 1                 | integer       | Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.   |
186 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
187 | marker          | O               | 1                 | string        | The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.                                                   |
188 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
189 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of an image                                                                                                                                                                               |
190 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
191
192 3.3.2. **Response**
193 >>>>>>>>>>>>>>>>>>>
194
195 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
196 | \ **Parameter**                                 | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
197 +=================================================+=================+===================+===============+========================================================+
198 | images                                          | M               | 0..N              | List          | Image List                                             |
199 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
200 | id                                              | M               | 1                 | String        | Image ID                                               |
201 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
202 | size                                            | M               | 1                 | int           | Image Size                                             |
203 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
204 | name                                            | M               | 1                 | String        | Image Name                                             |
205 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
206 | status                                          | M               | 1                 | String        | Image Status                                           |
207 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
208 | imageType                                       | M               | 1                 | String        | Image Type                                             |
209 |                                                 |                 |                   |               |                                                        |
210 |                                                 |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
211 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
212 | containerFormat                                 | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
213 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
214 | visibility                                      | O               | 1                 | string        | Visibility for this image.                             |
215 |                                                 |                 |                   |               |                                                        |
216 |                                                 |                 |                   |               | public, private, shared, or community                  |
217 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
218 | vimId                                           | M               | 1                 | String        | vim id                                                 |
219 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
220 | vimName                                         | O               | 1                 | string        | vim name                                               |
221 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
222 | tenantId                                        | M               | 1                 | String        | Tenant UUID                                            |
223 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
224
225 200: ok
226
227 500: failed
228
229 ::
230
231     {
232         "vimid": "",
233         "vimname": "",
234         "imageList": [{
235             "status": "active",
236             "id": "5e2757c1-f846-4727-915c-9a872553ed75",
237             "size": 862016,
238             "name": "vim-plus-cgsl40g-z.qcow2"
239         }]
240     }
241
242
243 3.4. **Get Image**
244 ------------------
245
246 +---------------------+-----------------------------------------------------------------------------------------+
247 | **IF Definition**   | **Description**                                                                         |
248 +=====================+=========================================================================================+
249 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid}   |
250 +---------------------+-----------------------------------------------------------------------------------------+
251 | Operation           | GET                                                                                     |
252 +---------------------+-----------------------------------------------------------------------------------------+
253 | Direction           | NSLCM->MULTIVIM                                                                         |
254 +---------------------+-----------------------------------------------------------------------------------------+
255 | Description         | Query Image Information                                                                 |
256 +---------------------+-----------------------------------------------------------------------------------------+
257
258 3.4.1. **Request**
259 >>>>>>>>>>>>>>>>>>
260
261 N/A
262
263 3.4.2. **Response**
264 >>>>>>>>>>>>>>>>>>>
265
266 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
267 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
268 +===================+=================+===================+===============+========================================================+
269 | id                | M               | 1                 | String        | Image ID                                               |
270 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
271 | size              | M               | 1                 | int           | Image Size                                             |
272 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
273 | name              | M               | 1                 | String        | Image Name                                             |
274 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
275 | status            | M               | 1                 | String        | Image Status                                           |
276 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
277 | imageType         | M               | 1                 | String        | Image Type                                             |
278 |                   |                 |                   |               |                                                        |
279 |                   |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
280 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
281 | containerFormat   | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
282 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
283 | visibility        | O               | 1                 | string        | Visibility for this image.                             |
284 |                   |                 |                   |               |                                                        |
285 |                   |                 |                   |               | public, private, shared, or community                  |
286 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
287 | vimId             | M               | 1                 | String        | vim id                                                 |
288 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
289 | vimName           | M               | 1                 | string        | vim name                                               |
290 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
291 | tenantId          | M               | 1                 | String        | Tenant UUID                                            |
292 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
293
294 200: ok
295
296 500: failed
297
298 ::
299
300     {
301         "vimid": "",
302         "vimname": "",
303         "status": "active",
304         "id": "5e2757c1-f846-4727-915c-9a872553ed75",
305         "size": 862016,
306         "name": "vim-plus-cgsl40g-z.qcow2"
307     }
308
309 4. **Network Management**
310 ^^^^^^^^^^^^^^^^^^^^^^^^^
311
312 4.1. **Create Network**
313 -----------------------
314
315 +---------------------+---------------------------------------------------------------------------------+
316 | **IF Definition**   | **Description**                                                                 |
317 +=====================+=================================================================================+
318 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
319 +---------------------+---------------------------------------------------------------------------------+
320 | Operation           | POST                                                                            |
321 +---------------------+---------------------------------------------------------------------------------+
322 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                          |
323 +---------------------+---------------------------------------------------------------------------------+
324 | Description         | Create network and subnetwork on the VIM                                        |
325 +---------------------+---------------------------------------------------------------------------------+
326
327 4.1.1. **Request**
328 >>>>>>>>>>>>>>>>>>
329
330 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
331 | **Parameter**               | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
332 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
333 | name                        | M               | 1                 | String        | Logical network name                                                                                                                                                                                                                                                                      |
334 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
335 | shared                      | M               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
336 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
337 | vlanTransparent             | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
338 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
339 | networkType                 | O               | 1                 | String        | Network type                                                                                                                                                                                                                                                                              |
340 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
341 |                             |                 |                   |               | flat, vlan, vxlan, gre,                                                                                                                                                                                                                                                                   |
342 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
343 |                             |                 |                   |               | portgroup                                                                                                                                                                                                                                                                                 |
344 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
345 | segmentationId              | O               | 1                 | Int           | id of paragraph                                                                                                                                                                                                                                                                           |
346 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
347 | physicalNetwork             | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
348 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
349 | routerExternal              | O               | 1                 | boolean       |Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                      |
350 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
351
352 ::
353
354     {
355         "tenant": "tenant1",
356         "networkName": "ommnet",
357         "shared": 1,
358         "vlanTransparent": 1,
359         "networkType": "vlan",
360         "segmentationId": 202,
361         "physicalNetwork": "ctrl",
362         "routerExternal": 0
363     }
364
365 4.1.2. **Response**
366 >>>>>>>>>>>>>>>>>>>
367
368 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
369 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
370 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
371 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
372 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
373 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
374 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
375 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
376 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
377 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
378 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
379 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
380 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
381 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
382 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
383 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
384 | physicalNetwork   | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
385 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
386 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
387 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
388 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
389 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
390 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
391 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
392 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
393 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
394 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
395 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
396 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
397 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
398
399 202: accepted
400
401 500: failed
402
403 ::
404
405     {
406         "returnCode": 0,
407         "vimId": "11111",
408         "vimName": "11111",
409         "status": "ACTIVE",
410         "id": "3c9eebdbbfd345658269340b9ea6fb73",
411         "name": "net1",
412         "tenant": "tenant1",
413         "networkName": "ommnet",
414         "shared": 1,
415         "vlanTransparent": 1,
416         "networkType": "vlan",
417         "segmentationId": 202,
418         "physicalNetwork": "ctrl",
419         "routerExternal": 0
420     }
421
422 4.2. **Delete Network**
423 -----------------------
424
425 +---------------------+---------------------------------------------------------------------------------------------+
426 | **IF Definition**   | **Description**                                                                             |
427 +=====================+=============================================================================================+
428 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
429 +---------------------+---------------------------------------------------------------------------------------------+
430 | Operation           | Delete                                                                                      |
431 +---------------------+---------------------------------------------------------------------------------------------+
432 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
433 +---------------------+---------------------------------------------------------------------------------------------+
434
435 4.2.1. **Request**
436 >>>>>>>>>>>>>>>>>>
437
438 N/A
439
440 4.2.2. **Response**
441 >>>>>>>>>>>>>>>>>>>
442
443 204: no content
444
445 4.3. **List Network**
446 ---------------------
447
448 +---------------------+---------------------------------------------------------------------------------+
449 | **IF Definition**   | **Description**                                                                 |
450 +=====================+=================================================================================+
451 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
452 +---------------------+---------------------------------------------------------------------------------+
453 | Operation           | get                                                                             |
454 +---------------------+---------------------------------------------------------------------------------+
455 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
456 +---------------------+---------------------------------------------------------------------------------+
457
458 4.3.1. **Query**
459 >>>>>>>>>>>>>>>>
460
461 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
462 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                       |
463 +=================+=================+===================+===============+=======================================================================================+
464 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of a network   |
465 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
466
467 4.3.2. **Response**
468 >>>>>>>>>>>>>>>>>>>
469
470 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
471 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
472 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
473 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
474 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
475 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
476 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
477 | networks          |                 | 0..N              | List          | Network list                                                                                                                                                                                                                                                                              |
478 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
479 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
480 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
481 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
482 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
483 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
484 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
485 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
486 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
487 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
488 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
489 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
490 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
491 | physicalNetwork   | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
492 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
493 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
494 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
495 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
496 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
497 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
498 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
499
500 200: ok
501
502 500: failed
503
504 ::
505
506     {
507
508         "vimId": "11111",
509
510         "vimName": "111",
511
512         "networks":
513
514             [{
515
516                 "status": "ACTIVE",
517
518                 "id": "3c9eebdbbfd345658269340b9ea6fb73",
519
520                 "name": "net1",
521
522                 "tenant": "tenant1",
523
524                 "networkName": "ommnet",
525
526                 "shared": 1,
527
528                 "vlanTransparent": 1,
529
530                 "networkType": "vlan",
531
532                 "segmentationId": 202,
533
534                 "physicalNetwork ": "ctrl",
535
536                 "routerExternal ": 0
537
538             }]
539
540     }
541
542 4.4. **Get Network**
543 --------------------
544
545 +---------------------+---------------------------------------------------------------------------------------------+
546 | **IF Definition**   | **Description**                                                                             |
547 +=====================+=============================================================================================+
548 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
549 +---------------------+---------------------------------------------------------------------------------------------+
550 | Operation           | get                                                                                         |
551 +---------------------+---------------------------------------------------------------------------------------------+
552 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
553 +---------------------+---------------------------------------------------------------------------------------------+
554
555 4.4.1. **Request**
556 >>>>>>>>>>>>>>>>>>
557
558 N/A
559
560 4.4.2. **Response**
561 >>>>>>>>>>>>>>>>>>>
562
563 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
564 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
565 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
566 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
567 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
568 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
569 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
570 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
571 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
572 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
573 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
574 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
575 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
576 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
577 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
578 | physicalNetwork   | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
579 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
580 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
581 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
582 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
583 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
584 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
585 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
586 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
587 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
588 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
589 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
590 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
591 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
592
593 200: ok
594
595 500: failed
596
597 ::
598
599     {
600
601         "vimId":"11111",
602
603         "vimName":"11111",
604
605         "status": "ACTIVE",
606
607         "id": "3c9eebdbbfd345658269340b9ea6fb73",
608
609         "name": "net1",
610
611         "tenant": "tenant1",
612
613         "networkName": "ommnet",
614
615         "shared": 1,
616
617         "vlanTransparent": 1,
618
619         "networkType":"vlan",
620
621         "segmentationId":202,
622
623         "physicalNetwork ":"ctrl",
624
625         "routerExternal ":0
626
627     }
628
629 5. **Subnetwork Management**
630 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
631
632 5.1. **Create Subnets**
633 -----------------------
634
635 +---------------------+--------------------------------------------------------------------------------+
636 | **IF Definition**   | **Description**                                                                |
637 +=====================+================================================================================+
638 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
639 +---------------------+--------------------------------------------------------------------------------+
640 | Operation           | POST                                                                           |
641 +---------------------+--------------------------------------------------------------------------------+
642 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                         |
643 +---------------------+--------------------------------------------------------------------------------+
644 | Description         | Create network and subnetwork on the VIM                                       |
645 +---------------------+--------------------------------------------------------------------------------+
646
647 5.1.1. **Request**
648 >>>>>>>>>>>>>>>>>>
649
650 +-------------------+-----------------+-------------------+------------------------+----------------------+
651 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
652 +===================+=================+===================+========================+======================+
653 | networkId         | M               | 1                 | String                 | Network Id           |
654 +-------------------+-----------------+-------------------+------------------------+----------------------+
655 | name              | M               | 1                 | String                 | SubnetName           |
656 +-------------------+-----------------+-------------------+------------------------+----------------------+
657 | cidr              | M               | 1                 | String                 | Subnet cidr          |
658 +-------------------+-----------------+-------------------+------------------------+----------------------+
659 | ipVersion         | M               | 1                 | Int                    | Ip type              |
660 |                   |                 |                   |                        |                      |
661 |                   |                 |                   |                        | 4,6                  |
662 +-------------------+-----------------+-------------------+------------------------+----------------------+
663 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
664 |                   |                 |                   |                        |                      |
665 |                   |                 |                   |                        | 1: yes;0: no         |
666 +-------------------+-----------------+-------------------+------------------------+----------------------+
667 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
668 +-------------------+-----------------+-------------------+------------------------+----------------------+
669 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
670 +-------------------+-----------------+-------------------+------------------------+----------------------+
671 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
672 +-------------------+-----------------+-------------------+------------------------+----------------------+
673 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
674 +-------------------+-----------------+-------------------+------------------------+----------------------+
675 | -->allocation     |                 |                   |                        |                      |
676 +-------------------+-----------------+-------------------+------------------------+----------------------+
677 | -->start          | O               | 1                 | String                 | Start ip             |
678 +-------------------+-----------------+-------------------+------------------------+----------------------+
679 | -->end            | O               | 1                 | String                 | End ip               |
680 +-------------------+-----------------+-------------------+------------------------+----------------------+
681
682 ::
683
684     {
685
686         "tenant": "tenant1",
687
688         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
689
690         "subnetName": "subnet1",
691
692         "cidr": "10.43.35.0/24",
693
694         "ipVersion": 4,
695
696         "enableDhcp": 1,
697
698         "gatewayIp": "10.43.35.1",
699
700         "dnsNameservers": [],
701
702         "allocationPools": [{
703
704             "start": "192.168.199.2",
705
706             "end": "192.168.199.254"
707
708         }],
709
710         "hostRoutes": []
711
712     }
713
714 5.1.2. **Response**
715 >>>>>>>>>>>>>>>>>>>
716
717 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
718 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**                     |
719 +===================+=================+===================+========================+=====================================+
720 | returnCode        | M               | 1                 | int                    | 0: Already exist 1: Newly created   |
721 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
722 | vimId             | M               | 1                 | String                 | vim id                              |
723 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
724 | vimName           | O               | 1                 | string                 | vim name                            |
725 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
726 | status            | M               | 1                 | string                 | subnetwork status                   |
727 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
728 | id                | M               | 1                 | string                 | subNetwork id                       |
729 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
730 | tenantId          | M               | 1                 | String                 | Tenant UUID                         |
731 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
732 | networkId         | O               | 1                 | String                 | Network Id                          |
733 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
734 | networkName       | O               | 1                 | String                 | Network Name                        |
735 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
736 | name              | M               | 1                 | String                 | SubnetName                          |
737 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
738 | cidr              | M               | 1                 | String                 | Subnet cidr                         |
739 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
740 | ipVersion         | M               | 1                 | Int                    | Ip type                             |
741 |                   |                 |                   |                        |                                     |
742 |                   |                 |                   |                        | 4,6                                 |
743 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
744 | enableDhcp        | O               | 1                 | boolean                | Whether to allow                    |
745 |                   |                 |                   |                        |                                     |
746 |                   |                 |                   |                        | 1: yes;0: no                        |
747 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
748 | gatewayIp         | O               | 1                 | String                 | Gateway ip                          |
749 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
750 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers                     |
751 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
752 | hostRoutes        | O               | 1..n              | List of routes         | List of routes                      |
753 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
754 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation                  |
755 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
756 | -->allocation     |                 |                   |                        |                                     |
757 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
758 | -->start          | O               | 1                 | String                 | Start ip                            |
759 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
760 | -->end            | O               | 1                 | String                 | End ip                              |
761 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
762
763 202: accepted
764
765 500: failed
766
767 ::
768
769     {
770
771         "returnCode": 0,
772
773         "vimId": "11111",
774
775         "vimName": "11111",
776
777         "status": " ACTIVE",
778
779         "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
780
781         "tenant": "tenant1",
782
783         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
784
785         "name": "subnet1",
786
787         "cidr": "10.43.35.0/24",
788
789         "ipVersion": 4,
790
791         "enableDhcp": 1,
792
793         "gatewayIp": "10.43.35.1",
794
795         "dnsNameservers": [],
796
797         "allocationPools": [{
798
799             "start": "192.168.199.2",
800
801             "end": "192.168.199.254"
802
803         }],
804
805         "hostRoutes": []
806
807     }
808
809 5.2. **Delete Subnets**
810 -----------------------
811
812 +---------------------+-------------------------------------------------------------------------------------------+
813 | **IF Definition**   | **Description**                                                                           |
814 +=====================+===========================================================================================+
815 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId}   |
816 +---------------------+-------------------------------------------------------------------------------------------+
817 | Operation           | Delete                                                                                    |
818 +---------------------+-------------------------------------------------------------------------------------------+
819 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
820 +---------------------+-------------------------------------------------------------------------------------------+
821
822 5.2.1. **Request**
823 >>>>>>>>>>>>>>>>>>
824
825 N/A
826
827 5.2.2. **Response**
828 >>>>>>>>>>>>>>>>>>>
829
830 204: no content
831
832 5.3. **List Subnets**
833 ---------------------
834
835 +---------------------+--------------------------------------------------------------------------------+
836 | **IF Definition**   | **Description**                                                                |
837 +=====================+================================================================================+
838 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
839 +---------------------+--------------------------------------------------------------------------------+
840 | Operation           | get                                                                            |
841 +---------------------+--------------------------------------------------------------------------------+
842 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
843 +---------------------+--------------------------------------------------------------------------------+
844
845 5.3.1. **Query**
846 >>>>>>>>>>>>>>>>
847
848 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
849
850 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
851 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                |
852 +=================+=================+===================+===============+================================================================================================+
853 | name            | O               | 1                 | String        | Filters fields of the response by a name, as a string. A valid value is the name of a subnet   |
854 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
855
856 5.3.2. **Response**
857 >>>>>>>>>>>>>>>>>>>
858
859 +-------------------+-----------------+-------------------+------------------------+----------------------+
860 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
861 +===================+=================+===================+========================+======================+
862 | vimId             | M               | 1                 | String                 | vim id               |
863 +-------------------+-----------------+-------------------+------------------------+----------------------+
864 | vimName           | O               | 1                 | string                 | vim name             |
865 +-------------------+-----------------+-------------------+------------------------+----------------------+
866 | subnets           | M               | 0..N              | List                   | Network list         |
867 +-------------------+-----------------+-------------------+------------------------+----------------------+
868 | status            |                 | 1                 | string                 | subnetwork status    |
869 +-------------------+-----------------+-------------------+------------------------+----------------------+
870 | id                |                 | 1                 | string                 | subNetwork id        |
871 +-------------------+-----------------+-------------------+------------------------+----------------------+
872 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
873 +-------------------+-----------------+-------------------+------------------------+----------------------+
874 | networkId         | O               | 1                 | String                 | Network Id           |
875 +-------------------+-----------------+-------------------+------------------------+----------------------+
876 | networkName       | O               | 1                 | String                 | Network Name         |
877 +-------------------+-----------------+-------------------+------------------------+----------------------+
878 | name              | M               | 1                 | String                 | SubnetName           |
879 +-------------------+-----------------+-------------------+------------------------+----------------------+
880 | cidr              | M               | 1                 | String                 | Subnet cidr          |
881 +-------------------+-----------------+-------------------+------------------------+----------------------+
882 | ipVersion         | M               | 1                 | Int                    | Ip type              |
883 |                   |                 |                   |                        |                      |
884 |                   |                 |                   |                        | 4,6                  |
885 +-------------------+-----------------+-------------------+------------------------+----------------------+
886 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
887 |                   |                 |                   |                        |                      |
888 |                   |                 |                   |                        | 1: yes;0: no         |
889 +-------------------+-----------------+-------------------+------------------------+----------------------+
890 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
891 +-------------------+-----------------+-------------------+------------------------+----------------------+
892 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
893 +-------------------+-----------------+-------------------+------------------------+----------------------+
894 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
895 +-------------------+-----------------+-------------------+------------------------+----------------------+
896 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
897 +-------------------+-----------------+-------------------+------------------------+----------------------+
898 | -->allocation     |                 |                   |                        |                      |
899 +-------------------+-----------------+-------------------+------------------------+----------------------+
900 | -->start          | O               | 1                 | String                 | Start ip             |
901 +-------------------+-----------------+-------------------+------------------------+----------------------+
902 | -->end            | O               | 1                 | String                 | End ip               |
903 +-------------------+-----------------+-------------------+------------------------+----------------------+
904
905 **200: ok**
906
907 **500: failed**
908
909 ::
910
911     {
912
913         "vimId": "11111",
914
915         "vimName": "11111",
916
917         "subnets": [
918
919             {
920
921                 "status": " ACTIVE",
922
923                 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
924
925                 "tenant": "tenant1",
926
927                 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
928
929                 "name": "subnet1",
930
931                 "cidr": "10.43.35.0/24",
932
933                 "ipVersion": 4,
934
935                 "enableDhcp": 1,
936
937                 "gatewayIp": "10.43.35.1",
938
939                 "dnsNameservers": [],
940
941                 "allocationPools": [{
942
943                     "start": "192.168.199.2",
944
945                     "end": "192.168.199.254"
946
947                 }],
948
949                 "hostRoutes": []
950
951             }
952
953         ]
954
955     }
956
957 5.4. **Get Subnets**
958 --------------------
959
960 +---------------------+-------------------------------------------------------------------------------------------+
961 | **IF Definition**   | **Description**                                                                           |
962 +=====================+===========================================================================================+
963 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid}   |
964 +---------------------+-------------------------------------------------------------------------------------------+
965 | Operation           | get                                                                                       |
966 +---------------------+-------------------------------------------------------------------------------------------+
967 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
968 +---------------------+-------------------------------------------------------------------------------------------+
969
970 5.4.1. **Request**
971 >>>>>>>>>>>>>>>>>>
972
973 N/A
974
975 5.4.2. **Response**
976 >>>>>>>>>>>>>>>>>>>
977
978 +-------------------+-----------------+-------------------+------------------------+----------------------+
979 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
980 +===================+=================+===================+========================+======================+
981 | vimId             | M               | 1                 | String                 | vim id               |
982 +-------------------+-----------------+-------------------+------------------------+----------------------+
983 | vimName           | O               | 1                 | string                 | vim name             |
984 +-------------------+-----------------+-------------------+------------------------+----------------------+
985 | status            |                 | 1                 | string                 | subnetwork status    |
986 +-------------------+-----------------+-------------------+------------------------+----------------------+
987 | id                |                 | 1                 | string                 | subNetwork id        |
988 +-------------------+-----------------+-------------------+------------------------+----------------------+
989 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
990 +-------------------+-----------------+-------------------+------------------------+----------------------+
991 | networkId         | O               | 1                 | String                 | Network Id           |
992 +-------------------+-----------------+-------------------+------------------------+----------------------+
993 | networkName       | O               | 1                 | String                 | Network Name         |
994 +-------------------+-----------------+-------------------+------------------------+----------------------+
995 | name              | M               | 1                 | String                 | SubnetName           |
996 +-------------------+-----------------+-------------------+------------------------+----------------------+
997 | cidr              | M               | 1                 | String                 | Subnet cidr          |
998 +-------------------+-----------------+-------------------+------------------------+----------------------+
999 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1000 |                   |                 |                   |                        |                      |
1001 |                   |                 |                   |                        | 4,6                  |
1002 +-------------------+-----------------+-------------------+------------------------+----------------------+
1003 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1004 |                   |                 |                   |                        |                      |
1005 |                   |                 |                   |                        | 1: yes;0: no         |
1006 +-------------------+-----------------+-------------------+------------------------+----------------------+
1007 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1008 +-------------------+-----------------+-------------------+------------------------+----------------------+
1009 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1010 +-------------------+-----------------+-------------------+------------------------+----------------------+
1011 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1012 +-------------------+-----------------+-------------------+------------------------+----------------------+
1013 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
1014 +-------------------+-----------------+-------------------+------------------------+----------------------+
1015 | -->allocation     |                 |                   |                        |                      |
1016 +-------------------+-----------------+-------------------+------------------------+----------------------+
1017 | -->start          | O               | 1                 | String                 | Start ip             |
1018 +-------------------+-----------------+-------------------+------------------------+----------------------+
1019 | -->end            | O               | 1                 | String                 | End ip               |
1020 +-------------------+-----------------+-------------------+------------------------+----------------------+
1021
1022 202: accepted
1023
1024 500: failed
1025
1026 ::
1027
1028     {
1029
1030         "status": " ACTIVE",
1031
1032         "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
1033
1034         "tenant": "tenant1",
1035
1036         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
1037
1038         "name": "subnet1",
1039
1040         "cidr": "10.43.35.0/24",
1041
1042         "ipVersion": 4,
1043
1044         "enableDhcp": 1,
1045
1046         "gatewayIp": "10.43.35.1",
1047
1048         "dnsNameservers": [],
1049
1050         "allocationPools": [{
1051
1052             "start": "192.168.199.2",
1053
1054             "end": "192.168.199.254"
1055
1056         }],
1057
1058         "hostRoutes": []
1059
1060     }
1061
1062 6. **Virtual Port**
1063 ^^^^^^^^^^^^^^^^^^^
1064
1065 6.1. **Create Virtual Port**
1066 ----------------------------
1067
1068 +---------------------+------------------------------------------------------------------------------+
1069 | **IF Definition**   | **Description**                                                              |
1070 +=====================+==============================================================================+
1071 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports   |
1072 +---------------------+------------------------------------------------------------------------------+
1073 | Operation           | POST                                                                         |
1074 +---------------------+------------------------------------------------------------------------------+
1075 | Direction           | VNFLCM->MULTIVIM                                                             |
1076 +---------------------+------------------------------------------------------------------------------+
1077
1078 6.1.1. **Request**
1079 >>>>>>>>>>>>>>>>>>
1080
1081 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1082 | **Parameter**          | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                       |
1083 +========================+=================+===================+===============+=======================================================+
1084 | networkId              | M               | 1                 | string        | Network UUID                                          |
1085 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1086 | subnetId               | O               | 1                 | string        | Subnet UUID                                           |
1087 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1088 | name                   | M               | 1                 | string        | Port name                                             |
1089 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1090 | macAddress             | O               | 1                 | string        | Mac address                                           |
1091 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1092 | ip                     | O               | 1                 | string        | Ip address                                            |
1093 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1094 | vnicType               | O               | 1                 | string        | Virtual network card type,                            |
1095 |                        |                 |                   |               |                                                       |
1096 |                        |                 |                   |               | the value of three kinds of normal/direct/macvtap     |
1097 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1098 | \ **securityGroups**   | **O**           | **1**             | **string**    | **The IDs of security groups applied to the port.**   |
1099 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1100
1101 6.1.2. **Response**
1102 >>>>>>>>>>>>>>>>>>>
1103
1104 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1105 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1106 +======================+=================+===================+===============+=====================================================+
1107 | returnCode           | M               | 1                 | int           | 0: Already exist 1: Newly created                   |
1108 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1109 | vimId                | M               | 1                 | String        | vim id                                              |
1110 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1111 | vimName              | O               | 1                 | string        | vim name                                            |
1112 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1113 | status               | M               | 1                 | string        | status                                              |
1114 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1115 | id                   | M               | 1                 | string        | Port Id                                             |
1116 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1117 | name                 | M               | 1                 | string        | Port name                                           |
1118 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1119 | tenantId             | M               | 1                 | String        | Tenant UUID                                         |
1120 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1121 | networkName          | M               | 1                 | string        | Network name                                        |
1122 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1123 | networkId            | M               | 1                 | string        | Network Id                                          |
1124 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1125 | subnetName           | M               | 1                 | string        | Subnet name                                         |
1126 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1127 | subnetId             | M               | 1                 | string        | SubnetId                                            |
1128 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1129 | macAddress           | O               | 1                 | string        | Mac address                                         |
1130 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1131 | ip                   | O               | 1                 | string        | Ip address                                          |
1132 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1133 | vnicType             | O               | 1                 | string        | Virtual network card type,                          |
1134 |                      |                 |                   |               |                                                     |
1135 |                      |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1136 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1137 | **securityGroups**   | **O**           | **1**             | **string**    | **List of security group names.**                   |
1138 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1139
1140 6.2. **Delete Virtual Port**
1141 ----------------------------
1142
1143 +---------------------+---------------------------------------------------------------------------------------+
1144 | **IF Definition**   | **Description**                                                                       |
1145 +=====================+=======================================================================================+
1146 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1147 +---------------------+---------------------------------------------------------------------------------------+
1148 | Operation           | DELETTE                                                                               |
1149 +---------------------+---------------------------------------------------------------------------------------+
1150 | Direction           | VNFLCM->MULTIVIM                                                                      |
1151 +---------------------+---------------------------------------------------------------------------------------+
1152
1153 6.2.1. **Request**
1154 >>>>>>>>>>>>>>>>>>
1155
1156 N/A
1157
1158 6.2.2. **Response**
1159 >>>>>>>>>>>>>>>>>>>
1160
1161 204: no content
1162
1163 6.3. **List Virtual Port**
1164 --------------------------
1165
1166 +---------------------+-----------------------------------------------------------------------------+
1167 | **IF Definition**   | **Description**                                                             |
1168 +=====================+=============================================================================+
1169 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports   |
1170 +---------------------+-----------------------------------------------------------------------------+
1171 | Operation           | GET                                                                         |
1172 +---------------------+-----------------------------------------------------------------------------+
1173 | Direction           | VNFLCM->MULTIVIM                                                            |
1174 +---------------------+-----------------------------------------------------------------------------+
1175
1176 6.3.1. **Query**
1177 >>>>>>>>>>>>>>>>
1178
1179 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1180 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                 |
1181 +=================+=================+===================+===============+=================================================+
1182 | name            | M               | 1                 | string        | Port name to filter out list of virtual ports   |
1183 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1184
1185 6.3.2. **Response**
1186 >>>>>>>>>>>>>>>>>>>
1187
1188 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1189 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1190 +===================+=================+===================+===============+=====================================================+
1191 | vimId             | M               | 1                 | String        | vim id                                              |
1192 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1193 | vimName           | O               | 1                 | string        | vim name                                            |
1194 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1195 | tenantId          | M               | 1                 | String        | Tenant UUID                                         |
1196 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1197 | Ports             | M               | 0..N              | List          | ports                                               |
1198 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1199 | id                | M               | 1                 | string        | Port Id                                             |
1200 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1201 | name              | M               | 1                 | string        | Port name                                           |
1202 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1203 | status            | M               | 1                 | string        | status                                              |
1204 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1205 | **networkName**   | O               | 1                 | string        | Network name                                        |
1206 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1207 | networkId         | M               | 1                 | string        | Network Id                                          |
1208 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1209 | subnetName        | O               | 1                 | string        | Subnet name                                         |
1210 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1211 | subnetId          | M               | 1                 | string        | SubnetId                                            |
1212 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1213 | macAddress        | O               | 1                 | string        | Mac address                                         |
1214 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1215 | ip                | O               | 1                 | string        | Ip address                                          |
1216 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1217 | vnicType          | O               | 1                 | string        | Virtual network card type,                          |
1218 |                   |                 |                   |               |                                                     |
1219 |                   |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1220 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1221 | securityGroups    | O               | 1                 | string        | List of security group names.                       |
1222 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1223
1224 **200: ok**
1225
1226 **500: failed**
1227
1228
1229 6.4. **Get Virtual Port**
1230 -------------------------
1231
1232 +---------------------+---------------------------------------------------------------------------------------+
1233 | **IF Definition**   | **Description**                                                                       |
1234 +=====================+=======================================================================================+
1235 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1236 +---------------------+---------------------------------------------------------------------------------------+
1237 | Operation           | GET                                                                                   |
1238 +---------------------+---------------------------------------------------------------------------------------+
1239 | Direction           | VNFLCM->MULTIVIM                                                                      |
1240 +---------------------+---------------------------------------------------------------------------------------+
1241
1242 6.4.1. **Request**
1243 >>>>>>>>>>>>>>>>>>
1244
1245 N/A
1246
1247 6.4.2. **Response**
1248 >>>>>>>>>>>>>>>>>>>
1249
1250 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1251 | **Parameter**    | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1252 +==================+=================+===================+===============+=====================================================+
1253 | vimId            | M               | 1                 | String        | vim id                                              |
1254 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1255 | vimName          | O               | 1                 | string        | vim name                                            |
1256 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1257 | status           | M               | 1                 | string        | status                                              |
1258 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1259 | id               | M               | 1                 | string        | Port Id                                             |
1260 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1261 | name             | M               | 1                 | string        | Port name                                           |
1262 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1263 | tenantId         | M               | 1                 | String        | Tenant UUID                                         |
1264 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1265 | networkName      | M               | 1                 | string        | Network name                                        |
1266 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1267 | networkId        | M               | 1                 | string        | Network Id                                          |
1268 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1269 | subnetName       | M               | 1                 | string        | Subnet name                                         |
1270 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1271 | subnetId         | M               | 1                 | string        | SubnetId                                            |
1272 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1273 | macAddress       | O               | 1                 | string        | Mac address                                         |
1274 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1275 | ip               | O               | 1                 | string        | Ip address                                          |
1276 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1277 | vnicType         | O               | 1                 | string        | Virtual network card type,                          |
1278 |                  |                 |                   |               |                                                     |
1279 |                  |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1280 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1281 | securityGroups   | O               | 1                 | string        | **List of security group names.**                   |
1282 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1283
1284 **200: ok**
1285
1286 **500: failed**
1287
1288
1289 7. **Server Management**
1290 ^^^^^^^^^^^^^^^^^^^^^^^^
1291
1292 7.1. **Create Server**
1293 ----------------------
1294
1295 +---------------------+--------------------------------------------------------------------------------+
1296 | **IF Definition**   | **Description**                                                                |
1297 +=====================+================================================================================+
1298 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1299 +---------------------+--------------------------------------------------------------------------------+
1300 | Operation           | POST                                                                           |
1301 +---------------------+--------------------------------------------------------------------------------+
1302 | Direction           | VNFLCM->MULTIVIM                                                               |
1303 +---------------------+--------------------------------------------------------------------------------+
1304
1305 7.1.1. **Request**
1306 >>>>>>>>>>>>>>>>>>
1307
1308 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1309 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1310 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1311 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1312 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1313 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1314 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1315 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1316 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1317 | contextArray         | O               | 1..n              | list of context                       | list of context                                                                                                                                                                        |
1318 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1319 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1320 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1321 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1322 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1323 | flavorId             | M               | 1                 | String                                | server Flavor id                                                                                                                                                                       |
1324 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1325 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1326 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1327 | userdata             | O               | 1                 | string                                | Configuration information or scripts to use upon launch. Must be Base64 encoded.                                                                                                       |
1328 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1329 |                      |                 |                   |                                       | NOTE: The ‘null’ value allowed in Nova legacy v2 API, but due to the strict input validation, it isn’t allowed in Nova v2.1 API.                                                       |
1330 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1331 | securityGroups       | O               | 1                 | List of names of security group       | One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.       |
1332 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1333 | serverGroup          | O               | 1                 | string                                | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1334 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1335
1336 **boot**
1337
1338 +-----------------+-----------------+-------------------+---------------+---------------------------+
1339 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**           |
1340 +=================+=================+===================+===============+===========================+
1341 | type            | M               | 1                 | int           | Startup mode              |
1342 |                 |                 |                   |               |                           |
1343 |                 |                 |                   |               | 1. boot from the volume   |
1344 |                 |                 |                   |               |                           |
1345 |                 |                 |                   |               | 2. boot from image        |
1346 +-----------------+-----------------+-------------------+---------------+---------------------------+
1347 | volumeId        | O               | 1                 | string        | Volume Id(type=1)         |
1348 +-----------------+-----------------+-------------------+---------------+---------------------------+
1349 | imageId         | O               | 1                 | String        | ImageId(type=2)         |
1350 +-----------------+-----------------+-------------------+---------------+---------------------------+
1351
1352 **contextArray**
1353
1354 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1355 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                           |
1356 +=================+=================+===================+===============+===========================================================================================================================================================+
1357 | fileName        | M               | 1                 | String        | Injection file name                                                                                                                                       |
1358 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1359 | fileData        | M               | 1                 | string        | Injection file content (injection file content inside the <mac>$MAC\_1</mac> $MAC\_1 need to be replaced by the MAC address, of which 1 is NIC index. )   |
1360 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1361
1362 **volumeArray**
1363
1364 +-----------------+-----------------+-------------------+---------------+-------------------+
1365 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1366 +=================+=================+===================+===============+===================+
1367 | volumeId        | M               | 1                 | String        | Volume Id         |
1368 +-----------------+-----------------+-------------------+---------------+-------------------+
1369
1370 **nicArray**
1371
1372 +-----------------+-----------------+-------------------+---------------+-------------------+
1373 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1374 +=================+=================+===================+===============+===================+
1375 | portId          | M               | 1                 | String        | Port Id           |
1376 +-----------------+-----------------+-------------------+---------------+-------------------+
1377
1378
1379 ::
1380
1381     {
1382
1383         "tenant": "tenant1",
1384
1385         "name": "vm1",
1386
1387         "availabilityZone": "az1",
1388
1389         "flavorName": "vm_large",
1390
1391         "boot": {
1392
1393             "type": 1,
1394
1395             " volumeName": "volume1"
1396
1397         },
1398
1399         "flavorId": "vm_large_134213",
1400
1401         "contextArray": [{
1402
1403             "fileName": "test.yaml",
1404
1405             "fileData": "…."
1406
1407         }],
1408
1409         "volumeArray": [{
1410
1411             "volumeName": "vol1",
1412
1413         }],
1414
1415         "nicArray": [{
1416
1417             "portId": "port_a"
1418
1419         }],
1420
1421         "metada": {
1422
1423             "foo": "foo value"
1424
1425         },
1426
1427         "userdata": "abcdedf"
1428
1429     }
1430
1431 7.1.2. **Response**
1432 >>>>>>>>>>>>>>>>>>>
1433
1434 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1435 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                          | **Description**                                                                                                                                                                        |
1436 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1437 | vimId                | M               | 1                 | String                               | vim id                                                                                                                                                                                 |
1438 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1439 | vimName              | O               | 1                 | string                               | vim name                                                                                                                                                                               |
1440 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1441 | returnCode           |                 | 1                 | int                                  | 0: Already exist 1: Newly created                                                                                                                                                      |
1442 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1443 | id                   | M               | 1                 | string                               | server id                                                                                                                                                                              |
1444 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1445 | name                 |                 | 1                 | string                               | server name                                                                                                                                                                            |
1446 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1447 | tenantId             | M               | 1                 | String                               | Tenant UUID                                                                                                                                                                            |
1448 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1449 | boot                 | M               | 1                 | String                               | Start parameters                                                                                                                                                                       |
1450 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1451 | nicArray             | O               | 1..n              | List of nic                          | List of nic                                                                                                                                                                            |
1452 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1453 | volumeArray          | O               | 1..n              | list of volume                       | list of volume                                                                                                                                                                         |
1454 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1455 | availabilityZone     | O               | 1                 | string                               | Usable field                                                                                                                                                                           |
1456 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1457 | flavorId             | M               | 1                 | String                               | server Flavor                                                                                                                                                                          |
1458 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1459 | metadata             | O               | 1                 | List of metadata                     | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1460 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1461 | **securityGroups**   | **O**           | **1**             | **List of name of security group**   | **One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.**   |
1462 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1463 |                      |                 |                   |                                      | **[TBD]**                                                                                                                                                                              |
1464 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1465 | **serverGroup**      | **O**           | **1**             | **string**                           | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1466 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1467 |                      |                 |                   |                                      | [TBD]                                                                                                                                                                                  |
1468 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1469 | **status**           | **M**           | **1**             | **string**                           | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR                                                                                                                                             |
1470 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1471
1472 202: accepted
1473
1474 500: failed
1475
1476 ::
1477
1478     {
1479
1480     "id": "3c9eebdbbfd345658269340b9ea6fb73",
1481
1482     "name": "vm1",
1483
1484     "returnCode": 1,
1485
1486     }
1487
1488 7.2. **Delete Server**
1489 ----------------------
1490
1491 +---------------------+-------------------------------------------------------------------------------------------+
1492 | **IF Definition**   | **Description**                                                                           |
1493 +=====================+===========================================================================================+
1494 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1495 +---------------------+-------------------------------------------------------------------------------------------+
1496 | Operation           | DELETE                                                                                    |
1497 +---------------------+-------------------------------------------------------------------------------------------+
1498 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1499 +---------------------+-------------------------------------------------------------------------------------------+
1500
1501 7.2.1. **Request**
1502 >>>>>>>>>>>>>>>>>>
1503
1504 N/A
1505
1506 7.2.2. **Response**
1507 >>>>>>>>>>>>>>>>>>>
1508
1509 204: no content
1510
1511 7.3. **List Server**
1512 --------------------
1513
1514 +---------------------+--------------------------------------------------------------------------------+
1515 | **IF Definition**   | **Description**                                                                |
1516 +=====================+================================================================================+
1517 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1518 +---------------------+--------------------------------------------------------------------------------+
1519 | Operation           | get                                                                            |
1520 +---------------------+--------------------------------------------------------------------------------+
1521 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1522 +---------------------+--------------------------------------------------------------------------------+
1523
1524 7.3.1. **Request**
1525 >>>>>>>>>>>>>>>>>>
1526
1527 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1528
1529 +-----------------+-----------------+-------------------+---------------+-------------------+
1530 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1531 +=================+=================+===================+===============+===================+
1532 | name            | M               | 1                 | string        | server name       |
1533 +-----------------+-----------------+-------------------+---------------+-------------------+
1534
1535 7.3.2. **Response**
1536 >>>>>>>>>>>>>>>>>>>
1537
1538 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1539 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1540 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1541 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1542 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1543 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1544 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1545 | servers              | M               | 1                 | array                                 | server list                                                                                                                                                                            |
1546 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1547 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1548 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1549 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1550 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1551 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1552 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1553 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1554 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1555 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1556 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1557 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1558 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1559 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1560 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1561 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1562 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1563 | metada               | O               | 1                 | keypair                               | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1564 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1565 | **securityGroups**   | **O**           | **1**             | **List of names of security group**   | **One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.**   |
1566 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1567 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1568 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1569 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1570 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1571 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1572 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1573
1574 200: ok
1575
1576 500: failed
1577
1578 7.4. **Get Server**
1579 -------------------
1580
1581 +---------------------+-------------------------------------------------------------------------------------------+
1582 | **IF Definition**   | **Description**                                                                           |
1583 +=====================+===========================================================================================+
1584 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1585 +---------------------+-------------------------------------------------------------------------------------------+
1586 | Operation           | get                                                                                       |
1587 +---------------------+-------------------------------------------------------------------------------------------+
1588 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1589 +---------------------+-------------------------------------------------------------------------------------------+
1590
1591 7.4.1. **Request**
1592 >>>>>>>>>>>>>>>>>>
1593
1594 N/A
1595
1596 7.4.2. **Response**
1597 >>>>>>>>>>>>>>>>>>>
1598
1599 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1600 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1601 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1602 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1603 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1604 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1605 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1606 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1607 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1608 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1609 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1610 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1611 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1612 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1613 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1614 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1615 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1616 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1617 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1618 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1619 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1620 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1621 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1622 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1623 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1624 | **securityGroups**   | **O**           | **1**             | **List of names of security group**   | **One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.**   |
1625 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1626 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1627 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1628 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1629 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1630 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1631 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1632
1633 200: ok
1634
1635 500: failed
1636
1637 8. **Flavor Management**
1638 ^^^^^^^^^^^^^^^^^^^^^^^^
1639
1640 8.1. **Create Flavor**
1641 ----------------------
1642
1643 +---------------------+--------------------------------------------------------------------------------+
1644 | **IF Definition**   | **Description**                                                                |
1645 +=====================+================================================================================+
1646 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors   |
1647 +---------------------+--------------------------------------------------------------------------------+
1648 | Operation           | POST                                                                           |
1649 +---------------------+--------------------------------------------------------------------------------+
1650 | Direction           | VNFLCM->MULTIVIM                                                               |
1651 +---------------------+--------------------------------------------------------------------------------+
1652
1653 8.1.1. **Request**
1654 >>>>>>>>>>>>>>>>>>
1655
1656 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1657 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1658 +=================+=================+===================+===============================+==============================================================================================================================+
1659 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1660 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1661 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1662 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1663 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1664 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1665 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1666 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1667 | ephemeral       | O               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1668 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1669 | swap            | O               | 1                 | int                           | The size of the swap disk                                                                                                    |
1670 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1671 | isPublic        | O               | 1                 | boolean                       | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
1672 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1673 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1674 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1675
1676 8.1.2. **Response**
1677 >>>>>>>>>>>>>>>>>>>
1678
1679 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1680 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                                              |
1681 +=================+=================+===================+===========================+==============================================================================================================================+
1682 | id              | M               | 1                 | string                    | Flavor id                                                                                                                    |
1683 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1684 | name            | M               | 1                 | string                    | Flavor name                                                                                                                  |
1685 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1686 | returnCode      | M               | 1                 | int                       | 0: Already exist 1: Newly created                                                                                            |
1687 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1688 | tenantId        | M               | 1                 | String                    | Tenant UUID                                                                                                                  |
1689 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1690 | vcpu            | M               | 1                 | int                       | Virtual CPU number                                                                                                           |
1691 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1692 | memory          | M               | 1                 | int                       | Memory size                                                                                                                  |
1693 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1694 | disk            | M               | 1                 | int                       | The size of the root disk                                                                                                    |
1695 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1696 | ephemeral       | M               | 1                 | int                       | The size of the ephemeral disk                                                                                               |
1697 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1698 | swap            | M               | 1                 | int                       | The size of the swap disk                                                                                                    |
1699 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1700 | isPublic        | M               | 1                 | boolean                   | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
1701 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1702 | extraSpecs      | O               | 0..N              | List of Key-value pairs   | EPA parameter                                                                                                                |
1703 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1704 | vimId           | M               | 1                 | String                    | vim id                                                                                                                       |
1705 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1706 | vimName         | O               | 1                 | string                    | vim name                                                                                                                     |
1707 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1708
1709 8.2. **Delete Flavor**
1710 ----------------------
1711
1712 +---------------------+--------------------------------------------------------------------------------------------+
1713 | **IF Definition**   | **Description**                                                                            |
1714 +=====================+============================================================================================+
1715 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid}   |
1716 +---------------------+--------------------------------------------------------------------------------------------+
1717 | Operation           | DELETE                                                                                     |
1718 +---------------------+--------------------------------------------------------------------------------------------+
1719 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                      |
1720 +---------------------+--------------------------------------------------------------------------------------------+
1721
1722 8.2.1. **Request**
1723 >>>>>>>>>>>>>>>>>>
1724
1725 N/A
1726
1727 8.2.2. **Response**
1728 >>>>>>>>>>>>>>>>>>>
1729
1730 204: no content
1731
1732 8.3. **List Flavor**
1733 --------------------
1734
1735 +---------------------+---------------------------------------------------------------------------------+
1736 | **IF Definition**   | **Description**                                                                 |
1737 +=====================+=================================================================================+
1738 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors   |
1739 +---------------------+---------------------------------------------------------------------------------+
1740 | Operation           | get                                                                             |
1741 +---------------------+---------------------------------------------------------------------------------+
1742 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
1743 +---------------------+---------------------------------------------------------------------------------+
1744
1745 8.3.1. **Query**
1746 >>>>>>>>>>>>>>>>
1747
1748 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1749 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                  |
1750 +=================+=================+===================+===============+==================================+
1751 | name            | M               | 1                 | string        | Flavor name to filter out list   |
1752 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1753
1754 8.3.2. **Response**
1755 >>>>>>>>>>>>>>>>>>>
1756
1757 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1758 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1759 +=================+=================+===================+===============================+==============================================================================================================================+
1760 | flavors         | M               | 0..N              | list                          | Vm list                                                                                                                      |
1761 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1762 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
1763 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1764 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1765 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1766 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1767 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1768 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1769 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1770 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1771 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1772 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1773 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1774 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
1775 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1776 | isPublic        | M               | 1                 | boolean                       | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
1777 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1778 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1779 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1780 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
1781 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1782 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
1783 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1784 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
1785 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1786
1787 200: ok
1788
1789 500: failed
1790
1791 8.4. **Get Flavor**
1792 -------------------
1793
1794 +---------------------+----------------------------------------------------------------------------------------------+
1795 | **IF Definition**   | **Description**                                                                              |
1796 +=====================+==============================================================================================+
1797 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid }   |
1798 +---------------------+----------------------------------------------------------------------------------------------+
1799 | Operation           | get                                                                                          |
1800 +---------------------+----------------------------------------------------------------------------------------------+
1801 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                        |
1802 +---------------------+----------------------------------------------------------------------------------------------+
1803
1804 8.4.1. **Request**
1805 >>>>>>>>>>>>>>>>>>
1806
1807 N/A
1808
1809 8.4.2. **Response**
1810 >>>>>>>>>>>>>>>>>>>
1811
1812 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1813 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1814 +=================+=================+===================+===============================+==============================================================================================================================+
1815 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
1816 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1817 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1818 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1819 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1820 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1821 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1822 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1823 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1824 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1825 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1826 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1827 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
1828 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1829 | isPublic        | M               | 1                 | boolean                       | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
1830 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1831 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1832 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1833 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
1834 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1835 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
1836 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1837 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
1838 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1839
1840 200: ok
1841
1842 500: failed
1843
1844 9. **Volume Management**
1845 ^^^^^^^^^^^^^^^^^^^^^^^^
1846
1847 9.1. **Create Volume**
1848 ----------------------
1849
1850 +---------------------+--------------------------------------------------------------------------------+
1851 | **IF Definition**   | **Description**                                                                |
1852 +=====================+================================================================================+
1853 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
1854 +---------------------+--------------------------------------------------------------------------------+
1855 | Operation           | POST                                                                           |
1856 +---------------------+--------------------------------------------------------------------------------+
1857 | Direction           | NSLCM->MULTIVIM                                                                |
1858 +---------------------+--------------------------------------------------------------------------------+
1859
1860 9.1.1. **Request**
1861 >>>>>>>>>>>>>>>>>>
1862
1863 +--------------------+-----------------+-------------------+---------------+-------------------+
1864 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1865 +====================+=================+===================+===============+===================+
1866 | name               | M               | 1                 | string        | Volume name       |
1867 +--------------------+-----------------+-------------------+---------------+-------------------+
1868 | volumeSize         | M               | 1                 | int           | Volume size       |
1869 +--------------------+-----------------+-------------------+---------------+-------------------+
1870 | imageId            | O               | 1                 | string        | Image UUID        |
1871 +--------------------+-----------------+-------------------+---------------+-------------------+
1872 | volumeType         | O               | 1                 | string        | Volume type       |
1873 +--------------------+-----------------+-------------------+---------------+-------------------+
1874 | availabilityZone   | O               | 1                 | string        | Usable field      |
1875 +--------------------+-----------------+-------------------+---------------+-------------------+
1876
1877 ::
1878
1879     {
1880
1881     "tenant": "tenant1",
1882
1883     "volumeName": "volume1",
1884
1885     "volumeSize": 3,
1886
1887     "imageName": "cirros.qcow2",
1888
1889     "volumeType": "volumetype1",
1890
1891     "availabilityZone": "zone1"
1892
1893     }
1894
1895 9.1.2. **Response**
1896 >>>>>>>>>>>>>>>>>>>
1897
1898 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1899 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
1900 +====================+=================+===================+===============+=====================================+
1901 | returnCode         | M               | 1                 | int           | 0: Already exist 1: Newly created   |
1902 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1903 | vimId              | M               | 1                 | String        | vim id                              |
1904 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1905 | vimName            | O               | 1                 | string        | vim name                            |
1906 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1907 | tenantId           | M               | 1                 | String        | Tenant UUID                         |
1908 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1909 | status             | M               | 1                 | string        | Volume status                       |
1910 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1911 | id                 | M               | 1                 | string        | Volume id                           |
1912 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1913 | name               | M               | 1                 | string        | Volume name                         |
1914 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1915 | volumeType         | O               | 1                 | string        | Volume type                         |
1916 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1917 | availabilityZone   | O               | 1                 | string        | Availability Zone                   |
1918 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1919
1920 202: accepted
1921
1922 500: failed
1923
1924 ::
1925
1926     {
1927
1928     "id": "bc9eebdbbfd356458269340b9ea6fb73",
1929
1930     "name": "volume1",
1931
1932     "returnCode": 1,
1933
1934     }
1935
1936 9.2. **Delete Volume**
1937 ----------------------
1938
1939 +---------------------+-------------------------------------------------------------------------------------------+
1940 | **IF Definition**   | **Description**                                                                           |
1941 +=====================+===========================================================================================+
1942 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId}   |
1943 +---------------------+-------------------------------------------------------------------------------------------+
1944 | Operation           | DELETE                                                                                    |
1945 +---------------------+-------------------------------------------------------------------------------------------+
1946 | Direction           | NSLCM->MULTIVIM                                                                           |
1947 +---------------------+-------------------------------------------------------------------------------------------+
1948
1949 9.2.1. **Request**
1950 >>>>>>>>>>>>>>>>>>
1951
1952     N/A
1953
1954 9.2.2. **Response**
1955 >>>>>>>>>>>>>>>>>>>
1956
1957     204: no content
1958
1959 9.3. **List Volumes**
1960 ---------------------
1961
1962 +---------------------+--------------------------------------------------------------------------------+
1963 | **IF Definition**   | **Description**                                                                |
1964 +=====================+================================================================================+
1965 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
1966 +---------------------+--------------------------------------------------------------------------------+
1967 | Operation           | GET                                                                            |
1968 +---------------------+--------------------------------------------------------------------------------+
1969 | Direction           | NSLCM-> MULTIVIM                                                               |
1970 +---------------------+--------------------------------------------------------------------------------+
1971
1972 9.3.1. **Request**
1973 >>>>>>>>>>>>>>>>>>
1974
1975     msb.onap.org:80/api/multicloud/v0/{cloud
1976     owner}\_{region}/volumes?{……}
1977
1978 +-----------------+-----------------+-------------------+---------------+-------------------+
1979 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1980 +=================+=================+===================+===============+===================+
1981 | name            | M               | 1                 | string        | Volume name       |
1982 +-----------------+-----------------+-------------------+---------------+-------------------+
1983
1984 9.3.2. **Response**
1985 >>>>>>>>>>>>>>>>>>>
1986
1987 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1988 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
1989 +====================+=================+===================+======================+====================================================+
1990 | vimId              | M               | 1                 | String               | vim id                                             |
1991 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1992 | vimName            | O               | 1                 | string               | vim name                                           |
1993 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1994 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
1995 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1996 | volumes            | M               | 1                 | Array                |                                                    |
1997 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1998 | id                 | M               | 1                 | string               | Volume id                                          |
1999 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2000 | name               | M               | 1                 | string               | Volume name                                        |
2001 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2002 | createTime         | O               | 1                 | string               | Create time                                        |
2003 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2004 | status             | M               | 1                 | string               | Volume status                                      |
2005 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2006 | volumeSize         | M               | 1                 | int                  | Volume size                                        |
2007 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2008 | volumeType         | M               | 1                 | string               | Volume type                                        |
2009 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2010 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2011 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2012 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2013 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2014
2015 200: ok
2016
2017 500: failed
2018
2019 ::
2020
2021     {
2022
2023         "volumes": [
2024
2025             {
2026
2027                 "status": "available",
2028
2029                 "name": "test",
2030
2031                 "attachments": [],
2032
2033                 "createTime": "2015-12-02T07:57:23.000000",
2034
2035                 " volumeType ": "ws",
2036
2037                 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2038
2039                 "size": 20
2040
2041             },
2042
2043             {
2044
2045                 "status": "in-use",
2046
2047                 "name": "wangsong",
2048
2049                 "attachments": [
2050
2051                     {
2052
2053                         "device": "/dev/vdc",
2054
2055                         "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2056
2057                         "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2058
2059                         "hostName": null,
2060
2061                         "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2062
2063                     }
2064
2065                 ],
2066
2067                 "createTime": "2015-12-02T06:39:40.000000",
2068
2069                 " volumeType ": null,
2070
2071                 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2072
2073                 "size": 40
2074
2075             }
2076
2077         ]
2078
2079     }
2080
2081 9.4. **Get Volumes**
2082 --------------------
2083
2084 +---------------------+-------------------------------------------------------------------------------------------+
2085 | **IF Definition**   | **Description**                                                                           |
2086 +=====================+===========================================================================================+
2087 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid}   |
2088 +---------------------+-------------------------------------------------------------------------------------------+
2089 | Operation           | GET                                                                                       |
2090 +---------------------+-------------------------------------------------------------------------------------------+
2091 | Direction           | NSLCM-> MULTIVIM                                                                          |
2092 +---------------------+-------------------------------------------------------------------------------------------+
2093
2094 9.4.1. **Request**
2095 >>>>>>>>>>>>>>>>>>
2096