2 This work is licensed under a Creative Commons Attribution 4.0
5 ================================
6 MultiCloud API v0 Specification
7 ================================
15 The scope of the present document is to describe the VIM Driver API
18 2. **Terms, Definitions and Abbreviations**
19 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
21 For the purposes of the present document, the following abbreviations
24 +--------------------+-------------------------------------------------------------+
25 | **Abbreviation** | |
26 +====================+=============================================================+
27 | NFVO | Network Functions Virtualization Orchestrator |
28 +--------------------+-------------------------------------------------------------+
29 | VNFM | Virtual Network Function Management |
30 +--------------------+-------------------------------------------------------------+
31 | VIM | Virtualized Infrastructure Manager |
32 +--------------------+-------------------------------------------------------------+
33 | MultiVIM | MultVIM driver services for OPEN-O to drive VIM instances |
34 +--------------------+-------------------------------------------------------------+
36 3. **Image Management**
37 ^^^^^^^^^^^^^^^^^^^^^^^
42 +---------------------+-------------------------------------------------------------------------------+
43 | **IF Definition** | **Description** |
44 +=====================+===============================================================================+
45 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images |
46 +---------------------+-------------------------------------------------------------------------------+
48 +---------------------+-------------------------------------------------------------------------------+
49 | Direction | NSLCM->MULTIVIM |
50 +---------------------+-------------------------------------------------------------------------------+
51 | Description | Create Image and Upload the image file to the VIM |
52 +---------------------+-------------------------------------------------------------------------------+
57 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
58 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
59 +===================+=================+===================+===========================+==================================================================================================+
60 | name | M | 1 | String | Image Name |
61 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
62 | imagePath | M | 1 | String | Image Local Path from catalog |
63 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
64 | imageType | M | 1 | String | Image Type |
66 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
67 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
68 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
69 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
70 | visibility | O | 1 | string | Visibility for this image. |
72 | | | | | public, private, shared, or community |
73 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
74 | properties | O | 0..N | List of key-value pairs | Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic" |
75 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
81 "imageName": "cirros",
83 "imagePath": "/home/cirros.qcow2",
87 "containerFormat":"bare"
94 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
95 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
96 +===================+=================+===================+===========================+========================================================+
97 | id | M | 1 | String | Image UUID in the VIM |
98 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
99 | name | M | 1 | String | Image Name |
100 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
101 | returnCode | M | 1 | Int | 0: Already exist 1: Newly created |
102 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
103 | imageType | M | 1 | String | Image Type |
105 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
106 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
107 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
108 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
109 | visibility | O | 1 | string | Visibility for this image. |
111 | | | | | public, private, shared, or community |
112 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
113 | properties | O | 0..N | List of key-value pairs | |
114 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
115 | vimid | M | 1 | String | vim id |
116 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
117 | vimName | O | 1 | string | vim name |
118 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
119 | tenantId | M | 1 | String | Tenant UUID |
120 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
129 "id": "3c9eebdbbfd345658269340b9ea6fb73",
134 3.2. **Delete Image**
135 ---------------------
137 +---------------------+-----------------------------------------------------------------------------------------+
138 | **IF Definition** | **Description** |
139 +=====================+=========================================================================================+
140 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images/{imageId} |
141 +---------------------+-----------------------------------------------------------------------------------------+
142 | Operation | Delete |
143 +---------------------+-----------------------------------------------------------------------------------------+
144 | Direction | NSLCM->MULTIVIM |
145 +---------------------+-----------------------------------------------------------------------------------------+
146 | Description | Delete Image |
147 +---------------------+-----------------------------------------------------------------------------------------+
162 +---------------------+-------------------------------------------------------------------------------+
163 | **IF Definition** | **Description** |
164 +=====================+===============================================================================+
165 | URI | msb.onap.org:80/api/multicloud/v0/{cloud_owner}\_{region}/{tenantid}/images |
166 +---------------------+-------------------------------------------------------------------------------+
168 +---------------------+-------------------------------------------------------------------------------+
169 | Direction | NSLCM->MULTIVIM |
170 +---------------------+-------------------------------------------------------------------------------+
171 | Description | Query Image list |
172 +---------------------+-------------------------------------------------------------------------------+
177 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
178 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
179 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
180 | 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. |
181 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
182 | 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. |
183 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
184 | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of an image |
185 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
190 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
191 | \ **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
192 +=================================================+=================+===================+===============+========================================================+
193 | images | M | 0..N | List | Image List |
194 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
195 | id | M | 1 | String | Image ID |
196 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
197 | size | M | 1 | int | Image Size |
198 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
199 | name | M | 1 | String | Image Name |
200 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
201 | status | M | 1 | String | Image Status |
202 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
203 | imageType | M | 1 | String | Image Type |
205 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
206 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
207 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
208 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
209 | visibility | O | 1 | string | Visibility for this image. |
211 | | | | | public, private, shared, or community |
212 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
213 | vimId | M | 1 | String | vim id |
214 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
215 | vimName | O | 1 | string | vim name |
216 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
217 | tenantId | M | 1 | String | Tenant UUID |
218 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
231 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
233 "name": "vim-plus-cgsl40g-z.qcow2"
241 +---------------------+-----------------------------------------------------------------------------------------+
242 | **IF Definition** | **Description** |
243 +=====================+=========================================================================================+
244 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid} |
245 +---------------------+-----------------------------------------------------------------------------------------+
247 +---------------------+-----------------------------------------------------------------------------------------+
248 | Direction | NSLCM->MULTIVIM |
249 +---------------------+-----------------------------------------------------------------------------------------+
250 | Description | Query Image Information |
251 +---------------------+-----------------------------------------------------------------------------------------+
261 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
262 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
263 +===================+=================+===================+===============+========================================================+
264 | id | M | 1 | String | Image ID |
265 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
266 | size | M | 1 | int | Image Size |
267 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
268 | name | M | 1 | String | Image Name |
269 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
270 | status | M | 1 | String | Image Status |
271 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
272 | imageType | M | 1 | String | Image Type |
274 | | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
275 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
276 | containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova, docker |
277 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
278 | visibility | O | 1 | string | Visibility for this image. |
280 | | | | | public, private, shared, or community |
281 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
282 | vimId | M | 1 | String | vim id |
283 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
284 | vimName | M | 1 | string | vim name |
285 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
286 | tenantId | M | 1 | String | Tenant UUID |
287 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
299 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
301 "name": "vim-plus-cgsl40g-z.qcow2"
304 4. **Network Management**
305 ^^^^^^^^^^^^^^^^^^^^^^^^^
307 4.1. **Create Network**
308 -----------------------
310 +---------------------+---------------------------------------------------------------------------------+
311 | **IF Definition** | **Description** |
312 +=====================+=================================================================================+
313 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
314 +---------------------+---------------------------------------------------------------------------------+
316 +---------------------+---------------------------------------------------------------------------------+
317 | Direction | VNFLCM,NSLCM->MULTIVIM |
318 +---------------------+---------------------------------------------------------------------------------+
319 | Description | Create network and subnetwork on the VIM |
320 +---------------------+---------------------------------------------------------------------------------+
325 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
326 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
327 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
328 | name | M | 1 | String | Logical network name |
329 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
330 | shared | M | 1 | boolean | Whether to share(1:sharing;0:private) |
331 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
332 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
333 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
334 | networkType | O | 1 | String | Network type |
336 | | | | | flat, vlan, vxlan, gre, |
338 | | | | | portgroup |
339 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
340 | segmentationId | O | 1 | Int | id of paragraph |
341 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
342 | 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. |
343 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
344 | routerExternal | O | 1 | boolean |Indicates whether this network can provide floating IPs via a router. |
345 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
351 "networkName": "ommnet",
353 "vlanTransparent": 1,
354 "networkType": "vlan",
355 "segmentationId": 202,
356 "physicalNetwork": "ctrl",
363 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
364 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
365 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
366 | status | M | 1 | string | Network status |
367 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
368 | id | M | 1 | string | Network id |
369 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
370 | name | M | 1 | string | Network name |
371 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
372 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
373 | tenantId | M | 1 | String | Tenant UUID |
374 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
375 | segmentationId | O | 1 | int | Segmentation id |
376 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
377 | networkType | O | 1 | string | Network type |
378 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
379 | 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. |
380 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
381 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
382 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
383 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
384 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
385 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
386 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
387 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
388 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
389 | vimId | M | 1 | String | vim id |
390 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
391 | vimName | O | 1 | string | vim name |
392 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
405 "id": "3c9eebdbbfd345658269340b9ea6fb73",
408 "networkName": "ommnet",
410 "vlanTransparent": 1,
411 "networkType": "vlan",
412 "segmentationId": 202,
413 "physicalNetwork": "ctrl",
417 4.2. **Delete Network**
418 -----------------------
420 +---------------------+---------------------------------------------------------------------------------------------+
421 | **IF Definition** | **Description** |
422 +=====================+=============================================================================================+
423 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
424 +---------------------+---------------------------------------------------------------------------------------------+
425 | Operation | Delete |
426 +---------------------+---------------------------------------------------------------------------------------------+
427 | Direction | NFLCM,NSLCM->MULTIVIM |
428 +---------------------+---------------------------------------------------------------------------------------------+
440 4.3. **List Network**
441 ---------------------
443 +---------------------+---------------------------------------------------------------------------------+
444 | **IF Definition** | **Description** |
445 +=====================+=================================================================================+
446 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
447 +---------------------+---------------------------------------------------------------------------------+
449 +---------------------+---------------------------------------------------------------------------------+
450 | Direction | NFLCM,NSLCM->MULTIVIM |
451 +---------------------+---------------------------------------------------------------------------------+
456 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
457 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
458 +=================+=================+===================+===============+=======================================================================================+
459 | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of a network |
460 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
465 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
466 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
467 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
468 | vimId | M | 1 | String | vim id |
469 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
470 | vimName | O | 1 | string | vim name |
471 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
472 | networks | | 0..N | List | Network list |
473 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
474 | status | M | 1 | string | Network status |
475 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
476 | id | M | 1 | string | Network id |
477 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
478 | name | M | 1 | string | Network name |
479 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
480 | tenantId | M | 1 | String | Tenant UUID |
481 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
482 | segmentationId | O | 1 | int | Segmentation id |
483 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
484 | networkType | O | 1 | string | Network type |
485 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
486 | 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. |
487 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
488 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
489 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
490 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
491 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
492 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
493 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
513 "id": "3c9eebdbbfd345658269340b9ea6fb73",
519 "networkName": "ommnet",
523 "vlanTransparent": 1,
525 "networkType": "vlan",
527 "segmentationId": 202,
529 "physicalNetwork ": "ctrl",
540 +---------------------+---------------------------------------------------------------------------------------------+
541 | **IF Definition** | **Description** |
542 +=====================+=============================================================================================+
543 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
544 +---------------------+---------------------------------------------------------------------------------------------+
546 +---------------------+---------------------------------------------------------------------------------------------+
547 | Direction | NFLCM,NSLCM->MULTIVIM |
548 +---------------------+---------------------------------------------------------------------------------------------+
558 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
559 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
560 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
561 | status | M | 1 | string | Network status |
562 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
563 | id | M | 1 | string | Network id |
564 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
565 | name | M | 1 | string | Network name |
566 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
567 | tenantId | M | 1 | String | Tenant UUID |
568 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
569 | segmentationId | O | 1 | int | Segmentation id |
570 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
571 | networkType | O | 1 | string | Network type |
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 | vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
576 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
577 | shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
578 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
579 | routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
580 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
581 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
582 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
583 | vimId | M | 1 | String | vim id |
584 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
585 | vimName | O | 1 | string | vim name |
586 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
602 "id": "3c9eebdbbfd345658269340b9ea6fb73",
608 "networkName": "ommnet",
612 "vlanTransparent": 1,
614 "networkType":"vlan",
616 "segmentationId":202,
618 "physicalNetwork ":"ctrl",
624 5. **Subnetwork Management**
625 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
627 5.1. **Create Subnets**
628 -----------------------
630 +---------------------+--------------------------------------------------------------------------------+
631 | **IF Definition** | **Description** |
632 +=====================+================================================================================+
633 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
634 +---------------------+--------------------------------------------------------------------------------+
636 +---------------------+--------------------------------------------------------------------------------+
637 | Direction | VNFLCM,NSLCM->MULTIVIM |
638 +---------------------+--------------------------------------------------------------------------------+
639 | Description | Create network and subnetwork on the VIM |
640 +---------------------+--------------------------------------------------------------------------------+
645 +-------------------+-----------------+-------------------+------------------------+----------------------+
646 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
647 +===================+=================+===================+========================+======================+
648 | networkId | M | 1 | String | Network Id |
649 +-------------------+-----------------+-------------------+------------------------+----------------------+
650 | name | M | 1 | String | SubnetName |
651 +-------------------+-----------------+-------------------+------------------------+----------------------+
652 | cidr | M | 1 | String | Subnet cidr |
653 +-------------------+-----------------+-------------------+------------------------+----------------------+
654 | ipVersion | M | 1 | Int | Ip type |
657 +-------------------+-----------------+-------------------+------------------------+----------------------+
658 | enableDhcp | O | 1 | boolean | Whether to allow |
660 | | | | | 1: yes;0: no |
661 +-------------------+-----------------+-------------------+------------------------+----------------------+
662 | gatewayIp | O | 1 | String | Gateway ip |
663 +-------------------+-----------------+-------------------+------------------------+----------------------+
664 | dnsNameservers | O | 1..n | List of servers | List of servers |
665 +-------------------+-----------------+-------------------+------------------------+----------------------+
666 | hostRoutes | O | 1..n | List of routes | List of routes |
667 +-------------------+-----------------+-------------------+------------------------+----------------------+
668 | allocationPools | O | 1..n | list of "allocation" | list of allocation |
669 +-------------------+-----------------+-------------------+------------------------+----------------------+
670 | -->allocation | | | | |
671 +-------------------+-----------------+-------------------+------------------------+----------------------+
672 | -->start | O | 1 | String | Start ip |
673 +-------------------+-----------------+-------------------+------------------------+----------------------+
674 | -->end | O | 1 | String | End ip |
675 +-------------------+-----------------+-------------------+------------------------+----------------------+
683 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
685 "subnetName": "subnet1",
687 "cidr": "10.43.35.0/24",
693 "gatewayIp": "10.43.35.1",
695 "dnsNameservers": [],
697 "allocationPools": [{
699 "start": "192.168.199.2",
701 "end": "192.168.199.254"
712 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
713 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
714 +===================+=================+===================+========================+=====================================+
715 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
716 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
717 | vimId | M | 1 | String | vim id |
718 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
719 | vimName | O | 1 | string | vim name |
720 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
721 | status | M | 1 | string | subnetwork status |
722 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
723 | id | M | 1 | string | subNetwork id |
724 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
725 | tenantId | M | 1 | String | Tenant UUID |
726 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
727 | networkId | O | 1 | String | Network Id |
728 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
729 | networkName | O | 1 | String | Network Name |
730 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
731 | name | M | 1 | String | SubnetName |
732 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
733 | cidr | M | 1 | String | Subnet cidr |
734 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
735 | ipVersion | M | 1 | Int | Ip type |
738 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
739 | enableDhcp | O | 1 | boolean | Whether to allow |
741 | | | | | 1: yes;0: no |
742 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
743 | gatewayIp | O | 1 | String | Gateway ip |
744 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
745 | dnsNameservers | O | 1..n | List of servers | List of servers |
746 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
747 | hostRoutes | O | 1..n | List of routes | List of routes |
748 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
749 | allocationPools | O | 1..n | list of "allocation" | list of allocation |
750 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
751 | -->allocation | | | | |
752 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
753 | -->start | O | 1 | String | Start ip |
754 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
755 | -->end | O | 1 | String | End ip |
756 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
774 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
778 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
782 "cidr": "10.43.35.0/24",
788 "gatewayIp": "10.43.35.1",
790 "dnsNameservers": [],
792 "allocationPools": [{
794 "start": "192.168.199.2",
796 "end": "192.168.199.254"
804 5.2. **Delete Subnets**
805 -----------------------
807 +---------------------+-------------------------------------------------------------------------------------------+
808 | **IF Definition** | **Description** |
809 +=====================+===========================================================================================+
810 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId} |
811 +---------------------+-------------------------------------------------------------------------------------------+
812 | Operation | Delete |
813 +---------------------+-------------------------------------------------------------------------------------------+
814 | Direction | NFLCM,NSLCM->MULTIVIM |
815 +---------------------+-------------------------------------------------------------------------------------------+
827 5.3. **List Subnets**
828 ---------------------
830 +---------------------+--------------------------------------------------------------------------------+
831 | **IF Definition** | **Description** |
832 +=====================+================================================================================+
833 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
834 +---------------------+--------------------------------------------------------------------------------+
836 +---------------------+--------------------------------------------------------------------------------+
837 | Direction | NFLCM,NSLCM->MULTIVIM |
838 +---------------------+--------------------------------------------------------------------------------+
843 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
845 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
846 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
847 +=================+=================+===================+===============+================================================================================================+
848 | name | O | 1 | String | Filters fields of the response by a name, as a string. A valid value is the name of a subnet |
849 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
854 +-------------------+-----------------+-------------------+------------------------+----------------------+
855 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
856 +===================+=================+===================+========================+======================+
857 | vimId | M | 1 | String | vim id |
858 +-------------------+-----------------+-------------------+------------------------+----------------------+
859 | vimName | O | 1 | string | vim name |
860 +-------------------+-----------------+-------------------+------------------------+----------------------+
861 | subnets | M | 0..N | List | Network list |
862 +-------------------+-----------------+-------------------+------------------------+----------------------+
863 | status | | 1 | string | subnetwork status |
864 +-------------------+-----------------+-------------------+------------------------+----------------------+
865 | id | | 1 | string | subNetwork id |
866 +-------------------+-----------------+-------------------+------------------------+----------------------+
867 | tenantId | M | 1 | String | Tenant UUID |
868 +-------------------+-----------------+-------------------+------------------------+----------------------+
869 | networkId | O | 1 | String | Network Id |
870 +-------------------+-----------------+-------------------+------------------------+----------------------+
871 | networkName | O | 1 | String | Network Name |
872 +-------------------+-----------------+-------------------+------------------------+----------------------+
873 | name | M | 1 | String | SubnetName |
874 +-------------------+-----------------+-------------------+------------------------+----------------------+
875 | cidr | M | 1 | String | Subnet cidr |
876 +-------------------+-----------------+-------------------+------------------------+----------------------+
877 | ipVersion | M | 1 | Int | Ip type |
880 +-------------------+-----------------+-------------------+------------------------+----------------------+
881 | enableDhcp | O | 1 | boolean | Whether to allow |
883 | | | | | 1: yes;0: no |
884 +-------------------+-----------------+-------------------+------------------------+----------------------+
885 | gatewayIp | O | 1 | String | Gateway ip |
886 +-------------------+-----------------+-------------------+------------------------+----------------------+
887 | dnsNameservers | O | 1..n | List of servers | List of servers |
888 +-------------------+-----------------+-------------------+------------------------+----------------------+
889 | hostRoutes | O | 1..n | List of routes | List of routes |
890 +-------------------+-----------------+-------------------+------------------------+----------------------+
891 | allocationPools | O | 1..n | list of "allocation" | list of allocation |
892 +-------------------+-----------------+-------------------+------------------------+----------------------+
893 | -->allocation | | | | |
894 +-------------------+-----------------+-------------------+------------------------+----------------------+
895 | -->start | O | 1 | String | Start ip |
896 +-------------------+-----------------+-------------------+------------------------+----------------------+
897 | -->end | O | 1 | String | End ip |
898 +-------------------+-----------------+-------------------+------------------------+----------------------+
918 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
922 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
926 "cidr": "10.43.35.0/24",
932 "gatewayIp": "10.43.35.1",
934 "dnsNameservers": [],
936 "allocationPools": [{
938 "start": "192.168.199.2",
940 "end": "192.168.199.254"
955 +---------------------+-------------------------------------------------------------------------------------------+
956 | **IF Definition** | **Description** |
957 +=====================+===========================================================================================+
958 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid} |
959 +---------------------+-------------------------------------------------------------------------------------------+
961 +---------------------+-------------------------------------------------------------------------------------------+
962 | Direction | NFLCM,NSLCM->MULTIVIM |
963 +---------------------+-------------------------------------------------------------------------------------------+
973 +-------------------+-----------------+-------------------+------------------------+----------------------+
974 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
975 +===================+=================+===================+========================+======================+
976 | vimId | M | 1 | String | vim id |
977 +-------------------+-----------------+-------------------+------------------------+----------------------+
978 | vimName | O | 1 | string | vim name |
979 +-------------------+-----------------+-------------------+------------------------+----------------------+
980 | status | | 1 | string | subnetwork status |
981 +-------------------+-----------------+-------------------+------------------------+----------------------+
982 | id | | 1 | string | subNetwork id |
983 +-------------------+-----------------+-------------------+------------------------+----------------------+
984 | tenantId | M | 1 | String | Tenant UUID |
985 +-------------------+-----------------+-------------------+------------------------+----------------------+
986 | networkId | O | 1 | String | Network Id |
987 +-------------------+-----------------+-------------------+------------------------+----------------------+
988 | networkName | O | 1 | String | Network Name |
989 +-------------------+-----------------+-------------------+------------------------+----------------------+
990 | name | M | 1 | String | SubnetName |
991 +-------------------+-----------------+-------------------+------------------------+----------------------+
992 | cidr | M | 1 | String | Subnet cidr |
993 +-------------------+-----------------+-------------------+------------------------+----------------------+
994 | ipVersion | M | 1 | Int | Ip type |
997 +-------------------+-----------------+-------------------+------------------------+----------------------+
998 | enableDhcp | O | 1 | boolean | Whether to allow |
1000 | | | | | 1: yes;0: no |
1001 +-------------------+-----------------+-------------------+------------------------+----------------------+
1002 | gatewayIp | O | 1 | String | Gateway ip |
1003 +-------------------+-----------------+-------------------+------------------------+----------------------+
1004 | dnsNameservers | O | 1..n | List of servers | List of servers |
1005 +-------------------+-----------------+-------------------+------------------------+----------------------+
1006 | hostRoutes | O | 1..n | List of routes | List of routes |
1007 +-------------------+-----------------+-------------------+------------------------+----------------------+
1008 | allocationPools | O | 1..n | list of "allocation" | list of allocation |
1009 +-------------------+-----------------+-------------------+------------------------+----------------------+
1010 | -->allocation | | | | |
1011 +-------------------+-----------------+-------------------+------------------------+----------------------+
1012 | -->start | O | 1 | String | Start ip |
1013 +-------------------+-----------------+-------------------+------------------------+----------------------+
1014 | -->end | O | 1 | String | End ip |
1015 +-------------------+-----------------+-------------------+------------------------+----------------------+
1025 "status": " ACTIVE",
1027 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
1029 "tenant": "tenant1",
1031 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
1035 "cidr": "10.43.35.0/24",
1041 "gatewayIp": "10.43.35.1",
1043 "dnsNameservers": [],
1045 "allocationPools": [{
1047 "start": "192.168.199.2",
1049 "end": "192.168.199.254"
1060 6.1. **Create Virtual Port**
1061 ----------------------------
1063 +---------------------+------------------------------------------------------------------------------+
1064 | **IF Definition** | **Description** |
1065 +=====================+==============================================================================+
1066 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports |
1067 +---------------------+------------------------------------------------------------------------------+
1068 | Operation | POST |
1069 +---------------------+------------------------------------------------------------------------------+
1070 | Direction | VNFLCM->MULTIVIM |
1071 +---------------------+------------------------------------------------------------------------------+
1076 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1077 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1078 +========================+=================+===================+===============+=======================================================+
1079 | networkId | M | 1 | string | Network UUID |
1080 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1081 | subnetId | O | 1 | string | Subnet UUID |
1082 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1083 | name | M | 1 | string | Port name |
1084 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1085 | macAddress | O | 1 | string | Mac address |
1086 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1087 | ip | O | 1 | string | Ip address |
1088 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1089 | vnicType | O | 1 | string | Virtual network card type, |
1091 | | | | | the value of three kinds of normal/direct/macvtap |
1092 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1093 | \ **securityGroups** | **O** | **1** | **string** | **The IDs of security groups applied to the port.** |
1094 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1099 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1100 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1101 +======================+=================+===================+===============+=====================================================+
1102 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1103 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1104 | vimId | M | 1 | String | vim id |
1105 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1106 | vimName | O | 1 | string | vim name |
1107 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1108 | status | M | 1 | string | status |
1109 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1110 | id | M | 1 | string | Port Id |
1111 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1112 | name | M | 1 | string | Port name |
1113 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1114 | tenantId | M | 1 | String | Tenant UUID |
1115 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1116 | networkName | M | 1 | string | Network name |
1117 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1118 | networkId | M | 1 | string | Network Id |
1119 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1120 | subnetName | M | 1 | string | Subnet name |
1121 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1122 | subnetId | M | 1 | string | SubnetId |
1123 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1124 | macAddress | O | 1 | string | Mac address |
1125 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1126 | ip | O | 1 | string | Ip address |
1127 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1128 | vnicType | O | 1 | string | Virtual network card type, |
1130 | | | | | the value of three kinds of normal/direct/macvtap |
1131 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1132 | **securityGroups** | **O** | **1** | **string** | **List of security group names.** |
1133 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1135 6.2. **Delete Virtual Port**
1136 ----------------------------
1138 +---------------------+---------------------------------------------------------------------------------------+
1139 | **IF Definition** | **Description** |
1140 +=====================+=======================================================================================+
1141 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1142 +---------------------+---------------------------------------------------------------------------------------+
1143 | Operation | DELETTE |
1144 +---------------------+---------------------------------------------------------------------------------------+
1145 | Direction | VNFLCM->MULTIVIM |
1146 +---------------------+---------------------------------------------------------------------------------------+
1158 6.3. **List Virtual Port**
1159 --------------------------
1161 +---------------------+-----------------------------------------------------------------------------+
1162 | **IF Definition** | **Description** |
1163 +=====================+=============================================================================+
1164 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports |
1165 +---------------------+-----------------------------------------------------------------------------+
1167 +---------------------+-----------------------------------------------------------------------------+
1168 | Direction | VNFLCM->MULTIVIM |
1169 +---------------------+-----------------------------------------------------------------------------+
1174 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1175 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1176 +=================+=================+===================+===============+=================================================+
1177 | name | M | 1 | string | Port name to filter out list of virtual ports |
1178 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1183 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1184 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1185 +===================+=================+===================+===============+=====================================================+
1186 | vimId | M | 1 | String | vim id |
1187 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1188 | vimName | O | 1 | string | vim name |
1189 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1190 | tenantId | M | 1 | String | Tenant UUID |
1191 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1192 | Ports | M | 0..N | List | ports |
1193 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1194 | id | M | 1 | string | Port Id |
1195 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1196 | name | M | 1 | string | Port name |
1197 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1198 | status | M | 1 | string | status |
1199 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1200 | **networkName** | O | 1 | string | Network name |
1201 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1202 | networkId | M | 1 | string | Network Id |
1203 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1204 | subnetName | O | 1 | string | Subnet name |
1205 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1206 | subnetId | M | 1 | string | SubnetId |
1207 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1208 | macAddress | O | 1 | string | Mac address |
1209 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1210 | ip | O | 1 | string | Ip address |
1211 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1212 | vnicType | O | 1 | string | Virtual network card type, |
1214 | | | | | the value of three kinds of normal/direct/macvtap |
1215 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1216 | securityGroups | O | 1 | string | List of security group names. |
1217 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1224 6.4. **Get Virtual Port**
1225 -------------------------
1227 +---------------------+---------------------------------------------------------------------------------------+
1228 | **IF Definition** | **Description** |
1229 +=====================+=======================================================================================+
1230 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1231 +---------------------+---------------------------------------------------------------------------------------+
1233 +---------------------+---------------------------------------------------------------------------------------+
1234 | Direction | VNFLCM->MULTIVIM |
1235 +---------------------+---------------------------------------------------------------------------------------+
1245 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1246 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1247 +==================+=================+===================+===============+=====================================================+
1248 | vimId | M | 1 | String | vim id |
1249 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1250 | vimName | O | 1 | string | vim name |
1251 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1252 | status | M | 1 | string | status |
1253 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1254 | id | M | 1 | string | Port Id |
1255 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1256 | name | M | 1 | string | Port name |
1257 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1258 | tenantId | M | 1 | String | Tenant UUID |
1259 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1260 | networkName | M | 1 | string | Network name |
1261 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1262 | networkId | M | 1 | string | Network Id |
1263 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1264 | subnetName | M | 1 | string | Subnet name |
1265 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1266 | subnetId | M | 1 | string | SubnetId |
1267 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1268 | macAddress | O | 1 | string | Mac address |
1269 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1270 | ip | O | 1 | string | Ip address |
1271 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1272 | vnicType | O | 1 | string | Virtual network card type, |
1274 | | | | | the value of three kinds of normal/direct/macvtap |
1275 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1276 | securityGroups | O | 1 | string | **List of security group names.** |
1277 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1284 7. **Server Management**
1285 ^^^^^^^^^^^^^^^^^^^^^^^^
1287 7.1. **Create Server**
1288 ----------------------
1290 +---------------------+--------------------------------------------------------------------------------+
1291 | **IF Definition** | **Description** |
1292 +=====================+================================================================================+
1293 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1294 +---------------------+--------------------------------------------------------------------------------+
1295 | Operation | POST |
1296 +---------------------+--------------------------------------------------------------------------------+
1297 | Direction | VNFLCM->MULTIVIM |
1298 +---------------------+--------------------------------------------------------------------------------+
1303 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1304 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1305 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1306 | name | M | 1 | string | server name |
1307 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1308 | boot | M | 1 | String | Start parameters |
1309 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1310 | nicArray | O | 1..n | List of nic | List of nic |
1311 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1312 | contextArray | O | 1..n | list of context | list of context |
1313 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1314 | volumeArray | O | 1..n | list of volume | list of volume |
1315 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1316 | availabilityZone | O | 1 | string | Usable field |
1317 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1318 | flavorId | M | 1 | String | server Flavor id |
1319 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1320 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1321 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1322 | userdata | O | 1 | string | Configuration information or scripts to use upon launch. Must be Base64 encoded. |
1324 | | | | | 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. |
1325 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1326 | 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. |
1327 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1328 | serverGroup | O | 1 | string | the ServerGroup for anti-affinity and affinity |
1329 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1333 +-----------------+-----------------+-------------------+---------------+---------------------------+
1334 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1335 +=================+=================+===================+===============+===========================+
1336 | type | M | 1 | int | Startup mode |
1338 | | | | | 1. boot from the volume |
1340 | | | | | 2. boot from image |
1341 +-----------------+-----------------+-------------------+---------------+---------------------------+
1342 | volumeId | O | 1 | string | Volume Id(type=1) |
1343 +-----------------+-----------------+-------------------+---------------+---------------------------+
1344 | imageId | O | 1 | String | ImageId(type=2) |
1345 +-----------------+-----------------+-------------------+---------------+---------------------------+
1349 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1350 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1351 +=================+=================+===================+===============+===========================================================================================================================================================+
1352 | fileName | M | 1 | String | Injection file name |
1353 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1354 | 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. ) |
1355 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1359 +-----------------+-----------------+-------------------+---------------+-------------------+
1360 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1361 +=================+=================+===================+===============+===================+
1362 | volumeId | M | 1 | String | Volume Id |
1363 +-----------------+-----------------+-------------------+---------------+-------------------+
1367 +-----------------+-----------------+-------------------+---------------+-------------------+
1368 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1369 +=================+=================+===================+===============+===================+
1370 | portId | M | 1 | String | Port Id |
1371 +-----------------+-----------------+-------------------+---------------+-------------------+
1378 "tenant": "tenant1",
1382 "availabilityZone": "az1",
1384 "flavorName": "vm_large",
1390 " volumeName": "volume1"
1394 "flavorId": "vm_large_134213",
1398 "fileName": "test.yaml",
1406 "volumeName": "vol1",
1422 "userdata": "abcdedf"
1429 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1430 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1431 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1432 | vimId | M | 1 | String | vim id |
1433 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1434 | vimName | O | 1 | string | vim name |
1435 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1436 | returnCode | | 1 | int | 0: Already exist 1: Newly created |
1437 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1438 | id | M | 1 | string | server id |
1439 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1440 | name | | 1 | string | server name |
1441 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1442 | tenantId | M | 1 | String | Tenant UUID |
1443 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1444 | boot | M | 1 | String | Start parameters |
1445 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1446 | nicArray | O | 1..n | List of nic | List of nic |
1447 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1448 | volumeArray | O | 1..n | list of volume | list of volume |
1449 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1450 | availabilityZone | O | 1 | string | Usable field |
1451 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1452 | flavorId | M | 1 | String | server Flavor |
1453 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1454 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1455 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1456 | **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.** |
1458 | | | | | **[TBD]** |
1459 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1460 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1463 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1464 | **status** | **M** | **1** | **string** | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR |
1465 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1475 "id": "3c9eebdbbfd345658269340b9ea6fb73",
1483 7.2. **Delete Server**
1484 ----------------------
1486 +---------------------+-------------------------------------------------------------------------------------------+
1487 | **IF Definition** | **Description** |
1488 +=====================+===========================================================================================+
1489 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1490 +---------------------+-------------------------------------------------------------------------------------------+
1491 | Operation | DELETE |
1492 +---------------------+-------------------------------------------------------------------------------------------+
1493 | Direction | NFLCM,NSLCM->MULTIVIM |
1494 +---------------------+-------------------------------------------------------------------------------------------+
1506 7.3. **List Server**
1507 --------------------
1509 +---------------------+--------------------------------------------------------------------------------+
1510 | **IF Definition** | **Description** |
1511 +=====================+================================================================================+
1512 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1513 +---------------------+--------------------------------------------------------------------------------+
1515 +---------------------+--------------------------------------------------------------------------------+
1516 | Direction | NFLCM,NSLCM->MULTIVIM |
1517 +---------------------+--------------------------------------------------------------------------------+
1522 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1524 +-----------------+-----------------+-------------------+---------------+-------------------+
1525 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1526 +=================+=================+===================+===============+===================+
1527 | name | M | 1 | string | server name |
1528 +-----------------+-----------------+-------------------+---------------+-------------------+
1533 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1534 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1535 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1536 | vimId | M | 1 | String | vim id |
1537 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1538 | vimName | O | 1 | string | vim name |
1539 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1540 | servers | M | 1 | array | server list |
1541 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1542 | id | M | 1 | string | server id |
1543 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1544 | name | M | 1 | string | server name |
1545 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1546 | tenantId | M | 1 | String | Tenant UUID |
1547 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1548 | boot | M | 1 | String | Start parameters |
1549 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1550 | nicArray | O | 1..n | List of nic | List of nic |
1551 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1552 | volumeArray | O | 1..n | list of volume | list of volume |
1553 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1554 | availabilityZone | O | 1 | string | Usable field |
1555 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1556 | flavorId | M | 1 | String | server Flavor |
1557 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1558 | metada | O | 1 | keypair | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1559 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1560 | **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.** |
1562 | | | | | **[TBD]** |
1563 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1564 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1567 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1576 +---------------------+-------------------------------------------------------------------------------------------+
1577 | **IF Definition** | **Description** |
1578 +=====================+===========================================================================================+
1579 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1580 +---------------------+-------------------------------------------------------------------------------------------+
1582 +---------------------+-------------------------------------------------------------------------------------------+
1583 | Direction | NFLCM,NSLCM->MULTIVIM |
1584 +---------------------+-------------------------------------------------------------------------------------------+
1594 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1595 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1596 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1597 | vimId | M | 1 | String | vim id |
1598 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1599 | vimName | O | 1 | string | vim name |
1600 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1601 | id | M | 1 | string | server id |
1602 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1603 | name | M | 1 | string | server name |
1604 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1605 | tenantId | M | 1 | String | Tenant UUID |
1606 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1607 | boot | M | 1 | String | Start parameters |
1608 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1609 | nicArray | O | 1..n | List of nic | List of nic |
1610 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1611 | volumeArray | O | 1..n | list of volume | list of volume |
1612 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1613 | availabilityZone | O | 1 | string | Usable field |
1614 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1615 | flavorId | M | 1 | String | server Flavor |
1616 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1617 | metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1618 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1619 | **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.** |
1621 | | | | | **[TBD]** |
1622 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1623 | **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1626 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1632 8. **Flavor Management**
1633 ^^^^^^^^^^^^^^^^^^^^^^^^
1635 8.1. **Create Flavor**
1636 ----------------------
1638 +---------------------+--------------------------------------------------------------------------------+
1639 | **IF Definition** | **Description** |
1640 +=====================+================================================================================+
1641 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors |
1642 +---------------------+--------------------------------------------------------------------------------+
1643 | Operation | POST |
1644 +---------------------+--------------------------------------------------------------------------------+
1645 | Direction | VNFLCM->MULTIVIM |
1646 +---------------------+--------------------------------------------------------------------------------+
1651 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1652 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1653 +=================+=================+===================+===============================+==============================================================================================================================+
1654 | name | M | 1 | string | Flavor Name |
1655 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1656 | vcpu | M | 1 | int | Virtual CPU number |
1657 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1658 | memory | M | 1 | int | Memory size |
1659 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1660 | disk | M | 1 | int | The size of the root disk |
1661 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1662 | ephemeral | O | 1 | int | The size of the ephemeral disk |
1663 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1664 | swap | O | 1 | int | The size of the swap disk |
1665 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1666 | 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. |
1667 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1668 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1669 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1674 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1675 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1676 +=================+=================+===================+===========================+==============================================================================================================================+
1677 | id | M | 1 | string | Flavor id |
1678 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1679 | name | M | 1 | string | Flavor name |
1680 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1681 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1682 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1683 | tenantId | M | 1 | String | Tenant UUID |
1684 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1685 | vcpu | M | 1 | int | Virtual CPU number |
1686 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1687 | memory | M | 1 | int | Memory size |
1688 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1689 | disk | M | 1 | int | The size of the root disk |
1690 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1691 | ephemeral | M | 1 | int | The size of the ephemeral disk |
1692 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1693 | swap | M | 1 | int | The size of the swap disk |
1694 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1695 | 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. |
1696 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1697 | extraSpecs | O | 0..N | List of Key-value pairs | EPA parameter |
1698 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1699 | vimId | M | 1 | String | vim id |
1700 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1701 | vimName | O | 1 | string | vim name |
1702 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1704 8.2. **Delete Flavor**
1705 ----------------------
1707 +---------------------+--------------------------------------------------------------------------------------------+
1708 | **IF Definition** | **Description** |
1709 +=====================+============================================================================================+
1710 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid} |
1711 +---------------------+--------------------------------------------------------------------------------------------+
1712 | Operation | DELETE |
1713 +---------------------+--------------------------------------------------------------------------------------------+
1714 | Direction | NFLCM,NSLCM->MULTIVIM |
1715 +---------------------+--------------------------------------------------------------------------------------------+
1727 8.3. **List Flavor**
1728 --------------------
1730 +---------------------+---------------------------------------------------------------------------------+
1731 | **IF Definition** | **Description** |
1732 +=====================+=================================================================================+
1733 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors |
1734 +---------------------+---------------------------------------------------------------------------------+
1736 +---------------------+---------------------------------------------------------------------------------+
1737 | Direction | NFLCM,NSLCM->MULTIVIM |
1738 +---------------------+---------------------------------------------------------------------------------+
1743 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1744 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1745 +=================+=================+===================+===============+==================================+
1746 | name | M | 1 | string | Flavor name to filter out list |
1747 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1752 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1753 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1754 +=================+=================+===================+===============================+==============================================================================================================================+
1755 | flavors | M | 0..N | list | Vm list |
1756 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1757 | id | M | 1 | string | Flavor id |
1758 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1759 | name | M | 1 | string | Flavor Name |
1760 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1761 | vcpu | M | 1 | int | Virtual CPU number |
1762 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1763 | memory | M | 1 | int | Memory size |
1764 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1765 | disk | M | 1 | int | The size of the root disk |
1766 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1767 | ephemeral | M | 1 | int | The size of the ephemeral disk |
1768 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1769 | swap | M | 1 | int | The size of the swap disk |
1770 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1771 | 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. |
1772 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1773 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1774 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1775 | vimId | M | 1 | String | vim id |
1776 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1777 | vimName | O | 1 | string | vim name |
1778 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1779 | tenantId | M | 1 | String | Tenant UUID |
1780 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1789 +---------------------+----------------------------------------------------------------------------------------------+
1790 | **IF Definition** | **Description** |
1791 +=====================+==============================================================================================+
1792 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid } |
1793 +---------------------+----------------------------------------------------------------------------------------------+
1795 +---------------------+----------------------------------------------------------------------------------------------+
1796 | Direction | NFLCM,NSLCM->MULTIVIM |
1797 +---------------------+----------------------------------------------------------------------------------------------+
1807 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1808 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1809 +=================+=================+===================+===============================+==============================================================================================================================+
1810 | id | M | 1 | string | Flavor id |
1811 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1812 | name | M | 1 | string | Flavor Name |
1813 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1814 | vcpu | M | 1 | int | Virtual CPU number |
1815 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1816 | memory | M | 1 | int | Memory size |
1817 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1818 | disk | M | 1 | int | The size of the root disk |
1819 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1820 | ephemeral | M | 1 | int | The size of the ephemeral disk |
1821 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1822 | swap | M | 1 | int | The size of the swap disk |
1823 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1824 | 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. |
1825 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1826 | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1827 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1828 | vimId | M | 1 | String | vim id |
1829 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1830 | vimName | O | 1 | string | vim name |
1831 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1832 | tenantId | M | 1 | String | Tenant UUID |
1833 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1839 9. **Volume Management**
1840 ^^^^^^^^^^^^^^^^^^^^^^^^
1842 9.1. **Create Volume**
1843 ----------------------
1845 +---------------------+--------------------------------------------------------------------------------+
1846 | **IF Definition** | **Description** |
1847 +=====================+================================================================================+
1848 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
1849 +---------------------+--------------------------------------------------------------------------------+
1850 | Operation | POST |
1851 +---------------------+--------------------------------------------------------------------------------+
1852 | Direction | NSLCM->MULTIVIM |
1853 +---------------------+--------------------------------------------------------------------------------+
1858 +--------------------+-----------------+-------------------+---------------+-------------------+
1859 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1860 +====================+=================+===================+===============+===================+
1861 | name | M | 1 | string | Volume name |
1862 +--------------------+-----------------+-------------------+---------------+-------------------+
1863 | volumeSize | M | 1 | int | Volume size |
1864 +--------------------+-----------------+-------------------+---------------+-------------------+
1865 | imageId | O | 1 | string | Image UUID |
1866 +--------------------+-----------------+-------------------+---------------+-------------------+
1867 | volumeType | O | 1 | string | Volume type |
1868 +--------------------+-----------------+-------------------+---------------+-------------------+
1869 | availabilityZone | O | 1 | string | Usable field |
1870 +--------------------+-----------------+-------------------+---------------+-------------------+
1876 "tenant": "tenant1",
1878 "volumeName": "volume1",
1882 "imageName": "cirros.qcow2",
1884 "volumeType": "volumetype1",
1886 "availabilityZone": "zone1"
1893 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1894 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1895 +====================+=================+===================+===============+=====================================+
1896 | returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1897 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1898 | vimId | M | 1 | String | vim id |
1899 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1900 | vimName | O | 1 | string | vim name |
1901 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1902 | tenantId | M | 1 | String | Tenant UUID |
1903 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1904 | status | M | 1 | string | Volume status |
1905 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1906 | id | M | 1 | string | Volume id |
1907 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1908 | name | M | 1 | string | Volume name |
1909 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1910 | volumeType | O | 1 | string | Volume type |
1911 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1912 | availabilityZone | O | 1 | string | Availability Zone |
1913 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1923 "id": "bc9eebdbbfd356458269340b9ea6fb73",
1931 9.2. **Delete Volume**
1932 ----------------------
1934 +---------------------+-------------------------------------------------------------------------------------------+
1935 | **IF Definition** | **Description** |
1936 +=====================+===========================================================================================+
1937 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId} |
1938 +---------------------+-------------------------------------------------------------------------------------------+
1939 | Operation | DELETE |
1940 +---------------------+-------------------------------------------------------------------------------------------+
1941 | Direction | NSLCM->MULTIVIM |
1942 +---------------------+-------------------------------------------------------------------------------------------+
1954 9.3. **List Volumes**
1955 ---------------------
1957 +---------------------+--------------------------------------------------------------------------------+
1958 | **IF Definition** | **Description** |
1959 +=====================+================================================================================+
1960 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
1961 +---------------------+--------------------------------------------------------------------------------+
1963 +---------------------+--------------------------------------------------------------------------------+
1964 | Direction | NSLCM-> MULTIVIM |
1965 +---------------------+--------------------------------------------------------------------------------+
1970 msb.onap.org:80/api/multicloud/v0/{cloud
1971 owner}\_{region}/volumes?{……}
1973 +-----------------+-----------------+-------------------+---------------+-------------------+
1974 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1975 +=================+=================+===================+===============+===================+
1976 | name | M | 1 | string | Volume name |
1977 +-----------------+-----------------+-------------------+---------------+-------------------+
1982 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1983 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1984 +====================+=================+===================+======================+====================================================+
1985 | vimId | M | 1 | String | vim id |
1986 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1987 | vimName | O | 1 | string | vim name |
1988 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1989 | tenantId | M | 1 | String | Tenant UUID |
1990 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1991 | volumes | M | 1 | Array | |
1992 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1993 | id | M | 1 | string | Volume id |
1994 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1995 | name | M | 1 | string | Volume name |
1996 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1997 | createTime | O | 1 | string | Create time |
1998 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1999 | status | M | 1 | string | Volume status |
2000 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2001 | volumeSize | M | 1 | int | Volume size |
2002 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2003 | volumeType | M | 1 | string | Volume type |
2004 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2005 | availabilityZone | M | 1 | string | Availability Zone |
2006 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2007 | attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2008 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2022 "status": "available",
2028 "createTime": "2015-12-02T07:57:23.000000",
2030 " volumeType ": "ws",
2032 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2048 "device": "/dev/vdc",
2050 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2052 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2056 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2062 "createTime": "2015-12-02T06:39:40.000000",
2064 " volumeType ": null,
2066 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2076 9.4. **Get Volumes**
2077 --------------------
2079 +---------------------+-------------------------------------------------------------------------------------------+
2080 | **IF Definition** | **Description** |
2081 +=====================+===========================================================================================+
2082 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid} |
2083 +---------------------+-------------------------------------------------------------------------------------------+
2085 +---------------------+-------------------------------------------------------------------------------------------+
2086 | Direction | NSLCM-> MULTIVIM |
2087 +---------------------+-------------------------------------------------------------------------------------------+
2097 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2098 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2099 +====================+=================+===================+======================+====================================================+
2100 | vimId | M | 1 | String | vim id |
2101 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2102 | vimName | O | 1 | string | vim name |
2103 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2104 | tenantId | M | 1 | String | Tenant UUID |
2105 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2106 | id | | 1 | string | Volume id |
2107 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2108 | name | | 1 | string | Volume name |
2109 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2110 | createTime | | 1 | string | Create time |
2111 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2112 | status | | 1 | string | Volume status |
2113 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2114 | volumeType | | 1 | list of string | Volume type |
2115 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2116 | volumeSize | | 1 | int | Volume size |
2117 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2118 | availabilityZone | M | 1 | string | Availability Zone |
2119 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2120 | attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2121 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2125 +-----------------+-----------------+-------------------+---------------+-------------------+
2126 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2127 +=================+=================+===================+===============+===================+
2128 | device | | 1 | string | Device name |
2129 +-----------------+-----------------+-------------------+---------------+-------------------+
2130 | serverId | | 1 | string | VM id |
2131 +-----------------+-----------------+-------------------+---------------+-------------------+
2132 | volumeId | | 1 | string | Volume id |
2133 +-----------------+-----------------+-------------------+---------------+-------------------+
2134 | hostName | | 1 | string | Host name |
2135 +-----------------+-----------------+-------------------+---------------+-------------------+
2136 | id | | 1 | string | Device id |
2137 +-----------------+-----------------+-------------------+---------------+-------------------+
2155 "device": "/dev/vdc",
2157 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2159 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2163 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2169 "createTime": "2015-12-02T06:39:40.000000",
2171 "volumeType ": null,
2173 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2179 10. **Tenant Management**
2180 ^^^^^^^^^^^^^^^^^^^^^^^^^
2182 10.1. **List tenants**
2183 ----------------------
2185 +---------------------+---------------------------------------------------------------------+
2186 | **IF Definition** | **Description** |
2187 +=====================+=====================================================================+
2188 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants |
2189 +---------------------+---------------------------------------------------------------------+
2191 +---------------------+---------------------------------------------------------------------+
2192 | Direction | NSLCM-> MULTIVIM |
2193 +---------------------+---------------------------------------------------------------------+
2198 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2199 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2200 +=====================+=================+===================+===============+=====================================+
2201 | name={tenantname} | O | 1 | string | Tenant name to filter output list |
2202 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2204 10.1.2. **Response**
2205 >>>>>>>>>>>>>>>>>>>>
2207 +-----------------+-----------------+-------------------+---------------+-------------------+
2208 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2209 +=================+=================+===================+===============+===================+
2210 | vimId | M | 1 | String | vim id |
2211 +-----------------+-----------------+-------------------+---------------+-------------------+
2212 | vimName | O | 1 | string | vim name |
2213 +-----------------+-----------------+-------------------+---------------+-------------------+
2214 | tenants | M | 1 | Array | |
2215 +-----------------+-----------------+-------------------+---------------+-------------------+
2216 | id | M | 1 | string | tenant UUID |
2217 +-----------------+-----------------+-------------------+---------------+-------------------+
2218 | name | M | 1 | string | tenant name |
2219 +-----------------+-----------------+-------------------+---------------+-------------------+
2246 11.1. **List Limits of resouces**
2247 ---------------------------------
2249 +---------------------+-------------------------------------------------------------------------------+
2250 | **IF Definition** | **Description** |
2251 +=====================+===============================================================================+
2252 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits |
2253 +---------------------+-------------------------------------------------------------------------------+
2255 +---------------------+-------------------------------------------------------------------------------+
2256 | Direction | NSLCM-> MULTIVIM |
2257 +---------------------+-------------------------------------------------------------------------------+
2264 11.1.2. **Response**
2265 >>>>>>>>>>>>>>>>>>>>
2267 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2268 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2269 +===========================+=================+===================+===============+==================================================================+
2270 | vimId | M | 1 | String | vim id |
2271 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2272 | vimName | O | 1 | string | vim name |
2273 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2274 | tenantId | M | 1 | string | Tenant UUID |
2275 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2276 | maxPersonality | O | 1 | int | The number of allowed injected files for each tenant. |
2277 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2278 | maxPersonalitySize | O | 1 | int | The number of allowed bytes of content for each injected file. |
2279 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2280 | maxServerGroupMembers | O | 1 | int | The number of allowed members for each server group. |
2281 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2282 | maxServerGroups | O | 1 | int | The number of allowed server groups for each tenant. |
2283 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2284 | maxServerMeta | O | 1 | int | The number of allowed metadata items for each instance. |
2285 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2286 | maxTotalCores | O | 1 | int | The number of allowed instance cores for each tenant. |
2287 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2288 | maxTotalInstances | O | 1 | int | The number of allowed instances for each tenant. |
2289 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2290 | maxTotalKeypairs | O | 1 | int | The number of allowed key pairs for each user. |
2291 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2292 | maxTotalRAMSize | O | 1 | int | The amount of allowed instance RAM, in MB, for each tenant. |
2293 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2294 | maxTotalVolumeGigabytes | O | 1 | int | The maximum total amount of volumes, in gibibytes (GiB). |
2295 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2296 | maxTotalVolumes | O | 1 | int | The maximum number of volumes. |
2297 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2298 | totalVolumesUsed | O | 1 | int | The total number of volumes used. |
2299 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2300 | totalGigabytesUsed | O | 1 | int | The total number of gibibytes (GiB) used. |
2301 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2302 | network | O | 1 | int | The number of networks allowed for each project. |
2303 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2304 | subnet | O | 1 | int | The number of subnets allowed for each project. |
2305 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2306 | subnetpool | O | 1 | int | The number of subnet pools allowed for each project. |
2307 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2308 | security\_group\_rule | O | 1 | int | The number of security group rules allowed for each project. |
2309 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2310 | security\_group | O | 1 | int | The number of security groups allowed for each project. |
2311 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2312 | router | O | 1 | int | The number of routers allowed for each project. |
2313 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2314 | port | O | 1 | int | The number of ports allowed for each project. |
2315 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2325 "maxPersonality": 5,
2327 "maxPersonalitySize": 10240,
2329 "maxServerMeta": 128,
2331 "maxTotalCores": 20,
2333 "maxTotalInstances": 10,
2335 "maxTotalKeypairs": 100,
2337 "maxTotalRAMSize": 51200,
2339 "maxServerGroups": 10,
2341 "maxServerGroupMembers": 10,
2345 12. **Host Management**
2346 ^^^^^^^^^^^^^^^^^^^^^^^
2348 12.1. **List hosts**
2349 --------------------
2351 +---------------------+------------------------------------------------------------------------------+
2352 | **IF Definition** | **Description** |
2353 +=====================+==============================================================================+
2354 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts |
2355 +---------------------+------------------------------------------------------------------------------+
2357 +---------------------+------------------------------------------------------------------------------+
2358 | Direction | NSLCM-> MULTIVIM |
2359 +---------------------+------------------------------------------------------------------------------+
2366 12.1.2. **Response**
2367 >>>>>>>>>>>>>>>>>>>>
2369 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2370 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2371 +=================+=================+===================+=================+===================================+
2372 | vimId | M | 1 | String | vim id |
2373 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2374 | vimName | O | 1 | string | vim name |
2375 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2376 | tenantId | M | 1 | string | Tenant Name |
2377 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2378 | hosts | M | 1 | Array of host | List of host information |
2379 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2380 | service | M | 1 | string | The service running on the host |
2381 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2382 | name | M | 1 | string | host name |
2383 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2384 | zone | O | 1 | string | Available zone for the host |
2385 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2397 "vimName": "vimName",
2399 "tenantId": "tenantId1"
2405 "name": "b6e4adbc193d428ea923899d07fb001e",
2407 "service": "conductor",
2413 "vimName": "vimName",
2415 "tenantId": "tenantId1"
2421 "name": "09c025b0efc64211bd23fc50fa974cdf",
2423 "service": "compute",
2429 "vimName": "vimName",
2431 "tenantId": "tenantId1"
2437 "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2439 "service": "consoleauth",
2445 "vimName": "vimName",
2447 "tenantId": "tenantId1"
2453 "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2455 "service": "network",
2461 "vimName": "vimName",
2463 "tenantId": "tenantId1"
2469 "name": "abffda96592c4eacaf4111c28fddee17",
2471 "service": "scheduler",
2477 "vimName": "vimName",
2479 "tenantId": "tenantId1"
2490 +---------------------+-----------------------------------------------------------------------------------------+
2491 | **IF Definition** | **Description** |
2492 +=====================+=========================================================================================+
2493 | URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/hosts/{hostname} |
2494 +---------------------+-----------------------------------------------------------------------------------------+
2496 +---------------------+-----------------------------------------------------------------------------------------+
2497 | Direction | NSLCM-> MULTIVIM |
2498 +---------------------+-----------------------------------------------------------------------------------------+
2503 12.2.2. **Response**
2504 >>>>>>>>>>>>>>>>>>>>
2506 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2507 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2508 +=================+=================+===================+=====================+==============================================================+
2509 | vimId | M | 1 | String | vim id |
2510 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2511 | vimName | O | 1 | string | vim name |
2512 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2513 | tenantId | M | 1 | string | Tenant Name |
2514 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2515 | host | M | 1 | List of resources | Host resource info |
2516 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2517 | resource | M | 1..N | Object | Resource description |
2518 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2519 | cpu | M | 1 | Int | The cpu info on the host. |
2520 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2521 | memory_mb | M | 1 | int | The memory info on the host (in MB). |
2522 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2523 | name | M | 1 | string | host name |
2524 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2525 | project | M | 1 | string | Value: total, used_now, used_max or specific project_id |
2526 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2527 | disk_gb | M | 1 | int | The disk info on the host (in GB). |
2528 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2542 "name": "c1a7de0ac9d94e4baceae031d05caae3",
2548 "vimName": "vimName",
2550 "tenantId": "tenantId1",
2558 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2562 "project": "(total)",
2572 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2576 "project": "(used\_now)",
2586 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2590 "project": "(used\_max)",
2600 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2604 "project": "568f7ec425db472ba348251bf1e7eebd",
2612 "vimName": "openstack\_newton",
2614 "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2616 "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2620 13. **VIM Management**
2621 ^^^^^^^^^^^^^^^^^^^^^^
2623 13.1. **Update VIM Info**
2624 -------------------------
2626 +---------------------+----------------------------------------------------------------------------------------------+
2627 | **IF Definition** | **Description** |
2628 +=====================+==============================================================================================+
2629 | URI | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region}/registry |
2630 +---------------------+----------------------------------------------------------------------------------------------+
2631 | Operation | POST |
2632 +---------------------+----------------------------------------------------------------------------------------------+
2633 | Direction | ESR-> MULTICLOUD |
2634 +---------------------+----------------------------------------------------------------------------------------------+
2639 +-----------------+-----------------+-------------------+---------------+-----------------------+
2640 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2641 +=================+=================+===================+===============+=======================+
2642 | defaultTenant | M | 1 | string | default tenant name |
2643 +-----------------+-----------------+-------------------+---------------+-----------------------+
2645 13.1.2. **Response**
2646 >>>>>>>>>>>>>>>>>>>>
2654 13.2. **Unregistry VIM**
2655 ------------------------
2657 +---------------------+-----------------------------------------------------------------------------------------------+
2658 | **IF Definition** | **Description** |
2659 +=====================+===============================================================================================+
2660 | URI | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region} |
2661 +---------------------+-----------------------------------------------------------------------------------------------+
2662 | Operation | DELETE |
2663 +---------------------+-----------------------------------------------------------------------------------------------+
2664 | Direction | ESR-> MULTICLOUD |
2665 +---------------------+-----------------------------------------------------------------------------------------------+
2672 13.2.2. **Response**
2673 >>>>>>>>>>>>>>>>>>>>
2677 204: No content found