1 ================================
2 MultiCloud API Specification V1
3 ================================
8 `1. Scope 5 <#_Toc490851650>`__
10 `2. Terms, Definitions and Abbreviations 5 <#_Toc490851651>`__
12 `3. Image Management 5 <#_Toc490851652>`__
14 `3.1 Create Image 5 <#_Toc490851653>`__
16 `3.1.1 Request 5 <#_Toc490851654>`__
18 `3.1.2 Response 6 <#_Toc490851655>`__
20 `3.2 Delete Image 7 <#_Toc490851656>`__
22 `3.2.1 Request 7 <#_Toc490851657>`__
24 `3.2.2 Response 7 <#_Toc490851658>`__
26 `3.3 List Images 7 <#_Toc490851659>`__
28 `3.3.1 Request 7 <#_Toc490851660>`__
30 `3.3.2 Response 8 <#_Toc490851661>`__
32 `3.4 Get Image 9 <#_Toc490851662>`__
34 `3.4.1 Request 9 <#_Toc490851663>`__
36 `3.4.2 Response 9 <#_Toc490851664>`__
38 `4. Network Management 10 <#_Toc490851665>`__
40 `4.1 Create Network 10 <#_Toc490851666>`__
42 `4.1.1 Request 10 <#_Toc490851667>`__
44 `4.1.2 Response 11 <#_Toc490851668>`__
46 `4.2 Delete Network 12 <#_Toc490851669>`__
48 `4.2.1 Request 12 <#_Toc490851670>`__
50 `4.2.2 Response 12 <#_Toc490851671>`__
52 `4.3 List Network 12 <#_Toc490851672>`__
54 `4.3.1 Query 12 <#_Toc490851673>`__
56 `4.3.2 Response 13 <#_Toc490851674>`__
58 `4.4 Get Network 14 <#_Toc490851675>`__
60 `4.4.1 Request 14 <#_Toc490851676>`__
62 `4.4.2 Response 14 <#_Toc490851677>`__
64 `5. Subnetwork Management 16 <#_Toc490851678>`__
66 `5.1 Create Subnets 16 <#_Toc490851679>`__
68 `5.1.1 Request 16 <#_Toc490851680>`__
70 `5.1.2 Response 17 <#_Toc490851681>`__
72 `5.2 Delete Subnets 18 <#_Toc490851682>`__
74 `5.2.1 Request 18 <#_Toc490851683>`__
76 `5.2.2 Response 18 <#_Toc490851684>`__
78 `5.3 List Subnets 18 <#_Toc490851685>`__
80 `5.3.1 Query 18 <#_Toc490851686>`__
82 `5.3.2 Response 19 <#_Toc490851687>`__
84 `5.4 Get Subnets 20 <#_Toc490851688>`__
86 `5.4.1 Request 20 <#_Toc490851689>`__
88 `5.4.2 Response 20 <#_Toc490851690>`__
90 `6. Virtual Port 21 <#_Toc490851691>`__
92 `6.1 Create Virtual Port 21 <#_Toc490851692>`__
94 `6.1.1 Request 21 <#_Toc490851693>`__
96 `6.1.2 Response 22 <#_Toc490851694>`__
98 `6.2 Delete Virtual Port 22 <#_Toc490851695>`__
100 `6.2.1 Request 23 <#_Toc490851696>`__
102 `6.2.2 Response 23 <#_Toc490851697>`__
104 `6.3 List Virtual Port 23 <#_Toc490851698>`__
106 `6.3.1 Query 23 <#_Toc490851699>`__
108 `6.3.2 Response 23 <#_Toc490851700>`__
110 `6.4 Get Virtual Port 24 <#_Toc490851701>`__
112 `6.4.1 Request 24 <#_Toc490851702>`__
114 `6.4.2 Response 24 <#_Toc490851703>`__
116 `7. Server Management 25 <#_Toc490851704>`__
118 `7.1 Create Server 25 <#_Toc490851705>`__
120 `7.1.1 Request 25 <#_Toc490851706>`__
122 `7.1.2 Response 27 <#_Toc490851707>`__
124 `7.2 Delete Server 28 <#_Toc490851708>`__
126 `7.2.1 Request 28 <#_Toc490851709>`__
128 `7.2.2 Response 28 <#_Toc490851710>`__
130 `7.3 List Server 28 <#_Toc490851711>`__
132 `7.3.1 Request 28 <#_Toc490851712>`__
134 `7.3.2 Response 29 <#_Toc490851713>`__
136 `7.4 Get Server 29 <#_Toc490851714>`__
138 `7.4.1 Request 30 <#_Toc490851715>`__
140 `7.4.2 Response 30 <#_Toc490851716>`__
142 `8. Flavor Management 30 <#_Toc490851717>`__
144 `8.1 Create Flavor 31 <#_Toc490851718>`__
146 `8.1.1 Request 31 <#_Toc490851719>`__
148 `8.1.2 Response 31 <#_Toc490851720>`__
150 `8.2 Delete Flavor 32 <#_Toc490851721>`__
152 `8.2.1 Request 32 <#_Toc490851722>`__
154 `8.2.2 Response 32 <#_Toc490851723>`__
156 `8.3 List Flavor 32 <#_Toc490851724>`__
158 `8.3.1 Query 32 <#_Toc490851725>`__
160 `8.3.2 Response 32 <#_Toc490851726>`__
162 `8.4 Get Flavor 33 <#_Toc490851727>`__
164 `8.4.1 Request 33 <#_Toc490851728>`__
166 `8.4.2 Response 33 <#_Toc490851729>`__
168 `9. Volume Management 34 <#_Toc490851730>`__
170 `9.1 Create Volume 34 <#_Toc490851731>`__
172 `9.1.1 Request 34 <#_Toc490851732>`__
174 `9.1.2 Response 34 <#_Toc490851733>`__
176 `9.2 Delete Volume 35 <#_Toc490851734>`__
178 `9.2.1 Request 35 <#_Toc490851735>`__
180 `9.2.2 Response 35 <#_Toc490851736>`__
182 `9.3 List Volumes 35 <#_Toc490851737>`__
184 `9.3.1 Request 35 <#_Toc490851738>`__
186 `9.3.2 Response 36 <#_Toc490851739>`__
188 `9.4 Get Volumes 37 <#_Toc490851740>`__
190 `9.4.1 Request 37 <#_Toc490851741>`__
192 `9.4.2 Response 37 <#_Toc490851742>`__
194 `10. Tenant Management 38 <#_Toc490851743>`__
196 `10.1 List tenants 38 <#_Toc490851744>`__
198 `10.1.1 Query 38 <#_Toc490851745>`__
200 `10.1.2 Response 38 <#_Toc490851746>`__
202 `11. Limits 39 <#_Toc490851747>`__
204 `11.1 List Limits of resouces: CPU&Memory, volume,network,etc
205 39 <#_Toc490851748>`__
207 `11.1.1 Request 39 <#_Toc490851749>`__
209 `11.1.2 Response 39 <#_Toc490851750>`__
211 `12. Host Management 41 <#_Toc490851751>`__
213 `12.1 List hosts 41 <#_Toc490851752>`__
215 `12.1.1 Request 41 <#_Toc490851753>`__
217 `12.1.2 Response 41 <#_Toc490851754>`__
219 `12.2 Get host 43 <#_Toc490851755>`__
221 `12.2.1 Request 43 <#_Toc490851756>`__
223 `12.2.2 Response 43 <#_Toc490851757>`__
225 `13. VIM Management 45 <#_Toc490851758>`__
227 `13.1 Update VIM Info 45 <#_Toc490851759>`__
229 `13.1.1 Request 45 <#_Toc490851760>`__
231 `13.1.2 Response 45 <#_Toc490851761>`__
233 `13.2 Unregistry VIM 45 <#_Toc490851762>`__
235 `13.2.1 Request 45 <#_Toc490851763>`__
237 `13.2.2 Response 46 <#_Toc490851764>`__
244 The scope of the present document is to describe the VIM Driver API
247 1. \ **Terms, Definitions and Abbreviations**
249 For the purposes of the present document, the following abbreviations
252 +--------------------+-------------------------------------------------------------+
253 | **Abbreviation** | |
254 +====================+=============================================================+
255 | NFVO | Network Functions Virtualization Orchestrator |
256 +--------------------+-------------------------------------------------------------+
257 | VNFM | Virtual Network Function Management |
258 +--------------------+-------------------------------------------------------------+
259 | VIM | Virtualized Infrastructure Manager |
260 +--------------------+-------------------------------------------------------------+
261 | MultiVIM | MultVIM driver services for OPEN-O to drive VIM instances |
262 +--------------------+-------------------------------------------------------------+
264 Table 2-1 abbreviations
266 1. \ **Image Management**
268 1. \ **Create Image**
270 +---------------------+-------------------------------------------------------------------------------+
271 | **IF Definition** | **Description** |
272 +=====================+===============================================================================+
273 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images |
274 +---------------------+-------------------------------------------------------------------------------+
276 +---------------------+-------------------------------------------------------------------------------+
277 | Direction | NSLCM->MULTIVIM |
278 +---------------------+-------------------------------------------------------------------------------+
279 | Description | Create Image and Upload the image file to the VIM |
280 +---------------------+-------------------------------------------------------------------------------+
284 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
285 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
286 +===================+=================+===================+===========================+==================================================================================================+
287 | name | M | 1 | String | Image Name |
288 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
289 | imagePath | M | 1 | String | Image Local Path from catalog |
290 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
291 | imageType | M | 1 | String | Image Type |
293 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
294 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
295 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
296 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
297 | visibility | O | 1 | string | Visibility for this image. |
299 | | | | | public, private, shared, or community |
300 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
301 | properties | O | 0..N | List of key-value pairs | Examples:--property vmware\_disktype=streamOptimized --property vmware\_adaptertype="lsiLogic" |
302 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
306 "imageName": "cirros",
308 "imagePath": "/home/cirros.qcow2",
312 “containerFormat”:”bare”
318 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
319 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
320 +===================+=================+===================+===========================+========================================================+
321 | id | M | 1 | String | Image UUID in the VIM |
322 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
323 | name | M | 1 | String | Image Name |
324 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
325 | returnCode | M | 1 | Int | 0: Already exist 1: Newly created |
326 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
327 | imageType | M | 1 | String | Image Type |
329 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
330 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
331 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
332 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
333 | visibility | O | 1 | string | Visibility for this image. |
335 | | | | | public, private, shared, or community |
336 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
337 | properties | O | 0..N | List of key-value pairs | |
338 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
339 | vimid | M | 1 | String | vim id |
340 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
341 | vimName | O | 1 | string | vim name |
342 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
343 | tenantId | M | 1 | String | Tenant UUID |
344 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
352 “id”:” 3c9eebdbbfd345658269340b9ea6fb73”,
360 1. \ **Delete Image**
362 +---------------------+-----------------------------------------------------------------------------------------+
363 | **IF Definition** | **Description** |
364 +=====================+=========================================================================================+
365 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageId} |
366 +---------------------+-----------------------------------------------------------------------------------------+
367 | Operation | Delete |
368 +---------------------+-----------------------------------------------------------------------------------------+
369 | Direction | NSLCM->MULTIVIM |
370 +---------------------+-----------------------------------------------------------------------------------------+
371 | Description | Delete Image |
372 +---------------------+-----------------------------------------------------------------------------------------+
384 +---------------------+-------------------------------------------------------------------------------+
385 | **IF Definition** | **Description** |
386 +=====================+===============================================================================+
387 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images |
388 +---------------------+-------------------------------------------------------------------------------+
390 +---------------------+-------------------------------------------------------------------------------+
391 | Direction | NSLCM->MULTIVIM |
392 +---------------------+-------------------------------------------------------------------------------+
393 | Description | Query Image list |
394 +---------------------+-------------------------------------------------------------------------------+
398 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……}
400 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
401 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
402 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
403 | 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. |
404 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
405 | 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. |
406 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
407 | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of an image |
408 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
412 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
413 | \ **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
414 +=================================================+=================+===================+===============+========================================================+
415 | images | M | 0..N | List | Image List |
416 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
417 | id | M | 1 | String | Image ID |
418 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
419 | size | M | 1 | int | Image Size |
420 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
421 | name | M | 1 | String | Image Name |
422 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
423 | status | M | 1 | String | Image Status |
424 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
425 | imageType | M | 1 | String | Image Type |
427 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
428 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
429 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
430 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
431 | visibility | O | 1 | string | Visibility for this image. |
433 | | | | | public, private, shared, or community |
434 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
435 | vimId | M | 1 | String | vim id |
436 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
437 | vimName | O | 1 | string | vim name |
438 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
439 | tenantId | M | 1 | String | Tenant UUID |
440 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
443 | 500: failed | | | | |
447 | “vimid”:”” | | | | |
449 | “vimname”:”” | | | | |
451 | "imageList": [ | | | | |
452 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
454 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
455 | "status": "active", | | | | |
456 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
457 | "id": "5e2757c1-f846-4727-915c-9a872553ed75", | | | | |
458 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
459 | "size": 862016, | | | | |
460 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
461 | "name": "vim-plus-cgsl40g-z.qcow2" | | | | |
462 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
464 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
468 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
472 +---------------------+-----------------------------------------------------------------------------------------+
473 | **IF Definition** | **Description** |
474 +=====================+=========================================================================================+
475 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid} |
476 +---------------------+-----------------------------------------------------------------------------------------+
478 +---------------------+-----------------------------------------------------------------------------------------+
479 | Direction | NSLCM->MULTIVIM |
480 +---------------------+-----------------------------------------------------------------------------------------+
481 | Description | Query Image Information |
482 +---------------------+-----------------------------------------------------------------------------------------+
490 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
491 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
492 +===================+=================+===================+===============+========================================================+
493 | id | M | 1 | String | Image ID |
494 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
495 | size | M | 1 | int | Image Size |
496 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
497 | name | M | 1 | String | Image Name |
498 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
499 | status | M | 1 | String | Image Status |
500 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
501 | imageType | M | 1 | String | Image Type |
503 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
504 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
505 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
506 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
507 | visibility | O | 1 | string | Visibility for this image. |
509 | | | | | public, private, shared, or community |
510 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
511 | vimId | M | 1 | String | vim id |
512 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
513 | vimName | M | 1 | string | vim name |
514 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
515 | tenantId | M | 1 | String | Tenant UUID |
516 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
530 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
534 "name": "vim-plus-cgsl40g-z.qcow2"
538 1. \ **Network Management**
540 1. \ **Create Network**
542 +---------------------+---------------------------------------------------------------------------------+
543 | **IF Definition** | **Description** |
544 +=====================+=================================================================================+
545 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
546 +---------------------+---------------------------------------------------------------------------------+
548 +---------------------+---------------------------------------------------------------------------------+
549 | Direction | VNFLCM,NSLCM->MULTIVIM |
550 +---------------------+---------------------------------------------------------------------------------+
551 | Description | Create network and subnetwork on the VIM |
552 +---------------------+---------------------------------------------------------------------------------+
556 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
557 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
558 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
559 | name | M | 1 | String | Logical network name |
560 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
561 | shared | M | 1 | boolean | Whether to share(1:sharing;0:private) |
562 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
563 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
564 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
565 | networkType | O | 1 | String | Network type |
567 | | | | | flat, vlan, vxlan, gre, |
569 | | | | | portgroup |
570 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
571 | segmentationId | O | 1 | Int | id of paragraph |
572 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
573 | 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. |
574 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
575 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
576 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
578 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
579 | “tenant”: “tenant1”, | | | | |
580 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
581 | “networkName”: “ommnet”, | | | | |
582 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
583 | “shared”: 1, | | | | |
584 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
585 | “vlanTransparent”: 1, | | | | |
586 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
587 | “networkType”:”vlan”, | | | | |
588 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
589 | “segmentationId”:202, | | | | |
590 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
591 | “physicalNetwork”:”ctrl”, | | | | |
593 | “routerExternal”:0 | | | | |
594 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
596 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
600 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
601 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
602 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
603 | status | M | 1 | string | Network status |
604 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
605 | id | M | 1 | string | Network id |
606 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
607 | name | M | 1 | string | Network name |
608 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
609 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
610 | tenantId | M | 1 | String | Tenant UUID |
611 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
612 | segmentationId | O | 1 | int | Segmentation id |
613 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
614 | networkType | O | 1 | string | Network type |
615 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
616 | 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. |
617 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
618 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
619 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
620 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
621 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
622 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
623 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
624 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
625 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
626 | vimId | M | 1 | String | vim id |
627 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
628 | vimName | O | 1 | string | vim name |
629 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
645 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
651 “networkName”: “ommnet”,
655 “vlanTransparent”: 1,
657 “networkType”:”vlan”,
659 “segmentationId”:202,
661 “physicalNetwork ”:”ctrl”,
667 1. \ **Delete Network**
669 +---------------------+---------------------------------------------------------------------------------------------+
670 | **IF Definition** | **Description** |
671 +=====================+=============================================================================================+
672 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
673 +---------------------+---------------------------------------------------------------------------------------------+
674 | Operation | Delete |
675 +---------------------+---------------------------------------------------------------------------------------------+
676 | Direction | NFLCM,NSLCM->MULTIVIM |
677 +---------------------+---------------------------------------------------------------------------------------------+
687 1. \ **List Network**
689 +---------------------+---------------------------------------------------------------------------------+
690 | **IF Definition** | **Description** |
691 +=====================+=================================================================================+
692 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
693 +---------------------+---------------------------------------------------------------------------------+
695 +---------------------+---------------------------------------------------------------------------------+
696 | Direction | NFLCM,NSLCM->MULTIVIM |
697 +---------------------+---------------------------------------------------------------------------------+
701 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
702 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
703 +=================+=================+===================+===============+=======================================================================================+
704 | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of a network |
705 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
709 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
710 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
711 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
712 | vimId | M | 1 | String | vim id |
713 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
714 | vimName | O | 1 | string | vim name |
715 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
716 | networks | | 0..N | List | Network list |
717 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
718 | status | M | 1 | string | Network status |
719 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
720 | id | M | 1 | string | Network id |
721 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
722 | name | M | 1 | string | Network name |
723 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
724 | tenantId | M | 1 | String | Tenant UUID |
725 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
726 | segmentationId | O | 1 | int | Segmentation id |
727 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
728 | networkType | O | 1 | string | Network type |
729 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
730 | 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. |
731 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
732 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
733 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
734 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
735 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
736 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
737 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
755 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
761 “networkName”: “ommnet”,
765 “vlanTransparent”: 1,
767 “networkType”:”vlan”,
769 “segmentationId”:202,
771 “physicalNetwork ”:”ctrl”,
783 +---------------------+---------------------------------------------------------------------------------------------+
784 | **IF Definition** | **Description** |
785 +=====================+=============================================================================================+
786 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
787 +---------------------+---------------------------------------------------------------------------------------------+
789 +---------------------+---------------------------------------------------------------------------------------------+
790 | Direction | NFLCM,NSLCM->MULTIVIM |
791 +---------------------+---------------------------------------------------------------------------------------------+
799 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
800 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
801 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
802 | status | M | 1 | string | Network status |
803 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
804 | id | M | 1 | string | Network id |
805 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
806 | name | M | 1 | string | Network name |
807 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
808 | tenantId | M | 1 | String | Tenant UUID |
809 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
810 | segmentationId | O | 1 | int | Segmentation id |
811 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
812 | networkType | O | 1 | string | Network type |
813 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
814 | 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. |
815 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
816 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
817 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
818 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
819 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
820 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
821 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
822 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
823 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
824 | vimId | M | 1 | String | vim id |
825 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
826 | vimName | O | 1 | string | vim name |
827 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
841 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
847 “networkName”: “ommnet”,
851 “vlanTransparent”: 1,
853 “networkType”:”vlan”,
855 “segmentationId”:202,
857 “physicalNetwork ”:”ctrl”,
863 1. \ **Subnetwork Management**
865 1. \ **Create Subnets**
867 +---------------------+--------------------------------------------------------------------------------+
868 | **IF Definition** | **Description** |
869 +=====================+================================================================================+
870 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
871 +---------------------+--------------------------------------------------------------------------------+
873 +---------------------+--------------------------------------------------------------------------------+
874 | Direction | VNFLCM,NSLCM->MULTIVIM |
875 +---------------------+--------------------------------------------------------------------------------+
876 | Description | Create network and subnetwork on the VIM |
877 +---------------------+--------------------------------------------------------------------------------+
881 +-------------------+-----------------+-------------------+------------------------+----------------------+
882 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
883 +===================+=================+===================+========================+======================+
884 | networkId | M | 1 | String | Network Id |
885 +-------------------+-----------------+-------------------+------------------------+----------------------+
886 | name | M | 1 | String | SubnetName |
887 +-------------------+-----------------+-------------------+------------------------+----------------------+
888 | cidr | M | 1 | String | Subnet cidr |
889 +-------------------+-----------------+-------------------+------------------------+----------------------+
890 | ipVersion | M | 1 | Int | Ip type |
893 +-------------------+-----------------+-------------------+------------------------+----------------------+
894 | enableDhcp | O | 1 | boolean | Whether to allow |
896 | | | | | 1: yes;0: no |
897 +-------------------+-----------------+-------------------+------------------------+----------------------+
898 | gatewayIp | O | 1 | String | Gateway ip |
899 +-------------------+-----------------+-------------------+------------------------+----------------------+
900 | dnsNameservers | O | 1..n | List of servers | List of servers |
901 +-------------------+-----------------+-------------------+------------------------+----------------------+
902 | hostRoutes | O | 1..n | List of routes | List of routes |
903 +-------------------+-----------------+-------------------+------------------------+----------------------+
904 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
905 +-------------------+-----------------+-------------------+------------------------+----------------------+
906 | -->allocation | | | | |
907 +-------------------+-----------------+-------------------+------------------------+----------------------+
908 | -->start | O | 1 | String | Start ip |
909 +-------------------+-----------------+-------------------+------------------------+----------------------+
910 | -->end | O | 1 | String | End ip |
911 +-------------------+-----------------+-------------------+------------------------+----------------------+
917 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
919 “subnetName”: “subnet1”,
921 “cidr”: “10.43.35.0/24”,
927 “gatewayIp”: “10.43.35.1”,
929 “dnsNameservers”: [],
933 “start”: “192.168.199.2”,
935 “end”: “192.168.199.254”
945 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
946 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
947 +===================+=================+===================+========================+=====================================+
948 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
949 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
950 | vimId | M | 1 | String | vim id |
951 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
952 | vimName | O | 1 | string | vim name |
953 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
954 | status | M | 1 | string | subnetwork status |
955 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
956 | id | M | 1 | string | subNetwork id |
957 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
958 | tenantId | M | 1 | String | Tenant UUID |
959 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
960 | networkId | O | 1 | String | Network Id |
961 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
962 | networkName | O | 1 | String | Network Name |
963 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
964 | name | M | 1 | String | SubnetName |
965 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
966 | cidr | M | 1 | String | Subnet cidr |
967 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
968 | ipVersion | M | 1 | Int | Ip type |
971 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
972 | enableDhcp | O | 1 | boolean | Whether to allow |
974 | | | | | 1: yes;0: no |
975 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
976 | gatewayIp | O | 1 | String | Gateway ip |
977 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
978 | dnsNameservers | O | 1..n | List of servers | List of servers |
979 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
980 | hostRoutes | O | 1..n | List of routes | List of routes |
981 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
982 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
983 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
984 | -->allocation | | | | |
985 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
986 | -->start | O | 1 | String | Start ip |
987 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
988 | -->end | O | 1 | String | End ip |
989 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
1005 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1007 “tenant”: “tenant1”,
1009 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1013 “cidr”: “10.43.35.0/24”,
1019 “gatewayIp”: “10.43.35.1”,
1021 “dnsNameservers”: [],
1023 “allocationPools”:[{
1025 “start”: “192.168.199.2”,
1027 “end”: “192.168.199.254”
1035 1. \ **Delete Subnets**
1037 +---------------------+-------------------------------------------------------------------------------------------+
1038 | **IF Definition** | **Description** |
1039 +=====================+===========================================================================================+
1040 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId} |
1041 +---------------------+-------------------------------------------------------------------------------------------+
1042 | Operation | Delete |
1043 +---------------------+-------------------------------------------------------------------------------------------+
1044 | Direction | NFLCM,NSLCM->MULTIVIM |
1045 +---------------------+-------------------------------------------------------------------------------------------+
1055 1. \ **List Subnets**
1057 +---------------------+--------------------------------------------------------------------------------+
1058 | **IF Definition** | **Description** |
1059 +=====================+================================================================================+
1060 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
1061 +---------------------+--------------------------------------------------------------------------------+
1063 +---------------------+--------------------------------------------------------------------------------+
1064 | Direction | NFLCM,NSLCM->MULTIVIM |
1065 +---------------------+--------------------------------------------------------------------------------+
1069 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
1071 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1072 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1073 +=================+=================+===================+===============+================================================================================================+
1074 | name | O | 1 | String | Filters fields of the response by a name, as a string. A valid value is the name of a subnet |
1075 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1079 +-------------------+-----------------+-------------------+------------------------+----------------------+
1080 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1081 +===================+=================+===================+========================+======================+
1082 | vimId | M | 1 | String | vim id |
1083 +-------------------+-----------------+-------------------+------------------------+----------------------+
1084 | vimName | O | 1 | string | vim name |
1085 +-------------------+-----------------+-------------------+------------------------+----------------------+
1086 | subnets | M | 0..N | List | Network list |
1087 +-------------------+-----------------+-------------------+------------------------+----------------------+
1088 | status | | 1 | string | subnetwork status |
1089 +-------------------+-----------------+-------------------+------------------------+----------------------+
1090 | id | | 1 | string | subNetwork id |
1091 +-------------------+-----------------+-------------------+------------------------+----------------------+
1092 | tenantId | M | 1 | String | Tenant UUID |
1093 +-------------------+-----------------+-------------------+------------------------+----------------------+
1094 | networkId | O | 1 | String | Network Id |
1095 +-------------------+-----------------+-------------------+------------------------+----------------------+
1096 | networkName | O | 1 | String | Network Name |
1097 +-------------------+-----------------+-------------------+------------------------+----------------------+
1098 | name | M | 1 | String | SubnetName |
1099 +-------------------+-----------------+-------------------+------------------------+----------------------+
1100 | cidr | M | 1 | String | Subnet cidr |
1101 +-------------------+-----------------+-------------------+------------------------+----------------------+
1102 | ipVersion | M | 1 | Int | Ip type |
1105 +-------------------+-----------------+-------------------+------------------------+----------------------+
1106 | enableDhcp | O | 1 | boolean | Whether to allow |
1108 | | | | | 1: yes;0: no |
1109 +-------------------+-----------------+-------------------+------------------------+----------------------+
1110 | gatewayIp | O | 1 | String | Gateway ip |
1111 +-------------------+-----------------+-------------------+------------------------+----------------------+
1112 | dnsNameservers | O | 1..n | List of servers | List of servers |
1113 +-------------------+-----------------+-------------------+------------------------+----------------------+
1114 | hostRoutes | O | 1..n | List of routes | List of routes |
1115 +-------------------+-----------------+-------------------+------------------------+----------------------+
1116 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
1117 +-------------------+-----------------+-------------------+------------------------+----------------------+
1118 | -->allocation | | | | |
1119 +-------------------+-----------------+-------------------+------------------------+----------------------+
1120 | -->start | O | 1 | String | Start ip |
1121 +-------------------+-----------------+-------------------+------------------------+----------------------+
1122 | -->end | O | 1 | String | End ip |
1123 +-------------------+-----------------+-------------------+------------------------+----------------------+
1141 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1143 “tenant”: “tenant1”,
1145 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1149 “cidr”: “10.43.35.0/24”,
1155 “gatewayIp”: “10.43.35.1”,
1157 “dnsNameservers”: [],
1159 “allocationPools”:[{
1161 “start”: “192.168.199.2”,
1163 “end”: “192.168.199.254”
1175 1. \ **Get Subnets**
1177 +---------------------+-------------------------------------------------------------------------------------------+
1178 | **IF Definition** | **Description** |
1179 +=====================+===========================================================================================+
1180 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid} |
1181 +---------------------+-------------------------------------------------------------------------------------------+
1183 +---------------------+-------------------------------------------------------------------------------------------+
1184 | Direction | NFLCM,NSLCM->MULTIVIM |
1185 +---------------------+-------------------------------------------------------------------------------------------+
1193 +-------------------+-----------------+-------------------+------------------------+----------------------+
1194 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1195 +===================+=================+===================+========================+======================+
1196 | vimId | M | 1 | String | vim id |
1197 +-------------------+-----------------+-------------------+------------------------+----------------------+
1198 | vimName | O | 1 | string | vim name |
1199 +-------------------+-----------------+-------------------+------------------------+----------------------+
1200 | status | | 1 | string | subnetwork status |
1201 +-------------------+-----------------+-------------------+------------------------+----------------------+
1202 | id | | 1 | string | subNetwork id |
1203 +-------------------+-----------------+-------------------+------------------------+----------------------+
1204 | tenantId | M | 1 | String | Tenant UUID |
1205 +-------------------+-----------------+-------------------+------------------------+----------------------+
1206 | networkId | O | 1 | String | Network Id |
1207 +-------------------+-----------------+-------------------+------------------------+----------------------+
1208 | networkName | O | 1 | String | Network Name |
1209 +-------------------+-----------------+-------------------+------------------------+----------------------+
1210 | name | M | 1 | String | SubnetName |
1211 +-------------------+-----------------+-------------------+------------------------+----------------------+
1212 | cidr | M | 1 | String | Subnet cidr |
1213 +-------------------+-----------------+-------------------+------------------------+----------------------+
1214 | ipVersion | M | 1 | Int | Ip type |
1217 +-------------------+-----------------+-------------------+------------------------+----------------------+
1218 | enableDhcp | O | 1 | boolean | Whether to allow |
1220 | | | | | 1: yes;0: no |
1221 +-------------------+-----------------+-------------------+------------------------+----------------------+
1222 | gatewayIp | O | 1 | String | Gateway ip |
1223 +-------------------+-----------------+-------------------+------------------------+----------------------+
1224 | dnsNameservers | O | 1..n | List of servers | List of servers |
1225 +-------------------+-----------------+-------------------+------------------------+----------------------+
1226 | hostRoutes | O | 1..n | List of routes | List of routes |
1227 +-------------------+-----------------+-------------------+------------------------+----------------------+
1228 | allocationPools | O | 1..n | list of “allocation” | list of allocation |
1229 +-------------------+-----------------+-------------------+------------------------+----------------------+
1230 | -->allocation | | | | |
1231 +-------------------+-----------------+-------------------+------------------------+----------------------+
1232 | -->start | O | 1 | String | Start ip |
1233 +-------------------+-----------------+-------------------+------------------------+----------------------+
1234 | -->end | O | 1 | String | End ip |
1235 +-------------------+-----------------+-------------------+------------------------+----------------------+
1245 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1247 “tenant”: “tenant1”,
1249 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1253 “cidr”: “10.43.35.0/24”,
1259 “gatewayIp”: “10.43.35.1”,
1261 “dnsNameservers”: [],
1263 “allocationPools”:[{
1265 “start”: “192.168.199.2”,
1267 “end”: “192.168.199.254”
1275 1. \ **Virtual Port**
1277 1. \ **Create Virtual Port**
1279 +---------------------+------------------------------------------------------------------------------+
1280 | **IF Definition** | **Description** |
1281 +=====================+==============================================================================+
1282 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports |
1283 +---------------------+------------------------------------------------------------------------------+
1284 | Operation | POST |
1285 +---------------------+------------------------------------------------------------------------------+
1286 | Direction | VNFLCM->MULTIVIM |
1287 +---------------------+------------------------------------------------------------------------------+
1291 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1292 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1293 +========================+=================+===================+===============+=======================================================+
1294 | networkId | M | 1 | string | Network UUID |
1295 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1296 | subnetId | O | 1 | string | Subnet UUID |
1297 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1298 | name | M | 1 | string | Port name |
1299 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1300 | macAddress | O | 1 | string | Mac address |
1301 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1302 | ip | O | 1 | string | Ip address |
1303 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1304 | vnicType | O | 1 | string | Virtual network card type, |
1306 | | | | | the value of three kinds of normal/direct/macvtap |
1307 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1308 | \ **securityGroups** | **O** | **1** | **string** | **The IDs of security groups applied to the port.** |
1309 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1313 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1314 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1315 +======================+=================+===================+===============+=====================================================+
1316 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1317 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1318 | vimId | M | 1 | String | vim id |
1319 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1320 | vimName | O | 1 | string | vim name |
1321 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1322 | status | M | 1 | string | status |
1323 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1324 | id | M | 1 | string | Port Id |
1325 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1326 | name | M | 1 | string | Port name |
1327 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1328 | tenantId | M | 1 | String | Tenant UUID |
1329 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1330 | networkName | M | 1 | string | Network name |
1331 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1332 | networkId | M | 1 | string | Network Id |
1333 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1334 | subnetName | M | 1 | string | Subnet name |
1335 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1336 | subnetId | M | 1 | string | SubnetId |
1337 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1338 | macAddress | O | 1 | string | Mac address |
1339 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1340 | ip | O | 1 | string | Ip address |
1341 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1342 | vnicType | O | 1 | string | Virtual network card type, |
1344 | | | | | the value of three kinds of normal/direct/macvtap |
1345 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1346 | **securityGroups** | **O** | **1** | **string** | **List of security group names.** |
1347 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1349 1. \ **Delete Virtual Port**
1351 +---------------------+---------------------------------------------------------------------------------------+
1352 | **IF Definition** | **Description** |
1353 +=====================+=======================================================================================+
1354 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1355 +---------------------+---------------------------------------------------------------------------------------+
1356 | Operation | DELETTE |
1357 +---------------------+---------------------------------------------------------------------------------------+
1358 | Direction | VNFLCM->MULTIVIM |
1359 +---------------------+---------------------------------------------------------------------------------------+
1369 1. \ **List Virtual Port**
1371 +---------------------+-----------------------------------------------------------------------------+
1372 | **IF Definition** | **Description** |
1373 +=====================+=============================================================================+
1374 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports |
1375 +---------------------+-----------------------------------------------------------------------------+
1377 +---------------------+-----------------------------------------------------------------------------+
1378 | Direction | VNFLCM->MULTIVIM |
1379 +---------------------+-----------------------------------------------------------------------------+
1383 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1384 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1385 +=================+=================+===================+===============+=================================================+
1386 | name | M | 1 | string | Port name to filter out list of virtual ports |
1387 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1391 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1392 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1393 +===================+=================+===================+===============+=====================================================+
1394 | vimId | M | 1 | String | vim id |
1395 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1396 | vimName | O | 1 | string | vim name |
1397 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1398 | tenantId | M | 1 | String | Tenant UUID |
1399 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1400 | Ports | M | 0..N | List | ports |
1401 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1402 | id | M | 1 | string | Port Id |
1403 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1404 | name | M | 1 | string | Port name |
1405 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1406 | status | M | 1 | string | status |
1407 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1408 | **networkName** | O | 1 | string | Network name |
1409 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1410 | networkId | M | 1 | string | Network Id |
1411 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1412 | subnetName | O | 1 | string | Subnet name |
1413 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1414 | subnetId | M | 1 | string | SubnetId |
1415 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1416 | macAddress | O | 1 | string | Mac address |
1417 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1418 | ip | O | 1 | string | Ip address |
1419 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1420 | vnicType | O | 1 | string | Virtual network card type, |
1422 | | | | | the value of three kinds of normal/direct/macvtap |
1423 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1424 | securityGroups | O | 1 | string | List of security group names. |
1425 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1435 1. \ **Get Virtual Port**
1437 +---------------------+---------------------------------------------------------------------------------------+
1438 | **IF Definition** | **Description** |
1439 +=====================+=======================================================================================+
1440 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1441 +---------------------+---------------------------------------------------------------------------------------+
1443 +---------------------+---------------------------------------------------------------------------------------+
1444 | Direction | VNFLCM->MULTIVIM |
1445 +---------------------+---------------------------------------------------------------------------------------+
1453 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1454 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1455 +==================+=================+===================+===============+=====================================================+
1456 | vimId | M | 1 | String | vim id |
1457 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1458 | vimName | O | 1 | string | vim name |
1459 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1460 | status | M | 1 | string | status |
1461 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1462 | id | M | 1 | string | Port Id |
1463 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1464 | name | M | 1 | string | Port name |
1465 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1466 | tenantId | M | 1 | String | Tenant UUID |
1467 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1468 | networkName | M | 1 | string | Network name |
1469 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1470 | networkId | M | 1 | string | Network Id |
1471 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1472 | subnetName | M | 1 | string | Subnet name |
1473 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1474 | subnetId | M | 1 | string | SubnetId |
1475 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1476 | macAddress | O | 1 | string | Mac address |
1477 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1478 | ip | O | 1 | string | Ip address |
1479 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1480 | vnicType | O | 1 | string | Virtual network card type, |
1482 | | | | | the value of three kinds of normal/direct/macvtap |
1483 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1484 | securityGroups | O | 1 | string | **List of security group names.** |
1485 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1495 1. \ **Server Management**
1497 1. \ **Create Server**
1499 +---------------------+--------------------------------------------------------------------------------+
1500 | **IF Definition** | **Description** |
1501 +=====================+================================================================================+
1502 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1503 +---------------------+--------------------------------------------------------------------------------+
1504 | Operation | POST |
1505 +---------------------+--------------------------------------------------------------------------------+
1506 | Direction | VNFLCM->MULTIVIM |
1507 +---------------------+--------------------------------------------------------------------------------+
1511 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1512 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1513 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1514 | name | M | 1 | string | server name |
1515 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1516 | boot | M | 1 | String | Start parameters |
1517 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1518 | nicArray | O | 1..n | List of nic | List of nic |
1519 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1520 | contextArray | O | 1..n | list of context | list of context |
1521 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1522 | volumeArray | O | 1..n | list of volume | list of volume |
1523 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1524 | availabilityZone | O | 1 | string | Usable field |
1525 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1526 | flavorId | M | 1 | String | server Flavor id |
1527 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1528 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1529 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1530 | userdata | O | 1 | string | Configuration information or scripts to use upon launch. Must be Base64 encoded. |
1532 | | | | | 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. |
1533 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1534 | **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.** |
1535 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1536 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1537 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1541 +-----------------+-----------------+-------------------+---------------+---------------------------+
1542 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1543 +=================+=================+===================+===============+===========================+
1544 | type | M | 1 | int | Startup mode |
1546 | | | | | 1. boot from the volume |
1548 | | | | | 2. boot from image |
1549 +-----------------+-----------------+-------------------+---------------+---------------------------+
1550 | volumeId | O | 1 | string | Volume Id(type=1) |
1551 +-----------------+-----------------+-------------------+---------------+---------------------------+
1552 | imageId | O | 1 | String | ImageId(type=2) |
1553 +-----------------+-----------------+-------------------+---------------+---------------------------+
1557 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1558 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1559 +=================+=================+===================+===============+===========================================================================================================================================================+
1560 | fileName | M | 1 | String | Injection file name |
1561 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1562 | 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. ) |
1563 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1567 +-----------------+-----------------+-------------------+---------------+-------------------+
1568 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1569 +=================+=================+===================+===============+===================+
1570 | volumeId | M | 1 | String | Volume Id |
1571 +-----------------+-----------------+-------------------+---------------+-------------------+
1575 +-----------------+-----------------+-------------------+---------------+-------------------+
1576 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1577 +=================+=================+===================+===============+===================+
1578 | portId | M | 1 | String | Port Id |
1579 +-----------------+-----------------+-------------------+---------------+-------------------+
1583 +-----------------+-----------------+-------------------+---------------+-------------------+
1584 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1585 +=================+=================+===================+===============+===================+
1586 | keyName | M | 1 | String | Key name |
1587 +-----------------+-----------------+-------------------+---------------+-------------------+
1588 | value | M | 1 | string | value |
1589 +-----------------+-----------------+-------------------+---------------+-------------------+
1593 "tenant": "tenant1",
1597 “availabilityZone”:”az1”,
1599 “flavorName”:”vm\_large”,
1605 " volumeName": "volume1"
1609 “flavorId”:”vm\_large\_134213”
1613 "fileName": "test.yaml",
1621 "volumeName": "vol1",
1635 "value": "foo value”
1639 “userdata”:”abcdedf”
1645 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1646 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1647 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1648 | vimId | M | 1 | String | vim id |
1649 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1650 | vimName | O | 1 | string | vim name |
1651 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1652 | returnCode | | 1 | int | 0: Already exist 1: Newly created |
1653 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1654 | id | M | 1 | string | server id |
1655 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1656 | name | | 1 | string | server name |
1657 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1658 | tenantId | M | 1 | String | Tenant UUID |
1659 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1660 | boot | M | 1 | String | Start parameters |
1661 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1662 | nicArray | O | 1..n | List of nic | List of nic |
1663 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1664 | volumeArray | O | 1..n | list of volume | list of volume |
1665 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1666 | availabilityZone | O | 1 | string | Usable field |
1667 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1668 | flavorId | M | 1 | String | server Flavor |
1669 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1670 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1671 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1672 | **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.** |
1674 | | | | | **[TBD]** |
1675 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1676 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1679 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1680 | **status** | **M** | **1** | **string** | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR |
1681 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1689 "id": "3c9eebdbbfd345658269340b9ea6fb73",
1697 1. \ **Delete Server**
1699 +---------------------+-------------------------------------------------------------------------------------------+
1700 | **IF Definition** | **Description** |
1701 +=====================+===========================================================================================+
1702 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1703 +---------------------+-------------------------------------------------------------------------------------------+
1704 | Operation | DELETE |
1705 +---------------------+-------------------------------------------------------------------------------------------+
1706 | Direction | NFLCM,NSLCM->MULTIVIM |
1707 +---------------------+-------------------------------------------------------------------------------------------+
1717 1. \ **List Server**
1719 +---------------------+--------------------------------------------------------------------------------+
1720 | **IF Definition** | **Description** |
1721 +=====================+================================================================================+
1722 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1723 +---------------------+--------------------------------------------------------------------------------+
1725 +---------------------+--------------------------------------------------------------------------------+
1726 | Direction | NFLCM,NSLCM->MULTIVIM |
1727 +---------------------+--------------------------------------------------------------------------------+
1731 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1733 +-----------------+-----------------+-------------------+---------------+-------------------+
1734 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1735 +=================+=================+===================+===============+===================+
1736 | name | M | 1 | string | server name |
1737 +-----------------+-----------------+-------------------+---------------+-------------------+
1741 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1742 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1743 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1744 | vimId | M | 1 | String | vim id |
1745 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1746 | vimName | O | 1 | string | vim name |
1747 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1748 | servers | M | 1 | array | server list |
1749 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1750 | id | M | 1 | string | server id |
1751 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1752 | name | M | 1 | string | server name |
1753 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1754 | tenantId | M | 1 | String | Tenant UUID |
1755 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1756 | boot | M | 1 | String | Start parameters |
1757 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1758 | nicArray | O | 1..n | List of nic | List of nic |
1759 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1760 | volumeArray | O | 1..n | list of volume | list of volume |
1761 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1762 | availabilityZone | O | 1 | string | Usable field |
1763 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1764 | flavorId | M | 1 | String | server Flavor |
1765 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1766 | metada | O | 1 | keypair | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1767 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1768 | **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.** |
1770 | | | | | **[TBD]** |
1771 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1772 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1775 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1787 +---------------------+-------------------------------------------------------------------------------------------+
1788 | **IF Definition** | **Description** |
1789 +=====================+===========================================================================================+
1790 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1791 +---------------------+-------------------------------------------------------------------------------------------+
1793 +---------------------+-------------------------------------------------------------------------------------------+
1794 | Direction | NFLCM,NSLCM->MULTIVIM |
1795 +---------------------+-------------------------------------------------------------------------------------------+
1803 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1804 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1805 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1806 | vimId | M | 1 | String | vim id |
1807 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1808 | vimName | O | 1 | string | vim name |
1809 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1810 | id | M | 1 | string | server id |
1811 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1812 | name | M | 1 | string | server name |
1813 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1814 | tenantId | M | 1 | String | Tenant UUID |
1815 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1816 | boot | M | 1 | String | Start parameters |
1817 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1818 | nicArray | O | 1..n | List of nic | List of nic |
1819 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1820 | volumeArray | O | 1..n | list of volume | list of volume |
1821 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1822 | availabilityZone | O | 1 | string | Usable field |
1823 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1824 | flavorId | M | 1 | String | server Flavor |
1825 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1826 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1827 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1828 | **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.** |
1830 | | | | | **[TBD]** |
1831 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1832 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1835 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1845 1. \ **Flavor Management**
1847 1. \ **Create Flavor**
1849 +---------------------+--------------------------------------------------------------------------------+
1850 | **IF Definition** | **Description** |
1851 +=====================+================================================================================+
1852 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors |
1853 +---------------------+--------------------------------------------------------------------------------+
1854 | Operation | POST |
1855 +---------------------+--------------------------------------------------------------------------------+
1856 | Direction | VNFLCM->MULTIVIM |
1857 +---------------------+--------------------------------------------------------------------------------+
1861 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1862 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1863 +=================+=================+===================+===============================+==============================================================================================================================+
1864 | name | M | 1 | string | Flavor Name |
1865 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1866 | vcpu | M | 1 | int | Virtual CPU number |
1867 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1868 | memory | M | 1 | int | Memory size |
1869 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1870 | disk | M | 1 | int | The size of the root disk |
1871 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1872 | ephemeral | O | 1 | int | The size of the ephemeral disk |
1873 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1874 | swap | O | 1 | int | The size of the swap disk |
1875 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1876 | 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. |
1877 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1878 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1879 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1883 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1884 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1885 +=================+=================+===================+===========================+==============================================================================================================================+
1886 | id | M | 1 | string | Flavor id |
1887 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1888 | name | M | 1 | string | Flavor name |
1889 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1890 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1891 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1892 | tenantId | M | 1 | String | Tenant UUID |
1893 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1894 | vcpu | M | 1 | int | Virtual CPU number |
1895 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1896 | memory | M | 1 | int | Memory size |
1897 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1898 | disk | M | 1 | int | The size of the root disk |
1899 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1900 | ephemeral | M | 1 | int | The size of the ephemeral disk |
1901 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1902 | swap | M | 1 | int | The size of the swap disk |
1903 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1904 | 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. |
1905 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1906 | extraSpecs | O | 0..N | List of Key-value pairs | EPA parameter |
1907 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1908 | vimId | M | 1 | String | vim id |
1909 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1910 | vimName | O | 1 | string | vim name |
1911 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1913 1. \ **Delete Flavor**
1915 +---------------------+--------------------------------------------------------------------------------------------+
1916 | **IF Definition** | **Description** |
1917 +=====================+============================================================================================+
1918 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid} |
1919 +---------------------+--------------------------------------------------------------------------------------------+
1920 | Operation | DELETE |
1921 +---------------------+--------------------------------------------------------------------------------------------+
1922 | Direction | NFLCM,NSLCM->MULTIVIM |
1923 +---------------------+--------------------------------------------------------------------------------------------+
1933 1. \ **List Flavor**
1935 +---------------------+---------------------------------------------------------------------------------+
1936 | **IF Definition** | **Description** |
1937 +=====================+=================================================================================+
1938 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors |
1939 +---------------------+---------------------------------------------------------------------------------+
1941 +---------------------+---------------------------------------------------------------------------------+
1942 | Direction | NFLCM,NSLCM->MULTIVIM |
1943 +---------------------+---------------------------------------------------------------------------------+
1947 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1948 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1949 +=================+=================+===================+===============+==================================+
1950 | name | M | 1 | string | Flavor name to filter out list |
1951 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1955 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1956 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1957 +=================+=================+===================+===============================+==============================================================================================================================+
1958 | flavors | M | 0..N | list | Vm list |
1959 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1960 | id | M | 1 | string | Flavor id |
1961 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1962 | name | M | 1 | string | Flavor Name |
1963 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1964 | vcpu | M | 1 | int | Virtual CPU number |
1965 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1966 | memory | M | 1 | int | Memory size |
1967 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1968 | disk | M | 1 | int | The size of the root disk |
1969 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1970 | ephemeral | M | 1 | int | The size of the ephemeral disk |
1971 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1972 | swap | M | 1 | int | The size of the swap disk |
1973 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1974 | 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. |
1975 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1976 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1977 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1978 | vimId | M | 1 | String | vim id |
1979 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1980 | vimName | O | 1 | string | vim name |
1981 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1982 | tenantId | M | 1 | String | Tenant UUID |
1983 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1991 +---------------------+----------------------------------------------------------------------------------------------+
1992 | **IF Definition** | **Description** |
1993 +=====================+==============================================================================================+
1994 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid } |
1995 +---------------------+----------------------------------------------------------------------------------------------+
1997 +---------------------+----------------------------------------------------------------------------------------------+
1998 | Direction | NFLCM,NSLCM->MULTIVIM |
1999 +---------------------+----------------------------------------------------------------------------------------------+
2007 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2008 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2009 +=================+=================+===================+===============================+==============================================================================================================================+
2010 | id | M | 1 | string | Flavor id |
2011 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2012 | name | M | 1 | string | Flavor Name |
2013 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2014 | vcpu | M | 1 | int | Virtual CPU number |
2015 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2016 | memory | M | 1 | int | Memory size |
2017 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2018 | disk | M | 1 | int | The size of the root disk |
2019 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2020 | ephemeral | M | 1 | int | The size of the ephemeral disk |
2021 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2022 | swap | M | 1 | int | The size of the swap disk |
2023 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2024 | 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. |
2025 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2026 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
2027 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2028 | vimId | M | 1 | String | vim id |
2029 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2030 | vimName | O | 1 | string | vim name |
2031 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2032 | tenantId | M | 1 | String | Tenant UUID |
2033 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2039 1. \ **Volume Management**
2041 1. \ **Create Volume**
2043 +---------------------+--------------------------------------------------------------------------------+
2044 | **IF Definition** | **Description** |
2045 +=====================+================================================================================+
2046 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
2047 +---------------------+--------------------------------------------------------------------------------+
2048 | Operation | POST |
2049 +---------------------+--------------------------------------------------------------------------------+
2050 | Direction | NSLCM->MULTIVIM |
2051 +---------------------+--------------------------------------------------------------------------------+
2055 +--------------------+-----------------+-------------------+---------------+-------------------+
2056 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2057 +====================+=================+===================+===============+===================+
2058 | name | M | 1 | string | Volume name |
2059 +--------------------+-----------------+-------------------+---------------+-------------------+
2060 | volumeSize | M | 1 | int | Volume size |
2061 +--------------------+-----------------+-------------------+---------------+-------------------+
2062 | imageId | O | 1 | string | Image UUID |
2063 +--------------------+-----------------+-------------------+---------------+-------------------+
2064 | volumeType | O | 1 | string | Volume type |
2065 +--------------------+-----------------+-------------------+---------------+-------------------+
2066 | availabilityZone | O | 1 | string | Usable field |
2067 +--------------------+-----------------+-------------------+---------------+-------------------+
2071 "tenant": "tenant1",
2073 "volumeName": "volume1",
2077 "imageName": "cirros.qcow2",
2079 "volumeType": "volumetype1",
2081 "availabilityZone": "zone1"
2087 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2088 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2089 +====================+=================+===================+===============+=====================================+
2090 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
2091 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2092 | vimId | M | 1 | String | vim id |
2093 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2094 | vimName | O | 1 | string | vim name |
2095 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2096 | tenantId | M | 1 | String | Tenant UUID |
2097 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2098 | status | M | 1 | string | Volume status |
2099 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2100 | id | M | 1 | string | Volume id |
2101 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2102 | name | M | 1 | string | Volume name |
2103 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2104 | volumeType | O | 1 | string | Volume type |
2105 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2106 | availabilityZone | O | 1 | string | Availability Zone |
2107 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2115 "id": "bc9eebdbbfd356458269340b9ea6fb73",
2123 1. \ **Delete Volume**
2125 +---------------------+-------------------------------------------------------------------------------------------+
2126 | **IF Definition** | **Description** |
2127 +=====================+===========================================================================================+
2128 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId} |
2129 +---------------------+-------------------------------------------------------------------------------------------+
2130 | Operation | DELETE |
2131 +---------------------+-------------------------------------------------------------------------------------------+
2132 | Direction | NSLCM->MULTIVIM |
2133 +---------------------+-------------------------------------------------------------------------------------------+
2143 1. \ **List Volumes**
2145 +---------------------+--------------------------------------------------------------------------------+
2146 | **IF Definition** | **Description** |
2147 +=====================+================================================================================+
2148 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
2149 +---------------------+--------------------------------------------------------------------------------+
2151 +---------------------+--------------------------------------------------------------------------------+
2152 | Direction | NSLCM-> MULTIVIM |
2153 +---------------------+--------------------------------------------------------------------------------+
2157 msb.onap.org:80/api/multicloud/v0/{cloud
2158 owner}\_{region}/volumes?{……}
2160 +-----------------+-----------------+-------------------+---------------+-------------------+
2161 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2162 +=================+=================+===================+===============+===================+
2163 | name | M | 1 | string | Volume name |
2164 +-----------------+-----------------+-------------------+---------------+-------------------+
2168 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2169 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2170 +====================+=================+===================+======================+====================================================+
2171 | vimId | M | 1 | String | vim id |
2172 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2173 | vimName | O | 1 | string | vim name |
2174 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2175 | tenantId | M | 1 | String | Tenant UUID |
2176 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2177 | volumes | M | 1 | Array | |
2178 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2179 | id | M | 1 | string | Volume id |
2180 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2181 | name | M | 1 | string | Volume name |
2182 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2183 | createTime | O | 1 | string | Create time |
2184 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2185 | status | M | 1 | string | Volume status |
2186 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2187 | volumeSize | M | 1 | int | Volume size |
2188 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2189 | volumeType | M | 1 | string | Volume type |
2190 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2191 | availabilityZone | M | 1 | string | Availability Zone |
2192 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2193 | attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2194 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2206 "status": "available",
2212 "createTime": "2015-12-02T07:57:23.000000",
2214 " volumeType ": "ws",
2216 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2232 "device": "/dev/vdc",
2234 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2236 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2240 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2246 "createTime": "2015-12-02T06:39:40.000000",
2248 " volumeType ": null,
2250 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2260 1. \ **Get Volumes**
2262 +---------------------+-------------------------------------------------------------------------------------------+
2263 | **IF Definition** | **Description** |
2264 +=====================+===========================================================================================+
2265 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid} |
2266 +---------------------+-------------------------------------------------------------------------------------------+
2268 +---------------------+-------------------------------------------------------------------------------------------+
2269 | Direction | NSLCM-> MULTIVIM |
2270 +---------------------+-------------------------------------------------------------------------------------------+
2278 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2279 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2280 +====================+=================+===================+======================+====================================================+
2281 | vimId | M | 1 | String | vim id |
2282 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2283 | vimName | O | 1 | string | vim name |
2284 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2285 | tenantId | M | 1 | String | Tenant UUID |
2286 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2287 | id | | 1 | string | Volume id |
2288 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2289 | name | | 1 | string | Volume name |
2290 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2291 | createTime | | 1 | string | Create time |
2292 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2293 | status | | 1 | string | Volume status |
2294 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2295 | volumeType | | 1 | list of string | Volume type |
2296 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2297 | volumeSize | | 1 | int | Volume size |
2298 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2299 | availabilityZone | M | 1 | string | Availability Zone |
2300 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2301 | attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2302 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2306 +-----------------+-----------------+-------------------+---------------+-------------------+
2307 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2308 +=================+=================+===================+===============+===================+
2309 | device | | 1 | string | Device name |
2310 +-----------------+-----------------+-------------------+---------------+-------------------+
2311 | serverId | | 1 | string | VM id |
2312 +-----------------+-----------------+-------------------+---------------+-------------------+
2313 | volumeId | | 1 | string | Volume id |
2314 +-----------------+-----------------+-------------------+---------------+-------------------+
2315 | hostName | | 1 | string | Host name |
2316 +-----------------+-----------------+-------------------+---------------+-------------------+
2317 | id | | 1 | string | Device id |
2318 +-----------------+-----------------+-------------------+---------------+-------------------+
2334 "device": "/dev/vdc",
2336 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2338 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2342 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2348 "createTime": "2015-12-02T06:39:40.000000",
2350 "volumeType ": null,
2352 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2358 1. \ **Tenant Management**
2360 1. \ **List tenants**
2362 +---------------------+---------------------------------------------------------------------+
2363 | **IF Definition** | **Description** |
2364 +=====================+=====================================================================+
2365 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants |
2366 +---------------------+---------------------------------------------------------------------+
2368 +---------------------+---------------------------------------------------------------------+
2369 | Direction | NSLCM-> MULTIVIM |
2370 +---------------------+---------------------------------------------------------------------+
2374 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2375 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2376 +=====================+=================+===================+===============+=====================================+
2377 | name={tenantname} | O | 1 | string | Tenant name to filter output list |
2378 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2382 +-----------------+-----------------+-------------------+---------------+-------------------+
2383 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2384 +=================+=================+===================+===============+===================+
2385 | vimId | M | 1 | String | vim id |
2386 +-----------------+-----------------+-------------------+---------------+-------------------+
2387 | vimName | O | 1 | string | vim name |
2388 +-----------------+-----------------+-------------------+---------------+-------------------+
2389 | tenants | M | 1 | Array | |
2390 +-----------------+-----------------+-------------------+---------------+-------------------+
2391 | id | M | 1 | string | tenant UUID |
2392 +-----------------+-----------------+-------------------+---------------+-------------------+
2393 | name | M | 1 | string | tenant name |
2394 +-----------------+-----------------+-------------------+---------------+-------------------+
2418 1. \ **List Limits of resouces: CPU&Memory, volume,network,etc**
2420 +---------------------+-------------------------------------------------------------------------------+
2421 | **IF Definition** | **Description** |
2422 +=====================+===============================================================================+
2423 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits |
2424 +---------------------+-------------------------------------------------------------------------------+
2426 +---------------------+-------------------------------------------------------------------------------+
2427 | Direction | NSLCM-> MULTIVIM |
2428 +---------------------+-------------------------------------------------------------------------------+
2434 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2435 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2436 +===========================+=================+===================+===============+==================================================================+
2437 | vimId | M | 1 | String | vim id |
2438 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2439 | vimName | O | 1 | string | vim name |
2440 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2441 | tenantId | M | 1 | string | Tenant UUID |
2442 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2443 | maxPersonality | O | 1 | int | The number of allowed injected files for each tenant. |
2444 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2445 | maxPersonalitySize | O | 1 | int | The number of allowed bytes of content for each injected file. |
2446 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2447 | maxServerGroupMembers | O | 1 | int | The number of allowed members for each server group. |
2448 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2449 | maxServerGroups | O | 1 | int | The number of allowed server groups for each tenant. |
2450 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2451 | maxServerMeta | O | 1 | int | The number of allowed metadata items for each instance. |
2452 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2453 | maxTotalCores | O | 1 | int | The number of allowed instance cores for each tenant. |
2454 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2455 | maxTotalInstances | O | 1 | int | The number of allowed instances for each tenant. |
2456 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2457 | maxTotalKeypairs | O | 1 | int | The number of allowed key pairs for each user. |
2458 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2459 | maxTotalRAMSize | O | 1 | int | The amount of allowed instance RAM, in MB, for each tenant. |
2460 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2461 | maxTotalVolumeGigabytes | O | 1 | int | The maximum total amount of volumes, in gibibytes (GiB). |
2462 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2463 | maxTotalVolumes | O | 1 | int | The maximum number of volumes. |
2464 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2465 | totalVolumesUsed | O | 1 | int | The total number of volumes used. |
2466 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2467 | totalGigabytesUsed | O | 1 | int | The total number of gibibytes (GiB) used. |
2468 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2469 | network | O | 1 | int | The number of networks allowed for each project. |
2470 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2471 | subnet | O | 1 | int | The number of subnets allowed for each project. |
2472 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2473 | subnetpool | O | 1 | int | The number of subnet pools allowed for each project. |
2474 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2475 | security\_group\_rule | O | 1 | int | The number of security group rules allowed for each project. |
2476 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2477 | security\_group | O | 1 | int | The number of security groups allowed for each project. |
2478 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2479 | router | O | 1 | int | The number of routers allowed for each project. |
2480 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2481 | port | O | 1 | int | The number of ports allowed for each project. |
2482 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2490 "maxPersonality": 5,
2492 "maxPersonalitySize": 10240,
2494 "maxServerMeta": 128,
2496 "maxTotalCores": 20,
2498 "maxTotalInstances": 10,
2500 "maxTotalKeypairs": 100,
2502 "maxTotalRAMSize": 51200,
2504 "maxServerGroups": 10,
2506 "maxServerGroupMembers": 10,
2510 1. \ **Host Management**
2514 +---------------------+------------------------------------------------------------------------------+
2515 | **IF Definition** | **Description** |
2516 +=====================+==============================================================================+
2517 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts |
2518 +---------------------+------------------------------------------------------------------------------+
2520 +---------------------+------------------------------------------------------------------------------+
2521 | Direction | NSLCM-> MULTIVIM |
2522 +---------------------+------------------------------------------------------------------------------+
2528 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2529 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2530 +=================+=================+===================+=================+===================================+
2531 | vimId | M | 1 | String | vim id |
2532 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2533 | vimName | O | 1 | string | vim name |
2534 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2535 | tenantId | M | 1 | string | Tenant Name |
2536 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2537 | hosts | M | 1 | Array of host | List of host information |
2538 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2539 | service | M | 1 | string | The service running on the host |
2540 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2541 | name | M | 1 | string | host name |
2542 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2543 | zone | O | 1 | string | Available zone for the host |
2544 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2554 "vimName": "vimName",
2556 "tenantId": "tenantId1"
2562 "name": "b6e4adbc193d428ea923899d07fb001e",
2564 "service": "conductor",
2570 "vimName": "vimName",
2572 "tenantId": "tenantId1"
2578 "name": "09c025b0efc64211bd23fc50fa974cdf",
2580 "service": "compute",
2586 "vimName": "vimName",
2588 "tenantId": "tenantId1"
2594 "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2596 "service": "consoleauth",
2602 "vimName": "vimName",
2604 "tenantId": "tenantId1"
2610 "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2612 "service": "network",
2618 "vimName": "vimName",
2620 "tenantId": "tenantId1"
2626 "name": "abffda96592c4eacaf4111c28fddee17",
2628 "service": "scheduler",
2634 "vimName": "vimName",
2636 "tenantId": "tenantId1"
2646 +---------------------+-----------------------------------------------------------------------------------------+
2647 | **IF Definition** | **Description** |
2648 +=====================+=========================================================================================+
2649 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts/{hostname} |
2650 +---------------------+-----------------------------------------------------------------------------------------+
2652 +---------------------+-----------------------------------------------------------------------------------------+
2653 | Direction | NSLCM-> MULTIVIM |
2654 +---------------------+-----------------------------------------------------------------------------------------+
2660 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2661 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2662 +=================+=================+===================+=====================+==============================================================+
2663 | vimId | M | 1 | String | vim id |
2664 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2665 | vimName | O | 1 | string | vim name |
2666 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2667 | tenantId | M | 1 | string | Tenant Name |
2668 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2669 | host | M | 1 | List of resources | Host resource info |
2670 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2671 | resource | M | 1..N | Object | Resource description |
2672 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2673 | cpu | M | 1 | Int | The cpu info on the host. |
2674 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2675 | memory\_mb | M | 1 | int | The memory info on the host (in MB). |
2676 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2677 | name | M | 1 | string | host name |
2678 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2679 | project | M | 1 | string | Value: total, used\_now, used\_max or specific project\_id |
2680 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2681 | disk\_gb | M | 1 | int | The disk info on the host (in GB). |
2682 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2694 "name": "c1a7de0ac9d94e4baceae031d05caae3",
2700 "vimName": "vimName",
2702 "tenantId": "tenantId1"
2714 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2718 "project": "(total)",
2728 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2732 "project": "(used\_now)",
2742 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2746 "project": "(used\_max)",
2756 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2760 "project": "568f7ec425db472ba348251bf1e7eebd",
2768 "vimName": "openstack\_newton",
2770 "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2772 "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2776 1. \ **VIM Management**
2778 1. \ **Update VIM Info**
2780 +---------------------+----------------------------------------------------------------------------------------------+
2781 | **IF Definition** | **Description** |
2782 +=====================+==============================================================================================+
2783 | URI | http(s)://[hostname][:port]/onapapi/ multicloud /v1/{cloud-owner}\_{cloud-region}/registry |
2784 +---------------------+----------------------------------------------------------------------------------------------+
2785 | Operation | POST |
2786 +---------------------+----------------------------------------------------------------------------------------------+
2787 | Direction | ESR-> MULTICLOUD |
2788 +---------------------+----------------------------------------------------------------------------------------------+
2792 +-----------------+-----------------+-------------------+---------------+-----------------------+
2793 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2794 +=================+=================+===================+===============+=======================+
2795 | defaultTenant | M | 1 | string | default tenant name |
2796 +-----------------+-----------------+-------------------+---------------+-----------------------+
2806 1. \ **Unregistry VIM**
2808 +---------------------+-----------------------------------------------------------------------------------------------+
2809 | **IF Definition** | **Description** |
2810 +=====================+===============================================================================================+
2811 | URI | http(s)://[hostname][:port]/onapapi/multicloud/v1 /{cloud-owner}\_{cloud-region}/unregistry |
2812 +---------------------+-----------------------------------------------------------------------------------------------+
2813 | Operation | DELETE |
2814 +---------------------+-----------------------------------------------------------------------------------------------+
2815 | Direction | ESR-> MULTICLOUD |
2816 +---------------------+-----------------------------------------------------------------------------------------------+
2826 204: No content found