2 This work is licensed under a Creative Commons Attribution 4.0
5 ================================
6 MultiCloud API Specification V1
7 ================================
12 `1. Scope 5 <#_Toc490851650>`__
14 `2. Terms, Definitions and Abbreviations 5 <#_Toc490851651>`__
16 `3. Image Management 5 <#_Toc490851652>`__
18 `3.1 Create Image 5 <#_Toc490851653>`__
20 `3.1.1 Request 5 <#_Toc490851654>`__
22 `3.1.2 Response 6 <#_Toc490851655>`__
24 `3.2 Delete Image 7 <#_Toc490851656>`__
26 `3.2.1 Request 7 <#_Toc490851657>`__
28 `3.2.2 Response 7 <#_Toc490851658>`__
30 `3.3 List Images 7 <#_Toc490851659>`__
32 `3.3.1 Request 7 <#_Toc490851660>`__
34 `3.3.2 Response 8 <#_Toc490851661>`__
36 `3.4 Get Image 9 <#_Toc490851662>`__
38 `3.4.1 Request 9 <#_Toc490851663>`__
40 `3.4.2 Response 9 <#_Toc490851664>`__
42 `4. Network Management 10 <#_Toc490851665>`__
44 `4.1 Create Network 10 <#_Toc490851666>`__
46 `4.1.1 Request 10 <#_Toc490851667>`__
48 `4.1.2 Response 11 <#_Toc490851668>`__
50 `4.2 Delete Network 12 <#_Toc490851669>`__
52 `4.2.1 Request 12 <#_Toc490851670>`__
54 `4.2.2 Response 12 <#_Toc490851671>`__
56 `4.3 List Network 12 <#_Toc490851672>`__
58 `4.3.1 Query 12 <#_Toc490851673>`__
60 `4.3.2 Response 13 <#_Toc490851674>`__
62 `4.4 Get Network 14 <#_Toc490851675>`__
64 `4.4.1 Request 14 <#_Toc490851676>`__
66 `4.4.2 Response 14 <#_Toc490851677>`__
68 `5. Subnetwork Management 16 <#_Toc490851678>`__
70 `5.1 Create Subnets 16 <#_Toc490851679>`__
72 `5.1.1 Request 16 <#_Toc490851680>`__
74 `5.1.2 Response 17 <#_Toc490851681>`__
76 `5.2 Delete Subnets 18 <#_Toc490851682>`__
78 `5.2.1 Request 18 <#_Toc490851683>`__
80 `5.2.2 Response 18 <#_Toc490851684>`__
82 `5.3 List Subnets 18 <#_Toc490851685>`__
84 `5.3.1 Query 18 <#_Toc490851686>`__
86 `5.3.2 Response 19 <#_Toc490851687>`__
88 `5.4 Get Subnets 20 <#_Toc490851688>`__
90 `5.4.1 Request 20 <#_Toc490851689>`__
92 `5.4.2 Response 20 <#_Toc490851690>`__
94 `6. Virtual Port 21 <#_Toc490851691>`__
96 `6.1 Create Virtual Port 21 <#_Toc490851692>`__
98 `6.1.1 Request 21 <#_Toc490851693>`__
100 `6.1.2 Response 22 <#_Toc490851694>`__
102 `6.2 Delete Virtual Port 22 <#_Toc490851695>`__
104 `6.2.1 Request 23 <#_Toc490851696>`__
106 `6.2.2 Response 23 <#_Toc490851697>`__
108 `6.3 List Virtual Port 23 <#_Toc490851698>`__
110 `6.3.1 Query 23 <#_Toc490851699>`__
112 `6.3.2 Response 23 <#_Toc490851700>`__
114 `6.4 Get Virtual Port 24 <#_Toc490851701>`__
116 `6.4.1 Request 24 <#_Toc490851702>`__
118 `6.4.2 Response 24 <#_Toc490851703>`__
120 `7. Server Management 25 <#_Toc490851704>`__
122 `7.1 Create Server 25 <#_Toc490851705>`__
124 `7.1.1 Request 25 <#_Toc490851706>`__
126 `7.1.2 Response 27 <#_Toc490851707>`__
128 `7.2 Delete Server 28 <#_Toc490851708>`__
130 `7.2.1 Request 28 <#_Toc490851709>`__
132 `7.2.2 Response 28 <#_Toc490851710>`__
134 `7.3 List Server 28 <#_Toc490851711>`__
136 `7.3.1 Request 28 <#_Toc490851712>`__
138 `7.3.2 Response 29 <#_Toc490851713>`__
140 `7.4 Get Server 29 <#_Toc490851714>`__
142 `7.4.1 Request 30 <#_Toc490851715>`__
144 `7.4.2 Response 30 <#_Toc490851716>`__
146 `8. Flavor Management 30 <#_Toc490851717>`__
148 `8.1 Create Flavor 31 <#_Toc490851718>`__
150 `8.1.1 Request 31 <#_Toc490851719>`__
152 `8.1.2 Response 31 <#_Toc490851720>`__
154 `8.2 Delete Flavor 32 <#_Toc490851721>`__
156 `8.2.1 Request 32 <#_Toc490851722>`__
158 `8.2.2 Response 32 <#_Toc490851723>`__
160 `8.3 List Flavor 32 <#_Toc490851724>`__
162 `8.3.1 Query 32 <#_Toc490851725>`__
164 `8.3.2 Response 32 <#_Toc490851726>`__
166 `8.4 Get Flavor 33 <#_Toc490851727>`__
168 `8.4.1 Request 33 <#_Toc490851728>`__
170 `8.4.2 Response 33 <#_Toc490851729>`__
172 `9. Volume Management 34 <#_Toc490851730>`__
174 `9.1 Create Volume 34 <#_Toc490851731>`__
176 `9.1.1 Request 34 <#_Toc490851732>`__
178 `9.1.2 Response 34 <#_Toc490851733>`__
180 `9.2 Delete Volume 35 <#_Toc490851734>`__
182 `9.2.1 Request 35 <#_Toc490851735>`__
184 `9.2.2 Response 35 <#_Toc490851736>`__
186 `9.3 List Volumes 35 <#_Toc490851737>`__
188 `9.3.1 Request 35 <#_Toc490851738>`__
190 `9.3.2 Response 36 <#_Toc490851739>`__
192 `9.4 Get Volumes 37 <#_Toc490851740>`__
194 `9.4.1 Request 37 <#_Toc490851741>`__
196 `9.4.2 Response 37 <#_Toc490851742>`__
198 `10. Tenant Management 38 <#_Toc490851743>`__
200 `10.1 List tenants 38 <#_Toc490851744>`__
202 `10.1.1 Query 38 <#_Toc490851745>`__
204 `10.1.2 Response 38 <#_Toc490851746>`__
206 `11. Limits 39 <#_Toc490851747>`__
208 `11.1 List Limits of resouces: CPU&Memory, volume,network,etc
209 39 <#_Toc490851748>`__
211 `11.1.1 Request 39 <#_Toc490851749>`__
213 `11.1.2 Response 39 <#_Toc490851750>`__
215 `12. Host Management 41 <#_Toc490851751>`__
217 `12.1 List hosts 41 <#_Toc490851752>`__
219 `12.1.1 Request 41 <#_Toc490851753>`__
221 `12.1.2 Response 41 <#_Toc490851754>`__
223 `12.2 Get host 43 <#_Toc490851755>`__
225 `12.2.1 Request 43 <#_Toc490851756>`__
227 `12.2.2 Response 43 <#_Toc490851757>`__
229 `13. VIM Management 45 <#_Toc490851758>`__
231 `13.1 Update VIM Info 45 <#_Toc490851759>`__
233 `13.1.1 Request 45 <#_Toc490851760>`__
235 `13.1.2 Response 45 <#_Toc490851761>`__
237 `13.2 Unregistry VIM 45 <#_Toc490851762>`__
239 `13.2.1 Request 45 <#_Toc490851763>`__
241 `13.2.2 Response 46 <#_Toc490851764>`__
248 The scope of the present document is to describe the VIM Driver API
251 1. \ **Terms, Definitions and Abbreviations**
253 For the purposes of the present document, the following abbreviations
256 +--------------------+-------------------------------------------------------------+
257 | **Abbreviation** | |
258 +====================+=============================================================+
259 | NFVO | Network Functions Virtualization Orchestrator |
260 +--------------------+-------------------------------------------------------------+
261 | VNFM | Virtual Network Function Management |
262 +--------------------+-------------------------------------------------------------+
263 | VIM | Virtualized Infrastructure Manager |
264 +--------------------+-------------------------------------------------------------+
265 | MultiVIM | MultVIM driver services for OPEN-O to drive VIM instances |
266 +--------------------+-------------------------------------------------------------+
268 Table 2-1 abbreviations
270 1. \ **Image Management**
272 1. \ **Create Image**
274 +---------------------+-------------------------------------------------------------------------------+
275 | **IF Definition** | **Description** |
276 +=====================+===============================================================================+
277 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images |
278 +---------------------+-------------------------------------------------------------------------------+
280 +---------------------+-------------------------------------------------------------------------------+
281 | Direction | NSLCM->MULTIVIM |
282 +---------------------+-------------------------------------------------------------------------------+
283 | Description | Create Image and Upload the image file to the VIM |
284 +---------------------+-------------------------------------------------------------------------------+
288 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
289 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
290 +===================+=================+===================+===========================+==================================================================================================+
291 | name | M | 1 | String | Image Name |
292 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
293 | imagePath | M | 1 | String | Image Local Path from catalog |
294 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
295 | imageType | M | 1 | String | Image Type |
297 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
298 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
299 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
300 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
301 | visibility | O | 1 | string | Visibility for this image. |
303 | | | | | public, private, shared, or community |
304 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
305 | properties | O | 0..N | List of key-value pairs | Examples:--property vmware\_disktype=streamOptimized --property vmware\_adaptertype="lsiLogic" |
306 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
310 "imageName": "cirros",
312 "imagePath": "/home/cirros.qcow2",
316 “containerFormat”:”bare”
322 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
323 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
324 +===================+=================+===================+===========================+========================================================+
325 | id | M | 1 | String | Image UUID in the VIM |
326 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
327 | name | M | 1 | String | Image Name |
328 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
329 | returnCode | M | 1 | Int | 0: Already exist 1: Newly created |
330 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
331 | imageType | M | 1 | String | Image Type |
333 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
334 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
335 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
336 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
337 | visibility | O | 1 | string | Visibility for this image. |
339 | | | | | public, private, shared, or community |
340 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
341 | properties | O | 0..N | List of key-value pairs | |
342 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
343 | vimid | M | 1 | String | vim id |
344 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
345 | vimName | O | 1 | string | vim name |
346 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
347 | tenantId | M | 1 | String | Tenant UUID |
348 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
356 “id”:” 3c9eebdbbfd345658269340b9ea6fb73”,
364 1. \ **Delete Image**
366 +---------------------+-----------------------------------------------------------------------------------------+
367 | **IF Definition** | **Description** |
368 +=====================+=========================================================================================+
369 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageId} |
370 +---------------------+-----------------------------------------------------------------------------------------+
371 | Operation | Delete |
372 +---------------------+-----------------------------------------------------------------------------------------+
373 | Direction | NSLCM->MULTIVIM |
374 +---------------------+-----------------------------------------------------------------------------------------+
375 | Description | Delete Image |
376 +---------------------+-----------------------------------------------------------------------------------------+
388 +---------------------+-------------------------------------------------------------------------------+
389 | **IF Definition** | **Description** |
390 +=====================+===============================================================================+
391 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images |
392 +---------------------+-------------------------------------------------------------------------------+
394 +---------------------+-------------------------------------------------------------------------------+
395 | Direction | NSLCM->MULTIVIM |
396 +---------------------+-------------------------------------------------------------------------------+
397 | Description | Query Image list |
398 +---------------------+-------------------------------------------------------------------------------+
402 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……}
404 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
405 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
406 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
407 | 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. |
408 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
409 | 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. |
410 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
411 | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of an image |
412 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
416 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
417 | \ **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
418 +=================================================+=================+===================+===============+========================================================+
419 | images | M | 0..N | List | Image List |
420 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
421 | id | M | 1 | String | Image ID |
422 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
423 | size | M | 1 | int | Image Size |
424 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
425 | name | M | 1 | String | Image Name |
426 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
427 | status | M | 1 | String | Image Status |
428 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
429 | imageType | M | 1 | String | Image Type |
431 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
432 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
433 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
434 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
435 | visibility | O | 1 | string | Visibility for this image. |
437 | | | | | public, private, shared, or community |
438 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
439 | vimId | M | 1 | String | vim id |
440 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
441 | vimName | O | 1 | string | vim name |
442 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
443 | tenantId | M | 1 | String | Tenant UUID |
444 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
447 | 500: failed | | | | |
451 | “vimid”:”” | | | | |
453 | “vimname”:”” | | | | |
455 | "imageList": [ | | | | |
456 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
458 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
459 | "status": "active", | | | | |
460 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
461 | "id": "5e2757c1-f846-4727-915c-9a872553ed75", | | | | |
462 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
463 | "size": 862016, | | | | |
464 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
465 | "name": "vim-plus-cgsl40g-z.qcow2" | | | | |
466 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
468 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
472 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
476 +---------------------+-----------------------------------------------------------------------------------------+
477 | **IF Definition** | **Description** |
478 +=====================+=========================================================================================+
479 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid} |
480 +---------------------+-----------------------------------------------------------------------------------------+
482 +---------------------+-----------------------------------------------------------------------------------------+
483 | Direction | NSLCM->MULTIVIM |
484 +---------------------+-----------------------------------------------------------------------------------------+
485 | Description | Query Image Information |
486 +---------------------+-----------------------------------------------------------------------------------------+
494 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
495 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
496 +===================+=================+===================+===============+========================================================+
497 | id | M | 1 | String | Image ID |
498 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
499 | size | M | 1 | int | Image Size |
500 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
501 | name | M | 1 | String | Image Name |
502 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
503 | status | M | 1 | String | Image Status |
504 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
505 | imageType | M | 1 | String | Image Type |
507 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
508 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
509 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
510 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
511 | visibility | O | 1 | string | Visibility for this image. |
513 | | | | | public, private, shared, or community |
514 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
515 | vimId | M | 1 | String | vim id |
516 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
517 | vimName | M | 1 | string | vim name |
518 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
519 | tenantId | M | 1 | String | Tenant UUID |
520 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
534 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
538 "name": "vim-plus-cgsl40g-z.qcow2"
542 1. \ **Network Management**
544 1. \ **Create Network**
546 +---------------------+---------------------------------------------------------------------------------+
547 | **IF Definition** | **Description** |
548 +=====================+=================================================================================+
549 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
550 +---------------------+---------------------------------------------------------------------------------+
552 +---------------------+---------------------------------------------------------------------------------+
553 | Direction | VNFLCM,NSLCM->MULTIVIM |
554 +---------------------+---------------------------------------------------------------------------------+
555 | Description | Create network and subnetwork on the VIM |
556 +---------------------+---------------------------------------------------------------------------------+
560 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
561 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
562 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
563 | name | M | 1 | String | Logical network name |
564 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
565 | shared | M | 1 | boolean | Whether to share(1:sharing;0:private) |
566 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
567 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
568 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
569 | networkType | O | 1 | String | Network type |
571 | | | | | flat, vlan, vxlan, gre, |
573 | | | | | portgroup |
574 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
575 | segmentationId | O | 1 | Int | id of paragraph |
576 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
577 | 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. |
578 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
579 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
580 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
582 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
583 | “tenant”: “tenant1”, | | | | |
584 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
585 | “networkName”: “ommnet”, | | | | |
586 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
587 | “shared”: 1, | | | | |
588 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
589 | “vlanTransparent”: 1, | | | | |
590 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
591 | “networkType”:”vlan”, | | | | |
592 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
593 | “segmentationId”:202, | | | | |
594 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
595 | “physicalNetwork”:”ctrl”, | | | | |
597 | “routerExternal”:0 | | | | |
598 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
600 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
604 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
605 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
606 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
607 | status | M | 1 | string | Network status |
608 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
609 | id | M | 1 | string | Network id |
610 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
611 | name | M | 1 | string | Network name |
612 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
613 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
614 | tenantId | M | 1 | String | Tenant UUID |
615 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
616 | segmentationId | O | 1 | int | Segmentation id |
617 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
618 | networkType | O | 1 | string | Network type |
619 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
620 | 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. |
621 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
622 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
623 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
624 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
625 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
626 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
627 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
628 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
629 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
630 | vimId | M | 1 | String | vim id |
631 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
632 | vimName | O | 1 | string | vim name |
633 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
649 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
655 “networkName”: “ommnet”,
659 “vlanTransparent”: 1,
661 “networkType”:”vlan”,
663 “segmentationId”:202,
665 “physicalNetwork ”:”ctrl”,
671 1. \ **Delete Network**
673 +---------------------+---------------------------------------------------------------------------------------------+
674 | **IF Definition** | **Description** |
675 +=====================+=============================================================================================+
676 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
677 +---------------------+---------------------------------------------------------------------------------------------+
678 | Operation | Delete |
679 +---------------------+---------------------------------------------------------------------------------------------+
680 | Direction | NFLCM,NSLCM->MULTIVIM |
681 +---------------------+---------------------------------------------------------------------------------------------+
691 1. \ **List Network**
693 +---------------------+---------------------------------------------------------------------------------+
694 | **IF Definition** | **Description** |
695 +=====================+=================================================================================+
696 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
697 +---------------------+---------------------------------------------------------------------------------+
699 +---------------------+---------------------------------------------------------------------------------+
700 | Direction | NFLCM,NSLCM->MULTIVIM |
701 +---------------------+---------------------------------------------------------------------------------+
705 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
706 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
707 +=================+=================+===================+===============+=======================================================================================+
708 | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of a network |
709 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
713 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
714 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
715 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
716 | vimId | M | 1 | String | vim id |
717 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
718 | vimName | O | 1 | string | vim name |
719 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
720 | networks | | 0..N | List | Network list |
721 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
722 | status | M | 1 | string | Network status |
723 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
724 | id | M | 1 | string | Network id |
725 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
726 | name | M | 1 | string | Network name |
727 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
728 | tenantId | M | 1 | String | Tenant UUID |
729 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
730 | segmentationId | O | 1 | int | Segmentation id |
731 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
732 | networkType | O | 1 | string | Network type |
733 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
734 | 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. |
735 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
736 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
737 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
738 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
739 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
740 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
741 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
759 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
765 “networkName”: “ommnet”,
769 “vlanTransparent”: 1,
771 “networkType”:”vlan”,
773 “segmentationId”:202,
775 “physicalNetwork ”:”ctrl”,
787 +---------------------+---------------------------------------------------------------------------------------------+
788 | **IF Definition** | **Description** |
789 +=====================+=============================================================================================+
790 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
791 +---------------------+---------------------------------------------------------------------------------------------+
793 +---------------------+---------------------------------------------------------------------------------------------+
794 | Direction | NFLCM,NSLCM->MULTIVIM |
795 +---------------------+---------------------------------------------------------------------------------------------+
803 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
804 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
805 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
806 | status | M | 1 | string | Network status |
807 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
808 | id | M | 1 | string | Network id |
809 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
810 | name | M | 1 | string | Network name |
811 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
812 | tenantId | M | 1 | String | Tenant UUID |
813 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
814 | segmentationId | O | 1 | int | Segmentation id |
815 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
816 | networkType | O | 1 | string | Network type |
817 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
818 | 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. |
819 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
820 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
821 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
822 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
823 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
824 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
825 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
826 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
827 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
828 | vimId | M | 1 | String | vim id |
829 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
830 | vimName | O | 1 | string | vim name |
831 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
845 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
851 “networkName”: “ommnet”,
855 “vlanTransparent”: 1,
857 “networkType”:”vlan”,
859 “segmentationId”:202,
861 “physicalNetwork ”:”ctrl”,
867 1. \ **Subnetwork Management**
869 1. \ **Create Subnets**
871 +---------------------+--------------------------------------------------------------------------------+
872 | **IF Definition** | **Description** |
873 +=====================+================================================================================+
874 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
875 +---------------------+--------------------------------------------------------------------------------+
877 +---------------------+--------------------------------------------------------------------------------+
878 | Direction | VNFLCM,NSLCM->MULTIVIM |
879 +---------------------+--------------------------------------------------------------------------------+
880 | Description | Create network and subnetwork on the VIM |
881 +---------------------+--------------------------------------------------------------------------------+
885 +-------------------+-----------------+-------------------+------------------------+----------------------+
886 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
887 +===================+=================+===================+========================+======================+
888 | networkId | M | 1 | String | Network Id |
889 +-------------------+-----------------+-------------------+------------------------+----------------------+
890 | name | M | 1 | String | SubnetName |
891 +-------------------+-----------------+-------------------+------------------------+----------------------+
892 | cidr | M | 1 | String | Subnet cidr |
893 +-------------------+-----------------+-------------------+------------------------+----------------------+
894 | ipVersion | M | 1 | Int | Ip type |
897 +-------------------+-----------------+-------------------+------------------------+----------------------+
898 | enableDhcp | O | 1 | boolean | Whether to allow |
900 | | | | | 1: yes;0: no |
901 +-------------------+-----------------+-------------------+------------------------+----------------------+
902 | gatewayIp | O | 1 | String | Gateway ip |
903 +-------------------+-----------------+-------------------+------------------------+----------------------+
904 | dnsNameservers | O | 1..n | List of servers | List of servers |
905 +-------------------+-----------------+-------------------+------------------------+----------------------+
906 | hostRoutes | O | 1..n | List of routes | List of routes |
907 +-------------------+-----------------+-------------------+------------------------+----------------------+
908 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
909 +-------------------+-----------------+-------------------+------------------------+----------------------+
910 | -->allocation | | | | |
911 +-------------------+-----------------+-------------------+------------------------+----------------------+
912 | -->start | O | 1 | String | Start ip |
913 +-------------------+-----------------+-------------------+------------------------+----------------------+
914 | -->end | O | 1 | String | End ip |
915 +-------------------+-----------------+-------------------+------------------------+----------------------+
921 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
923 “subnetName”: “subnet1”,
925 “cidr”: “10.43.35.0/24”,
931 “gatewayIp”: “10.43.35.1”,
933 “dnsNameservers”: [],
937 “start”: “192.168.199.2”,
939 “end”: “192.168.199.254”
949 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
950 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
951 +===================+=================+===================+========================+=====================================+
952 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
953 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
954 | vimId | M | 1 | String | vim id |
955 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
956 | vimName | O | 1 | string | vim name |
957 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
958 | status | M | 1 | string | subnetwork status |
959 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
960 | id | M | 1 | string | subNetwork id |
961 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
962 | tenantId | M | 1 | String | Tenant UUID |
963 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
964 | networkId | O | 1 | String | Network Id |
965 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
966 | networkName | O | 1 | String | Network Name |
967 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
968 | name | M | 1 | String | SubnetName |
969 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
970 | cidr | M | 1 | String | Subnet cidr |
971 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
972 | ipVersion | M | 1 | Int | Ip type |
975 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
976 | enableDhcp | O | 1 | boolean | Whether to allow |
978 | | | | | 1: yes;0: no |
979 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
980 | gatewayIp | O | 1 | String | Gateway ip |
981 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
982 | dnsNameservers | O | 1..n | List of servers | List of servers |
983 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
984 | hostRoutes | O | 1..n | List of routes | List of routes |
985 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
986 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
987 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
988 | -->allocation | | | | |
989 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
990 | -->start | O | 1 | String | Start ip |
991 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
992 | -->end | O | 1 | String | End ip |
993 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
1009 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1011 “tenant”: “tenant1”,
1013 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1017 “cidr”: “10.43.35.0/24”,
1023 “gatewayIp”: “10.43.35.1”,
1025 “dnsNameservers”: [],
1027 “allocationPools”:[{
1029 “start”: “192.168.199.2”,
1031 “end”: “192.168.199.254”
1039 1. \ **Delete Subnets**
1041 +---------------------+-------------------------------------------------------------------------------------------+
1042 | **IF Definition** | **Description** |
1043 +=====================+===========================================================================================+
1044 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId} |
1045 +---------------------+-------------------------------------------------------------------------------------------+
1046 | Operation | Delete |
1047 +---------------------+-------------------------------------------------------------------------------------------+
1048 | Direction | NFLCM,NSLCM->MULTIVIM |
1049 +---------------------+-------------------------------------------------------------------------------------------+
1059 1. \ **List Subnets**
1061 +---------------------+--------------------------------------------------------------------------------+
1062 | **IF Definition** | **Description** |
1063 +=====================+================================================================================+
1064 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
1065 +---------------------+--------------------------------------------------------------------------------+
1067 +---------------------+--------------------------------------------------------------------------------+
1068 | Direction | NFLCM,NSLCM->MULTIVIM |
1069 +---------------------+--------------------------------------------------------------------------------+
1073 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
1075 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1076 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1077 +=================+=================+===================+===============+================================================================================================+
1078 | name | O | 1 | String | Filters fields of the response by a name, as a string. A valid value is the name of a subnet |
1079 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1083 +-------------------+-----------------+-------------------+------------------------+----------------------+
1084 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1085 +===================+=================+===================+========================+======================+
1086 | vimId | M | 1 | String | vim id |
1087 +-------------------+-----------------+-------------------+------------------------+----------------------+
1088 | vimName | O | 1 | string | vim name |
1089 +-------------------+-----------------+-------------------+------------------------+----------------------+
1090 | subnets | M | 0..N | List | Network list |
1091 +-------------------+-----------------+-------------------+------------------------+----------------------+
1092 | status | | 1 | string | subnetwork status |
1093 +-------------------+-----------------+-------------------+------------------------+----------------------+
1094 | id | | 1 | string | subNetwork id |
1095 +-------------------+-----------------+-------------------+------------------------+----------------------+
1096 | tenantId | M | 1 | String | Tenant UUID |
1097 +-------------------+-----------------+-------------------+------------------------+----------------------+
1098 | networkId | O | 1 | String | Network Id |
1099 +-------------------+-----------------+-------------------+------------------------+----------------------+
1100 | networkName | O | 1 | String | Network Name |
1101 +-------------------+-----------------+-------------------+------------------------+----------------------+
1102 | name | M | 1 | String | SubnetName |
1103 +-------------------+-----------------+-------------------+------------------------+----------------------+
1104 | cidr | M | 1 | String | Subnet cidr |
1105 +-------------------+-----------------+-------------------+------------------------+----------------------+
1106 | ipVersion | M | 1 | Int | Ip type |
1109 +-------------------+-----------------+-------------------+------------------------+----------------------+
1110 | enableDhcp | O | 1 | boolean | Whether to allow |
1112 | | | | | 1: yes;0: no |
1113 +-------------------+-----------------+-------------------+------------------------+----------------------+
1114 | gatewayIp | O | 1 | String | Gateway ip |
1115 +-------------------+-----------------+-------------------+------------------------+----------------------+
1116 | dnsNameservers | O | 1..n | List of servers | List of servers |
1117 +-------------------+-----------------+-------------------+------------------------+----------------------+
1118 | hostRoutes | O | 1..n | List of routes | List of routes |
1119 +-------------------+-----------------+-------------------+------------------------+----------------------+
1120 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
1121 +-------------------+-----------------+-------------------+------------------------+----------------------+
1122 | -->allocation | | | | |
1123 +-------------------+-----------------+-------------------+------------------------+----------------------+
1124 | -->start | O | 1 | String | Start ip |
1125 +-------------------+-----------------+-------------------+------------------------+----------------------+
1126 | -->end | O | 1 | String | End ip |
1127 +-------------------+-----------------+-------------------+------------------------+----------------------+
1145 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1147 “tenant”: “tenant1”,
1149 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1153 “cidr”: “10.43.35.0/24”,
1159 “gatewayIp”: “10.43.35.1”,
1161 “dnsNameservers”: [],
1163 “allocationPools”:[{
1165 “start”: “192.168.199.2”,
1167 “end”: “192.168.199.254”
1179 1. \ **Get Subnets**
1181 +---------------------+-------------------------------------------------------------------------------------------+
1182 | **IF Definition** | **Description** |
1183 +=====================+===========================================================================================+
1184 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid} |
1185 +---------------------+-------------------------------------------------------------------------------------------+
1187 +---------------------+-------------------------------------------------------------------------------------------+
1188 | Direction | NFLCM,NSLCM->MULTIVIM |
1189 +---------------------+-------------------------------------------------------------------------------------------+
1197 +-------------------+-----------------+-------------------+------------------------+----------------------+
1198 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1199 +===================+=================+===================+========================+======================+
1200 | vimId | M | 1 | String | vim id |
1201 +-------------------+-----------------+-------------------+------------------------+----------------------+
1202 | vimName | O | 1 | string | vim name |
1203 +-------------------+-----------------+-------------------+------------------------+----------------------+
1204 | status | | 1 | string | subnetwork status |
1205 +-------------------+-----------------+-------------------+------------------------+----------------------+
1206 | id | | 1 | string | subNetwork id |
1207 +-------------------+-----------------+-------------------+------------------------+----------------------+
1208 | tenantId | M | 1 | String | Tenant UUID |
1209 +-------------------+-----------------+-------------------+------------------------+----------------------+
1210 | networkId | O | 1 | String | Network Id |
1211 +-------------------+-----------------+-------------------+------------------------+----------------------+
1212 | networkName | O | 1 | String | Network Name |
1213 +-------------------+-----------------+-------------------+------------------------+----------------------+
1214 | name | M | 1 | String | SubnetName |
1215 +-------------------+-----------------+-------------------+------------------------+----------------------+
1216 | cidr | M | 1 | String | Subnet cidr |
1217 +-------------------+-----------------+-------------------+------------------------+----------------------+
1218 | ipVersion | M | 1 | Int | Ip type |
1221 +-------------------+-----------------+-------------------+------------------------+----------------------+
1222 | enableDhcp | O | 1 | boolean | Whether to allow |
1224 | | | | | 1: yes;0: no |
1225 +-------------------+-----------------+-------------------+------------------------+----------------------+
1226 | gatewayIp | O | 1 | String | Gateway ip |
1227 +-------------------+-----------------+-------------------+------------------------+----------------------+
1228 | dnsNameservers | O | 1..n | List of servers | List of servers |
1229 +-------------------+-----------------+-------------------+------------------------+----------------------+
1230 | hostRoutes | O | 1..n | List of routes | List of routes |
1231 +-------------------+-----------------+-------------------+------------------------+----------------------+
1232 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
1233 +-------------------+-----------------+-------------------+------------------------+----------------------+
1234 | -->allocation | | | | |
1235 +-------------------+-----------------+-------------------+------------------------+----------------------+
1236 | -->start | O | 1 | String | Start ip |
1237 +-------------------+-----------------+-------------------+------------------------+----------------------+
1238 | -->end | O | 1 | String | End ip |
1239 +-------------------+-----------------+-------------------+------------------------+----------------------+
1249 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1251 “tenant”: “tenant1”,
1253 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1257 “cidr”: “10.43.35.0/24”,
1263 “gatewayIp”: “10.43.35.1”,
1265 “dnsNameservers”: [],
1267 “allocationPools”:[{
1269 “start”: “192.168.199.2”,
1271 “end”: “192.168.199.254”
1279 1. \ **Virtual Port**
1281 1. \ **Create Virtual Port**
1283 +---------------------+------------------------------------------------------------------------------+
1284 | **IF Definition** | **Description** |
1285 +=====================+==============================================================================+
1286 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports |
1287 +---------------------+------------------------------------------------------------------------------+
1288 | Operation | POST |
1289 +---------------------+------------------------------------------------------------------------------+
1290 | Direction | VNFLCM->MULTIVIM |
1291 +---------------------+------------------------------------------------------------------------------+
1295 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1296 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1297 +========================+=================+===================+===============+=======================================================+
1298 | networkId | M | 1 | string | Network UUID |
1299 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1300 | subnetId | O | 1 | string | Subnet UUID |
1301 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1302 | name | M | 1 | string | Port name |
1303 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1304 | macAddress | O | 1 | string | Mac address |
1305 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1306 | ip | O | 1 | string | Ip address |
1307 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1308 | vnicType | O | 1 | string | Virtual network card type, |
1310 | | | | | the value of three kinds of normal/direct/macvtap |
1311 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1312 | \ **securityGroups** | **O** | **1** | **string** | **The IDs of security groups applied to the port.** |
1313 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1317 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1318 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1319 +======================+=================+===================+===============+=====================================================+
1320 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1321 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1322 | vimId | M | 1 | String | vim id |
1323 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1324 | vimName | O | 1 | string | vim name |
1325 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1326 | status | M | 1 | string | status |
1327 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1328 | id | M | 1 | string | Port Id |
1329 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1330 | name | M | 1 | string | Port name |
1331 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1332 | tenantId | M | 1 | String | Tenant UUID |
1333 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1334 | networkName | M | 1 | string | Network name |
1335 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1336 | networkId | M | 1 | string | Network Id |
1337 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1338 | subnetName | M | 1 | string | Subnet name |
1339 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1340 | subnetId | M | 1 | string | SubnetId |
1341 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1342 | macAddress | O | 1 | string | Mac address |
1343 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1344 | ip | O | 1 | string | Ip address |
1345 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1346 | vnicType | O | 1 | string | Virtual network card type, |
1348 | | | | | the value of three kinds of normal/direct/macvtap |
1349 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1350 | **securityGroups** | **O** | **1** | **string** | **List of security group names.** |
1351 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1353 1. \ **Delete Virtual Port**
1355 +---------------------+---------------------------------------------------------------------------------------+
1356 | **IF Definition** | **Description** |
1357 +=====================+=======================================================================================+
1358 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1359 +---------------------+---------------------------------------------------------------------------------------+
1360 | Operation | DELETTE |
1361 +---------------------+---------------------------------------------------------------------------------------+
1362 | Direction | VNFLCM->MULTIVIM |
1363 +---------------------+---------------------------------------------------------------------------------------+
1373 1. \ **List Virtual Port**
1375 +---------------------+-----------------------------------------------------------------------------+
1376 | **IF Definition** | **Description** |
1377 +=====================+=============================================================================+
1378 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports |
1379 +---------------------+-----------------------------------------------------------------------------+
1381 +---------------------+-----------------------------------------------------------------------------+
1382 | Direction | VNFLCM->MULTIVIM |
1383 +---------------------+-----------------------------------------------------------------------------+
1387 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1388 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1389 +=================+=================+===================+===============+=================================================+
1390 | name | M | 1 | string | Port name to filter out list of virtual ports |
1391 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1395 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1396 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1397 +===================+=================+===================+===============+=====================================================+
1398 | vimId | M | 1 | String | vim id |
1399 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1400 | vimName | O | 1 | string | vim name |
1401 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1402 | tenantId | M | 1 | String | Tenant UUID |
1403 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1404 | Ports | M | 0..N | List | ports |
1405 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1406 | id | M | 1 | string | Port Id |
1407 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1408 | name | M | 1 | string | Port name |
1409 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1410 | status | M | 1 | string | status |
1411 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1412 | **networkName** | O | 1 | string | Network name |
1413 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1414 | networkId | M | 1 | string | Network Id |
1415 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1416 | subnetName | O | 1 | string | Subnet name |
1417 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1418 | subnetId | M | 1 | string | SubnetId |
1419 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1420 | macAddress | O | 1 | string | Mac address |
1421 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1422 | ip | O | 1 | string | Ip address |
1423 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1424 | vnicType | O | 1 | string | Virtual network card type, |
1426 | | | | | the value of three kinds of normal/direct/macvtap |
1427 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1428 | securityGroups | O | 1 | string | List of security group names. |
1429 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1439 1. \ **Get Virtual Port**
1441 +---------------------+---------------------------------------------------------------------------------------+
1442 | **IF Definition** | **Description** |
1443 +=====================+=======================================================================================+
1444 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1445 +---------------------+---------------------------------------------------------------------------------------+
1447 +---------------------+---------------------------------------------------------------------------------------+
1448 | Direction | VNFLCM->MULTIVIM |
1449 +---------------------+---------------------------------------------------------------------------------------+
1457 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1458 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1459 +==================+=================+===================+===============+=====================================================+
1460 | vimId | M | 1 | String | vim id |
1461 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1462 | vimName | O | 1 | string | vim name |
1463 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1464 | status | M | 1 | string | status |
1465 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1466 | id | M | 1 | string | Port Id |
1467 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1468 | name | M | 1 | string | Port name |
1469 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1470 | tenantId | M | 1 | String | Tenant UUID |
1471 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1472 | networkName | M | 1 | string | Network name |
1473 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1474 | networkId | M | 1 | string | Network Id |
1475 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1476 | subnetName | M | 1 | string | Subnet name |
1477 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1478 | subnetId | M | 1 | string | SubnetId |
1479 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1480 | macAddress | O | 1 | string | Mac address |
1481 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1482 | ip | O | 1 | string | Ip address |
1483 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1484 | vnicType | O | 1 | string | Virtual network card type, |
1486 | | | | | the value of three kinds of normal/direct/macvtap |
1487 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1488 | securityGroups | O | 1 | string | **List of security group names.** |
1489 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1499 1. \ **Server Management**
1501 1. \ **Create Server**
1503 +---------------------+--------------------------------------------------------------------------------+
1504 | **IF Definition** | **Description** |
1505 +=====================+================================================================================+
1506 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1507 +---------------------+--------------------------------------------------------------------------------+
1508 | Operation | POST |
1509 +---------------------+--------------------------------------------------------------------------------+
1510 | Direction | VNFLCM->MULTIVIM |
1511 +---------------------+--------------------------------------------------------------------------------+
1515 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1516 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1517 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1518 | name | M | 1 | string | server name |
1519 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1520 | boot | M | 1 | String | Start parameters |
1521 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1522 | nicArray | O | 1..n | List of nic | List of nic |
1523 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1524 | contextArray | O | 1..n | list of context | list of context |
1525 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1526 | volumeArray | O | 1..n | list of volume | list of volume |
1527 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1528 | availabilityZone | O | 1 | string | Usable field |
1529 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1530 | flavorId | M | 1 | String | server Flavor id |
1531 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1532 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1533 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1534 | userdata | O | 1 | string | Configuration information or scripts to use upon launch. Must be Base64 encoded. |
1536 | | | | | 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. |
1537 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1538 | **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.** |
1539 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1540 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1541 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1545 +-----------------+-----------------+-------------------+---------------+---------------------------+
1546 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1547 +=================+=================+===================+===============+===========================+
1548 | type | M | 1 | int | Startup mode |
1550 | | | | | 1. boot from the volume |
1552 | | | | | 2. boot from image |
1553 +-----------------+-----------------+-------------------+---------------+---------------------------+
1554 | volumeId | O | 1 | string | Volume Id(type=1) |
1555 +-----------------+-----------------+-------------------+---------------+---------------------------+
1556 | imageId | O | 1 | String | ImageId(type=2) |
1557 +-----------------+-----------------+-------------------+---------------+---------------------------+
1561 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1562 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1563 +=================+=================+===================+===============+===========================================================================================================================================================+
1564 | fileName | M | 1 | String | Injection file name |
1565 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1566 | 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. ) |
1567 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1571 +-----------------+-----------------+-------------------+---------------+-------------------+
1572 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1573 +=================+=================+===================+===============+===================+
1574 | volumeId | M | 1 | String | Volume Id |
1575 +-----------------+-----------------+-------------------+---------------+-------------------+
1579 +-----------------+-----------------+-------------------+---------------+-------------------+
1580 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1581 +=================+=================+===================+===============+===================+
1582 | portId | M | 1 | String | Port Id |
1583 +-----------------+-----------------+-------------------+---------------+-------------------+
1587 +-----------------+-----------------+-------------------+---------------+-------------------+
1588 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1589 +=================+=================+===================+===============+===================+
1590 | keyName | M | 1 | String | Key name |
1591 +-----------------+-----------------+-------------------+---------------+-------------------+
1592 | value | M | 1 | string | value |
1593 +-----------------+-----------------+-------------------+---------------+-------------------+
1597 "tenant": "tenant1",
1601 “availabilityZone”:”az1”,
1603 “flavorName”:”vm\_large”,
1609 " volumeName": "volume1"
1613 “flavorId”:”vm\_large\_134213”
1617 "fileName": "test.yaml",
1625 "volumeName": "vol1",
1639 "value": "foo value”
1643 “userdata”:”abcdedf”
1649 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1650 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1651 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1652 | vimId | M | 1 | String | vim id |
1653 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1654 | vimName | O | 1 | string | vim name |
1655 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1656 | returnCode | | 1 | int | 0: Already exist 1: Newly created |
1657 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1658 | id | M | 1 | string | server id |
1659 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1660 | name | | 1 | string | server name |
1661 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1662 | tenantId | M | 1 | String | Tenant UUID |
1663 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1664 | boot | M | 1 | String | Start parameters |
1665 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1666 | nicArray | O | 1..n | List of nic | List of nic |
1667 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1668 | volumeArray | O | 1..n | list of volume | list of volume |
1669 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1670 | availabilityZone | O | 1 | string | Usable field |
1671 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1672 | flavorId | M | 1 | String | server Flavor |
1673 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1674 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1675 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1676 | **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.** |
1678 | | | | | **[TBD]** |
1679 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1680 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1683 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1684 | **status** | **M** | **1** | **string** | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR |
1685 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1693 "id": "3c9eebdbbfd345658269340b9ea6fb73",
1701 1. \ **Delete Server**
1703 +---------------------+-------------------------------------------------------------------------------------------+
1704 | **IF Definition** | **Description** |
1705 +=====================+===========================================================================================+
1706 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1707 +---------------------+-------------------------------------------------------------------------------------------+
1708 | Operation | DELETE |
1709 +---------------------+-------------------------------------------------------------------------------------------+
1710 | Direction | NFLCM,NSLCM->MULTIVIM |
1711 +---------------------+-------------------------------------------------------------------------------------------+
1721 1. \ **List Server**
1723 +---------------------+--------------------------------------------------------------------------------+
1724 | **IF Definition** | **Description** |
1725 +=====================+================================================================================+
1726 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1727 +---------------------+--------------------------------------------------------------------------------+
1729 +---------------------+--------------------------------------------------------------------------------+
1730 | Direction | NFLCM,NSLCM->MULTIVIM |
1731 +---------------------+--------------------------------------------------------------------------------+
1735 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1737 +-----------------+-----------------+-------------------+---------------+-------------------+
1738 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1739 +=================+=================+===================+===============+===================+
1740 | name | M | 1 | string | server name |
1741 +-----------------+-----------------+-------------------+---------------+-------------------+
1745 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1746 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1747 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1748 | vimId | M | 1 | String | vim id |
1749 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1750 | vimName | O | 1 | string | vim name |
1751 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1752 | servers | M | 1 | array | server list |
1753 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1754 | id | M | 1 | string | server id |
1755 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1756 | name | M | 1 | string | server name |
1757 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1758 | tenantId | M | 1 | String | Tenant UUID |
1759 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1760 | boot | M | 1 | String | Start parameters |
1761 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1762 | nicArray | O | 1..n | List of nic | List of nic |
1763 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1764 | volumeArray | O | 1..n | list of volume | list of volume |
1765 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1766 | availabilityZone | O | 1 | string | Usable field |
1767 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1768 | flavorId | M | 1 | String | server Flavor |
1769 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1770 | metada | O | 1 | keypair | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1771 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1772 | **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.** |
1774 | | | | | **[TBD]** |
1775 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1776 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1779 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1791 +---------------------+-------------------------------------------------------------------------------------------+
1792 | **IF Definition** | **Description** |
1793 +=====================+===========================================================================================+
1794 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1795 +---------------------+-------------------------------------------------------------------------------------------+
1797 +---------------------+-------------------------------------------------------------------------------------------+
1798 | Direction | NFLCM,NSLCM->MULTIVIM |
1799 +---------------------+-------------------------------------------------------------------------------------------+
1807 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1808 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1809 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1810 | vimId | M | 1 | String | vim id |
1811 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1812 | vimName | O | 1 | string | vim name |
1813 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1814 | id | M | 1 | string | server id |
1815 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1816 | name | M | 1 | string | server name |
1817 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1818 | tenantId | M | 1 | String | Tenant UUID |
1819 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1820 | boot | M | 1 | String | Start parameters |
1821 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1822 | nicArray | O | 1..n | List of nic | List of nic |
1823 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1824 | volumeArray | O | 1..n | list of volume | list of volume |
1825 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1826 | availabilityZone | O | 1 | string | Usable field |
1827 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1828 | flavorId | M | 1 | String | server Flavor |
1829 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1830 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1831 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1832 | **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.** |
1834 | | | | | **[TBD]** |
1835 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1836 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1839 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1849 1. \ **Flavor Management**
1851 1. \ **Create Flavor**
1853 +---------------------+--------------------------------------------------------------------------------+
1854 | **IF Definition** | **Description** |
1855 +=====================+================================================================================+
1856 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors |
1857 +---------------------+--------------------------------------------------------------------------------+
1858 | Operation | POST |
1859 +---------------------+--------------------------------------------------------------------------------+
1860 | Direction | VNFLCM->MULTIVIM |
1861 +---------------------+--------------------------------------------------------------------------------+
1865 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1866 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1867 +=================+=================+===================+===============================+==============================================================================================================================+
1868 | name | M | 1 | string | Flavor Name |
1869 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1870 | vcpu | M | 1 | int | Virtual CPU number |
1871 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1872 | memory | M | 1 | int | Memory size |
1873 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1874 | disk | M | 1 | int | The size of the root disk |
1875 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1876 | ephemeral | O | 1 | int | The size of the ephemeral disk |
1877 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1878 | swap | O | 1 | int | The size of the swap disk |
1879 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1880 | 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. |
1881 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1882 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1883 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1887 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1888 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1889 +=================+=================+===================+===========================+==============================================================================================================================+
1890 | id | M | 1 | string | Flavor id |
1891 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1892 | name | M | 1 | string | Flavor name |
1893 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1894 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1895 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1896 | tenantId | M | 1 | String | Tenant UUID |
1897 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1898 | vcpu | M | 1 | int | Virtual CPU number |
1899 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1900 | memory | M | 1 | int | Memory size |
1901 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1902 | disk | M | 1 | int | The size of the root disk |
1903 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1904 | ephemeral | M | 1 | int | The size of the ephemeral disk |
1905 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1906 | swap | M | 1 | int | The size of the swap disk |
1907 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1908 | 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. |
1909 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1910 | extraSpecs | O | 0..N | List of Key-value pairs | EPA parameter |
1911 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1912 | vimId | M | 1 | String | vim id |
1913 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1914 | vimName | O | 1 | string | vim name |
1915 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1917 1. \ **Delete Flavor**
1919 +---------------------+--------------------------------------------------------------------------------------------+
1920 | **IF Definition** | **Description** |
1921 +=====================+============================================================================================+
1922 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid} |
1923 +---------------------+--------------------------------------------------------------------------------------------+
1924 | Operation | DELETE |
1925 +---------------------+--------------------------------------------------------------------------------------------+
1926 | Direction | NFLCM,NSLCM->MULTIVIM |
1927 +---------------------+--------------------------------------------------------------------------------------------+
1937 1. \ **List Flavor**
1939 +---------------------+---------------------------------------------------------------------------------+
1940 | **IF Definition** | **Description** |
1941 +=====================+=================================================================================+
1942 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors |
1943 +---------------------+---------------------------------------------------------------------------------+
1945 +---------------------+---------------------------------------------------------------------------------+
1946 | Direction | NFLCM,NSLCM->MULTIVIM |
1947 +---------------------+---------------------------------------------------------------------------------+
1951 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1952 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1953 +=================+=================+===================+===============+==================================+
1954 | name | M | 1 | string | Flavor name to filter out list |
1955 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1959 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1960 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1961 +=================+=================+===================+===============================+==============================================================================================================================+
1962 | flavors | M | 0..N | list | Vm list |
1963 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1964 | id | M | 1 | string | Flavor id |
1965 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1966 | name | M | 1 | string | Flavor Name |
1967 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1968 | vcpu | M | 1 | int | Virtual CPU number |
1969 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1970 | memory | M | 1 | int | Memory size |
1971 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1972 | disk | M | 1 | int | The size of the root disk |
1973 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1974 | ephemeral | M | 1 | int | The size of the ephemeral disk |
1975 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1976 | swap | M | 1 | int | The size of the swap disk |
1977 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1978 | 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. |
1979 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1980 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1981 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1982 | vimId | M | 1 | String | vim id |
1983 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1984 | vimName | O | 1 | string | vim name |
1985 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1986 | tenantId | M | 1 | String | Tenant UUID |
1987 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1995 +---------------------+----------------------------------------------------------------------------------------------+
1996 | **IF Definition** | **Description** |
1997 +=====================+==============================================================================================+
1998 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid } |
1999 +---------------------+----------------------------------------------------------------------------------------------+
2001 +---------------------+----------------------------------------------------------------------------------------------+
2002 | Direction | NFLCM,NSLCM->MULTIVIM |
2003 +---------------------+----------------------------------------------------------------------------------------------+
2011 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2012 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2013 +=================+=================+===================+===============================+==============================================================================================================================+
2014 | id | M | 1 | string | Flavor id |
2015 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2016 | name | M | 1 | string | Flavor Name |
2017 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2018 | vcpu | M | 1 | int | Virtual CPU number |
2019 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2020 | memory | M | 1 | int | Memory size |
2021 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2022 | disk | M | 1 | int | The size of the root disk |
2023 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2024 | ephemeral | M | 1 | int | The size of the ephemeral disk |
2025 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2026 | swap | M | 1 | int | The size of the swap disk |
2027 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2028 | 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. |
2029 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2030 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
2031 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2032 | vimId | M | 1 | String | vim id |
2033 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2034 | vimName | O | 1 | string | vim name |
2035 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2036 | tenantId | M | 1 | String | Tenant UUID |
2037 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2043 1. \ **Volume Management**
2045 1. \ **Create Volume**
2047 +---------------------+--------------------------------------------------------------------------------+
2048 | **IF Definition** | **Description** |
2049 +=====================+================================================================================+
2050 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
2051 +---------------------+--------------------------------------------------------------------------------+
2052 | Operation | POST |
2053 +---------------------+--------------------------------------------------------------------------------+
2054 | Direction | NSLCM->MULTIVIM |
2055 +---------------------+--------------------------------------------------------------------------------+
2059 +--------------------+-----------------+-------------------+---------------+-------------------+
2060 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2061 +====================+=================+===================+===============+===================+
2062 | name | M | 1 | string | Volume name |
2063 +--------------------+-----------------+-------------------+---------------+-------------------+
2064 | volumeSize | M | 1 | int | Volume size |
2065 +--------------------+-----------------+-------------------+---------------+-------------------+
2066 | imageId | O | 1 | string | Image UUID |
2067 +--------------------+-----------------+-------------------+---------------+-------------------+
2068 | volumeType | O | 1 | string | Volume type |
2069 +--------------------+-----------------+-------------------+---------------+-------------------+
2070 | availabilityZone | O | 1 | string | Usable field |
2071 +--------------------+-----------------+-------------------+---------------+-------------------+
2075 "tenant": "tenant1",
2077 "volumeName": "volume1",
2081 "imageName": "cirros.qcow2",
2083 "volumeType": "volumetype1",
2085 "availabilityZone": "zone1"
2091 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2092 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2093 +====================+=================+===================+===============+=====================================+
2094 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
2095 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2096 | vimId | M | 1 | String | vim id |
2097 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2098 | vimName | O | 1 | string | vim name |
2099 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2100 | tenantId | M | 1 | String | Tenant UUID |
2101 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2102 | status | M | 1 | string | Volume status |
2103 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2104 | id | M | 1 | string | Volume id |
2105 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2106 | name | M | 1 | string | Volume name |
2107 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2108 | volumeType | O | 1 | string | Volume type |
2109 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2110 | availabilityZone | O | 1 | string | Availability Zone |
2111 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2119 "id": "bc9eebdbbfd356458269340b9ea6fb73",
2127 1. \ **Delete Volume**
2129 +---------------------+-------------------------------------------------------------------------------------------+
2130 | **IF Definition** | **Description** |
2131 +=====================+===========================================================================================+
2132 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId} |
2133 +---------------------+-------------------------------------------------------------------------------------------+
2134 | Operation | DELETE |
2135 +---------------------+-------------------------------------------------------------------------------------------+
2136 | Direction | NSLCM->MULTIVIM |
2137 +---------------------+-------------------------------------------------------------------------------------------+
2147 1. \ **List Volumes**
2149 +---------------------+--------------------------------------------------------------------------------+
2150 | **IF Definition** | **Description** |
2151 +=====================+================================================================================+
2152 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
2153 +---------------------+--------------------------------------------------------------------------------+
2155 +---------------------+--------------------------------------------------------------------------------+
2156 | Direction | NSLCM-> MULTIVIM |
2157 +---------------------+--------------------------------------------------------------------------------+
2161 msb.onap.org:80/api/multicloud/v0/{cloud
2162 owner}\_{region}/volumes?{……}
2164 +-----------------+-----------------+-------------------+---------------+-------------------+
2165 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2166 +=================+=================+===================+===============+===================+
2167 | name | M | 1 | string | Volume name |
2168 +-----------------+-----------------+-------------------+---------------+-------------------+
2172 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2173 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2174 +====================+=================+===================+======================+====================================================+
2175 | vimId | M | 1 | String | vim id |
2176 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2177 | vimName | O | 1 | string | vim name |
2178 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2179 | tenantId | M | 1 | String | Tenant UUID |
2180 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2181 | volumes | M | 1 | Array | |
2182 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2183 | id | M | 1 | string | Volume id |
2184 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2185 | name | M | 1 | string | Volume name |
2186 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2187 | createTime | O | 1 | string | Create time |
2188 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2189 | status | M | 1 | string | Volume status |
2190 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2191 | volumeSize | M | 1 | int | Volume size |
2192 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2193 | volumeType | M | 1 | string | Volume type |
2194 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2195 | availabilityZone | M | 1 | string | Availability Zone |
2196 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2197 | attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2198 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2210 "status": "available",
2216 "createTime": "2015-12-02T07:57:23.000000",
2218 " volumeType ": "ws",
2220 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2236 "device": "/dev/vdc",
2238 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2240 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2244 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2250 "createTime": "2015-12-02T06:39:40.000000",
2252 " volumeType ": null,
2254 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2264 1. \ **Get Volumes**
2266 +---------------------+-------------------------------------------------------------------------------------------+
2267 | **IF Definition** | **Description** |
2268 +=====================+===========================================================================================+
2269 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid} |
2270 +---------------------+-------------------------------------------------------------------------------------------+
2272 +---------------------+-------------------------------------------------------------------------------------------+
2273 | Direction | NSLCM-> MULTIVIM |
2274 +---------------------+-------------------------------------------------------------------------------------------+
2282 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2283 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2284 +====================+=================+===================+======================+====================================================+
2285 | vimId | M | 1 | String | vim id |
2286 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2287 | vimName | O | 1 | string | vim name |
2288 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2289 | tenantId | M | 1 | String | Tenant UUID |
2290 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2291 | id | | 1 | string | Volume id |
2292 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2293 | name | | 1 | string | Volume name |
2294 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2295 | createTime | | 1 | string | Create time |
2296 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2297 | status | | 1 | string | Volume status |
2298 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2299 | volumeType | | 1 | list of string | Volume type |
2300 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2301 | volumeSize | | 1 | int | Volume size |
2302 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2303 | availabilityZone | M | 1 | string | Availability Zone |
2304 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2305 | attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2306 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2310 +-----------------+-----------------+-------------------+---------------+-------------------+
2311 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2312 +=================+=================+===================+===============+===================+
2313 | device | | 1 | string | Device name |
2314 +-----------------+-----------------+-------------------+---------------+-------------------+
2315 | serverId | | 1 | string | VM id |
2316 +-----------------+-----------------+-------------------+---------------+-------------------+
2317 | volumeId | | 1 | string | Volume id |
2318 +-----------------+-----------------+-------------------+---------------+-------------------+
2319 | hostName | | 1 | string | Host name |
2320 +-----------------+-----------------+-------------------+---------------+-------------------+
2321 | id | | 1 | string | Device id |
2322 +-----------------+-----------------+-------------------+---------------+-------------------+
2338 "device": "/dev/vdc",
2340 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2342 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2346 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2352 "createTime": "2015-12-02T06:39:40.000000",
2354 "volumeType ": null,
2356 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2362 1. \ **Tenant Management**
2364 1. \ **List tenants**
2366 +---------------------+---------------------------------------------------------------------+
2367 | **IF Definition** | **Description** |
2368 +=====================+=====================================================================+
2369 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants |
2370 +---------------------+---------------------------------------------------------------------+
2372 +---------------------+---------------------------------------------------------------------+
2373 | Direction | NSLCM-> MULTIVIM |
2374 +---------------------+---------------------------------------------------------------------+
2378 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2379 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2380 +=====================+=================+===================+===============+=====================================+
2381 | name={tenantname} | O | 1 | string | Tenant name to filter output list |
2382 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2386 +-----------------+-----------------+-------------------+---------------+-------------------+
2387 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2388 +=================+=================+===================+===============+===================+
2389 | vimId | M | 1 | String | vim id |
2390 +-----------------+-----------------+-------------------+---------------+-------------------+
2391 | vimName | O | 1 | string | vim name |
2392 +-----------------+-----------------+-------------------+---------------+-------------------+
2393 | tenants | M | 1 | Array | |
2394 +-----------------+-----------------+-------------------+---------------+-------------------+
2395 | id | M | 1 | string | tenant UUID |
2396 +-----------------+-----------------+-------------------+---------------+-------------------+
2397 | name | M | 1 | string | tenant name |
2398 +-----------------+-----------------+-------------------+---------------+-------------------+
2422 1. \ **List Limits of resouces: CPU&Memory, volume,network,etc**
2424 +---------------------+-------------------------------------------------------------------------------+
2425 | **IF Definition** | **Description** |
2426 +=====================+===============================================================================+
2427 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits |
2428 +---------------------+-------------------------------------------------------------------------------+
2430 +---------------------+-------------------------------------------------------------------------------+
2431 | Direction | NSLCM-> MULTIVIM |
2432 +---------------------+-------------------------------------------------------------------------------+
2438 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2439 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2440 +===========================+=================+===================+===============+==================================================================+
2441 | vimId | M | 1 | String | vim id |
2442 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2443 | vimName | O | 1 | string | vim name |
2444 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2445 | tenantId | M | 1 | string | Tenant UUID |
2446 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2447 | maxPersonality | O | 1 | int | The number of allowed injected files for each tenant. |
2448 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2449 | maxPersonalitySize | O | 1 | int | The number of allowed bytes of content for each injected file. |
2450 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2451 | maxServerGroupMembers | O | 1 | int | The number of allowed members for each server group. |
2452 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2453 | maxServerGroups | O | 1 | int | The number of allowed server groups for each tenant. |
2454 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2455 | maxServerMeta | O | 1 | int | The number of allowed metadata items for each instance. |
2456 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2457 | maxTotalCores | O | 1 | int | The number of allowed instance cores for each tenant. |
2458 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2459 | maxTotalInstances | O | 1 | int | The number of allowed instances for each tenant. |
2460 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2461 | maxTotalKeypairs | O | 1 | int | The number of allowed key pairs for each user. |
2462 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2463 | maxTotalRAMSize | O | 1 | int | The amount of allowed instance RAM, in MB, for each tenant. |
2464 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2465 | maxTotalVolumeGigabytes | O | 1 | int | The maximum total amount of volumes, in gibibytes (GiB). |
2466 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2467 | maxTotalVolumes | O | 1 | int | The maximum number of volumes. |
2468 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2469 | totalVolumesUsed | O | 1 | int | The total number of volumes used. |
2470 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2471 | totalGigabytesUsed | O | 1 | int | The total number of gibibytes (GiB) used. |
2472 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2473 | network | O | 1 | int | The number of networks allowed for each project. |
2474 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2475 | subnet | O | 1 | int | The number of subnets allowed for each project. |
2476 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2477 | subnetpool | O | 1 | int | The number of subnet pools allowed for each project. |
2478 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2479 | security\_group\_rule | O | 1 | int | The number of security group rules allowed for each project. |
2480 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2481 | security\_group | O | 1 | int | The number of security groups allowed for each project. |
2482 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2483 | router | O | 1 | int | The number of routers allowed for each project. |
2484 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2485 | port | O | 1 | int | The number of ports allowed for each project. |
2486 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2494 "maxPersonality": 5,
2496 "maxPersonalitySize": 10240,
2498 "maxServerMeta": 128,
2500 "maxTotalCores": 20,
2502 "maxTotalInstances": 10,
2504 "maxTotalKeypairs": 100,
2506 "maxTotalRAMSize": 51200,
2508 "maxServerGroups": 10,
2510 "maxServerGroupMembers": 10,
2514 1. \ **Host Management**
2518 +---------------------+------------------------------------------------------------------------------+
2519 | **IF Definition** | **Description** |
2520 +=====================+==============================================================================+
2521 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts |
2522 +---------------------+------------------------------------------------------------------------------+
2524 +---------------------+------------------------------------------------------------------------------+
2525 | Direction | NSLCM-> MULTIVIM |
2526 +---------------------+------------------------------------------------------------------------------+
2532 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2533 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2534 +=================+=================+===================+=================+===================================+
2535 | vimId | M | 1 | String | vim id |
2536 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2537 | vimName | O | 1 | string | vim name |
2538 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2539 | tenantId | M | 1 | string | Tenant Name |
2540 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2541 | hosts | M | 1 | Array of host | List of host information |
2542 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2543 | service | M | 1 | string | The service running on the host |
2544 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2545 | name | M | 1 | string | host name |
2546 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2547 | zone | O | 1 | string | Available zone for the host |
2548 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2558 "vimName": "vimName",
2560 "tenantId": "tenantId1"
2566 "name": "b6e4adbc193d428ea923899d07fb001e",
2568 "service": "conductor",
2574 "vimName": "vimName",
2576 "tenantId": "tenantId1"
2582 "name": "09c025b0efc64211bd23fc50fa974cdf",
2584 "service": "compute",
2590 "vimName": "vimName",
2592 "tenantId": "tenantId1"
2598 "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2600 "service": "consoleauth",
2606 "vimName": "vimName",
2608 "tenantId": "tenantId1"
2614 "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2616 "service": "network",
2622 "vimName": "vimName",
2624 "tenantId": "tenantId1"
2630 "name": "abffda96592c4eacaf4111c28fddee17",
2632 "service": "scheduler",
2638 "vimName": "vimName",
2640 "tenantId": "tenantId1"
2650 +---------------------+-----------------------------------------------------------------------------------------+
2651 | **IF Definition** | **Description** |
2652 +=====================+=========================================================================================+
2653 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts/{hostname} |
2654 +---------------------+-----------------------------------------------------------------------------------------+
2656 +---------------------+-----------------------------------------------------------------------------------------+
2657 | Direction | NSLCM-> MULTIVIM |
2658 +---------------------+-----------------------------------------------------------------------------------------+
2664 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2665 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2666 +=================+=================+===================+=====================+==============================================================+
2667 | vimId | M | 1 | String | vim id |
2668 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2669 | vimName | O | 1 | string | vim name |
2670 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2671 | tenantId | M | 1 | string | Tenant Name |
2672 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2673 | host | M | 1 | List of resources | Host resource info |
2674 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2675 | resource | M | 1..N | Object | Resource description |
2676 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2677 | cpu | M | 1 | Int | The cpu info on the host. |
2678 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2679 | memory\_mb | M | 1 | int | The memory info on the host (in MB). |
2680 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2681 | name | M | 1 | string | host name |
2682 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2683 | project | M | 1 | string | Value: total, used\_now, used\_max or specific project\_id |
2684 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2685 | disk\_gb | M | 1 | int | The disk info on the host (in GB). |
2686 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2698 "name": "c1a7de0ac9d94e4baceae031d05caae3",
2704 "vimName": "vimName",
2706 "tenantId": "tenantId1"
2718 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2722 "project": "(total)",
2732 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2736 "project": "(used\_now)",
2746 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2750 "project": "(used\_max)",
2760 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2764 "project": "568f7ec425db472ba348251bf1e7eebd",
2772 "vimName": "openstack\_newton",
2774 "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2776 "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2780 1. \ **VIM Management**
2782 1. \ **Update VIM Info**
2784 +---------------------+----------------------------------------------------------------------------------------------+
2785 | **IF Definition** | **Description** |
2786 +=====================+==============================================================================================+
2787 | URI | http(s)://[hostname][:port]/onapapi/ multicloud /v1/{cloud-owner}\_{cloud-region}/registry |
2788 +---------------------+----------------------------------------------------------------------------------------------+
2789 | Operation | POST |
2790 +---------------------+----------------------------------------------------------------------------------------------+
2791 | Direction | ESR-> MULTICLOUD |
2792 +---------------------+----------------------------------------------------------------------------------------------+
2796 +-----------------+-----------------+-------------------+---------------+-----------------------+
2797 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2798 +=================+=================+===================+===============+=======================+
2799 | defaultTenant | M | 1 | string | default tenant name |
2800 +-----------------+-----------------+-------------------+---------------+-----------------------+
2810 1. \ **Unregistry VIM**
2812 +---------------------+-----------------------------------------------------------------------------------------------+
2813 | **IF Definition** | **Description** |
2814 +=====================+===============================================================================================+
2815 | URI | http(s)://[hostname][:port]/onapapi/multicloud/v1 /{cloud-owner}\_{cloud-region}/unregistry |
2816 +---------------------+-----------------------------------------------------------------------------------------------+
2817 | Operation | DELETE |
2818 +---------------------+-----------------------------------------------------------------------------------------------+
2819 | Direction | ESR-> MULTICLOUD |
2820 +---------------------+-----------------------------------------------------------------------------------------------+
2830 204: No content found