summaryrefslogtreecommitdiffstats
path: root/docs/MultiCloud-APIv1-Specification.rst
blob: dc5c551a382ec25b158b56feabd5a6e77b97191b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
..
 This work is licensed under a Creative Commons Attribution 4.0
 International License.

================================
MultiCloud API v1 Specification
================================

The is the specification for MultiCloud API version v1.

Note: "MultiCloud API Specification V1" refers to the specification for MultiCloud API version v0

API Catalog
===========

1. **Scope**
^^^^^^^^^^^^

The scope of the present document is to describe the MutliCloud NorthBound API
specification.

2. **Terms, Definitions and Abbreviations**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For the purposes of the present document, the following abbreviations
apply:

===================== =========================================================
Abbreviation           Description
===================== =========================================================
NFVO                  Network Functions Virtualization Orchestrator
VNFM                  Virtual Network Function Management
VIM                   Virtualized Infrastructure Manager
MultiVIM/MultiCloud   MultVIM driver services for OPEN-O to drive VIM instances
===================== =========================================================

3. **Image Management**
^^^^^^^^^^^^^^^^^^^^^^^

3.1. **Create Image**
---------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images
Operation              POST
Direction              NSLCM->MULTIVIM
Description            Create Image and Upload the image file to the VIM
===================== =========================================================

3.1.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
name             M         1            String     Image Name
imagePath        M         1            String     Image Local Path from catalog
imageType        M         1            String     Image Type
                                                     ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
visibility       O         1            string     Visibility for this image.
                                                   public, private, shared, or community
containerFormat  M         1            string     ami,ari,aki,bare,ovf,ova, docker
properties       O         0..N         List       Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic"
================ ========= ============ ======== ================================


::

    {

    "imageName": "cirros",

    "imagePath": "/home/cirros.qcow2",

    "imageType": "qcow2"

    "containerFormat":"bare"

    }

3.1.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  id                  M         1       String                      Image UUID in the VIM
  name                M         1       String                      Image Name
  returnCode          M         1       Int                         0: Already exist 1: Newly created
  imageType           M         1       String                      Image Type
                                                                      ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
containerFormat       M         1       string                      ami,?ari,?aki,?bare,?ovf,?ova, ?docker
  visibility          O         1       string                      Visibility for this image.
                                                                      public, private, shared, or community
  properties          O                 0..N                List of key-value pairs
  vimid               M         1       String                      vim id
  vimName             O         1       string                      vim name
  cloud-owner         M         1       String                      cloud owner
cloud-region-id       M         1       string                      cloud region id
  tenantId            M         1       String                      Tenant UUID
================ ========= ============ ======== ================================

*202*: accepted

500: failed

::

    {
        "id": "3c9eebdbbfd345658269340b9ea6fb73",
        "name": "cirros",
        "returnCode": 1
    }

3.2. **Delete Image**
---------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images/{imageId}
Operation              Delete
Direction              NSLCM->MULTIVIM
Description            Delete Image
===================== =========================================================

3.2.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

3.2.2. **Response**
>>>>>>>>>>>>>>>>>>>

204: no content

3.3. **List Images**
--------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images
Operation              GET
Direction              NSLCM->MULTIVIM
Description            Query Image list
===================== =========================================================

3.3.1. **Request**
>>>>>>>>>>>>>>>>>>

============== ========= ============ ======== ================================
Parameter      Qualifier Cardinality  Content    Description
============== ========= ============ ======== ================================
  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.
  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.
  name              O         1       String          Filters the response by a name, as a string. A valid value is the name of an image
============== ========= ============ ======== ================================


3.3.2. **Response**
>>>>>>>>>>>>>>>>>>>


================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
images            M         0..N         List      Image List

id                M         1            String    Image ID

size              M         1            int       Image Size

name              M         1            String    Image Name

status            M         1            String    Image Status

imageType         M         1            String    Image Type
                                                     ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
containerFormat   M         1            string    ami,?ari,?aki,?bare,?ovf,?ova, ?docker
visibility        O         1            string    Visibility for this image.
                                                     public, private, shared, or community
vimId             M         1            String    vim id
vimName           O         1            string    vim name
cloud-owner       M         1            String    cloud owner
cloud-region-id   M         1            string    cloud region id
tenantId          M         1            String    Tenant UUID
================ ========= ============ ======== ================================

200: ok

500: failed

::

    {
        "vimid": "",
        "vimname": "",
        "imageList": [{
            "status": "active",
            "id": "5e2757c1-f846-4727-915c-9a872553ed75",
            "size": 862016,
            "name": "vim-plus-cgsl40g-z.qcow2"
        }]
    }


3.4. **Get Image**
------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images/{imageid}
Operation              GET
Direction              NSLCM->MULTIVIM
Description            Query Image Information
===================== =========================================================



3.4.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

3.4.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  id                  M         1       String          Image ID
  size                M         1       int             Image Size
  name                M         1       String          Image Name
  status              M         1       String          Image Status
  imageType           M         1       String          Image Type
                                                          ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
containerFormat       M         1       string          ami,?ari,?aki,?bare,?ovf,?ova, ?docker
  visibility          O         1       string          Visibility for this image.
                                                          public, private, shared, or community
  vimId               M         1       String          vim id
  vimName             M         1       string          vim name
  cloud-owner         M         1       String          cloud owner
cloud-region-id       M         1       string          cloud region id
  tenantId            M         1       String          Tenant UUID
================ ========= ============ ======== ================================

200: ok

500: failed

::

    {
        "vimid": "",
        "vimname": "",
        "status": "active",
        "id": "5e2757c1-f846-4727-915c-9a872553ed75",
        "size": 862016,
        "name": "vim-plus-cgsl40g-z.qcow2"
    }

4. **Network Management**
^^^^^^^^^^^^^^^^^^^^^^^^^

4.1. **Create Network**
-----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks
Operation              POST
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Create network on the VIM
===================== =========================================================

4.1.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name                M         1       String          Logical network name
  shared              M         1       boolean         Whether to share(1:sharing;0:private)
vlanTransparent       O         1       boolean         Whether to support VLAN pass through(1:true;0:false)
  networkType         O         1       String          Network type
                                                          flat, vlan, vxlan, gre, portgroup
  segmentationId      O         1       Int             id of paragraph
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.
  routerExternal      O         1       boolean        Indicates whether this network can provide floating IPs via a router.
================ ========= ============ ======== ================================


::

    {
        "tenant": "tenant1",
        "networkName": "ommnet",
        "shared": 1,
        "vlanTransparent": 1,
        "networkType": "vlan",
        "segmentationId": 202,
        "physicalNetwork": "ctrl",
        "routerExternal": 0
    }

4.1.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
status            M          1          string     Network status
id                M          1          string     Network id
name              M          1          string     Network name
tenantId          M          1          String     Tenant UUID
segmentationId    O          1          int        Segmentation id
networkType       O          1          string     Network type
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.
vlanTransparent   O          1          boolean    Whether to support VLAN pass through(1:true;0:false)
shared            O          1          boolean    Whether to share(1:sharing;0:private)
routerExternal    O          1          boolean    Indicates whether this network can provide floating IPs via a router.
returnCode        M          1          int        0: Already exist 1: Newly created
vimId             M          1          String     vim id
vimName           O          1          string     vim name
cloud-owner       M          1          String     cloud owner
cloud-region-id   M          1          string     cloud region id
================ ========= ============ ======== ================================

202: accepted

500: failed

::

    {
        "returnCode": 0,
        "vimId": "11111",
        "vimName": "11111",
        "status": "ACTIVE",
        "id": "3c9eebdbbfd345658269340b9ea6fb73",
        "name": "net1",
        "tenant": "tenant1",
        "networkName": "ommnet",
        "shared": 1,
        "vlanTransparent": 1,
        "networkType": "vlan",
        "segmentationId": 202,
        "physicalNetwork": "ctrl",
        "routerExternal": 0
    }

4.2. **Delete Network**
-----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks/{networkId}
Operation              Delete
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Delete a network on the VIM
===================== =========================================================

4.2.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

4.2.2. **Response**
>>>>>>>>>>>>>>>>>>>

204: no content

4.3. **List Network**
---------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks
Operation              GET
Direction              VNFLCM,NSLCM->MULTIVIM
Description            List networks on the VIM
===================== =========================================================

4.3.1. **Query**
>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
name             O         1            String    Filters the response by a name, as a string. A valid value is the name of a network
================ ========= ============ ======== ================================

4.3.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
vimId             M           1         String        vim id
vimName           O           1         string        vim name
cloud-owner       M           1         String        cloud owner
cloud-region-id   M           1         string        cloud region id
networks                      0..N      List          Network list
status            M           1         string        Network status
id                M           1         string        Network id
name              M           1         string        Network name
tenantId          M           1         String        Tenant UUID
segmentationId    O           1         int           Segmentation id
networkType       O           1         string        Network type
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.
vlanTransparent   O           1         boolean       Whether to support VLAN pass through(1:true;0:false)
shared            O           1         boolean       Whether to share(1:sharing;0:private)
routerExternal    O           1         boolean       Indicates whether this network can provide floating IPs via a router
================ ========= ============ ======== ================================

200: ok

500: failed

::

    {

        "vimId": "11111",

        "vimName": "111",

        "networks":

            [{

                "status": "ACTIVE",

                "id": "3c9eebdbbfd345658269340b9ea6fb73",

                "name": "net1",

                "tenant": "tenant1",

                "networkName": "ommnet",

                "shared": 1,

                "vlanTransparent": 1,

                "networkType": "vlan",

                "segmentationId": 202,

                "physicalNetwork ": "ctrl",

                "routerExternal ": 0

            }]

    }

4.4. **Get Network**
--------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks/{networkId}
Operation              get
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Get a network on the VIM
===================== =========================================================

4.4.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

4.4.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  status              M         1       string          Network status
  id                  M         1       string          Network id
  name                M         1       string          Network name
  tenantId            M         1       String          Tenant UUID
  segmentationId      O         1       int             Segmentation id
  networkType         O         1       string          Network type
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.
vlanTransparent       O         1       boolean         Whether to support VLAN pass through(1:true;0:false)
  shared              O         1       boolean         Whether to share(1:sharing;0:private)
  routerExternal      O         1       boolean         Indicates whether this network can provide floating IPs via a router.
  returnCode          M         1       int             0: Already exist 1: Newly created
  vimId               M         1       String          vim id
  vimName             O         1       string          vim name
  cloud-owner         M         1       String                      cloud owner
cloud-region-id       M         1       string                      cloud region id
================ ========= ============ ======== ================================

200: ok

500: failed

::

    {

        "vimId":"11111",

        "vimName":"11111",

        "status": "ACTIVE",

        "id": "3c9eebdbbfd345658269340b9ea6fb73",

        "name": "net1",

        "tenant": "tenant1",

        "networkName": "ommnet",

        "shared": 1,

        "vlanTransparent": 1,

        "networkType":"vlan",

        "segmentationId":202,

        "physicalNetwork ":"ctrl",

        "routerExternal ":0

    }

5. **Subnetwork Management**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

5.1. **Create Subnets**
-----------------------


===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets
Operation              POST
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Create subnet on the VIM
===================== =========================================================

5.1.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  networkId           M         1       String                   Network Id
  name                M         1       String                   SubnetName
  cidr                M         1       String                   Subnet cidr
  ipVersion           M         1       Int                      Ip type
                                                                    4,6
  enableDhcp          O         1       boolean                  Whether to allow
                                                                         1: yes;0: no
  gatewayIp           O         1       String                   Gateway ip
dnsNameservers        O         1..n    List        List of servers
  hostRoutes          O         1..n    List        List of routes
allocationPools       O         1..n    list        List of allocation
  -->allocation
  -->start            O         1       String                   Start ip
  -->end              O         1       String                   End ip
================ ========= ============ ======== ================================

::

    {

        "tenant": "tenant1",

        "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",

        "subnetName": "subnet1",

        "cidr": "10.43.35.0/24",

        "ipVersion": 4,

        "enableDhcp": 1,

        "gatewayIp": "10.43.35.1",

        "dnsNameservers": [],

        "allocationPools": [{

            "start": "192.168.199.2",

            "end": "192.168.199.254"

        }],

        "hostRoutes": []

    }

5.1.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  returnCode          M         1       int                      0: Already exist 1: Newly created
  vimId               M         1       String                   vim id
  vimName             O         1       string                   vim name
  cloud-owner         M         1       String                      cloud owner
cloud-region-id       M         1       string                      cloud region id
  status              M         1       string                   subnetwork status
  id                  M         1       string                   subNetwork id
  tenantId            M         1       String                   Tenant UUID
  networkId           O         1       String                   Network Id
  networkName         O         1       String                   Network Name
  name                M         1       String                   SubnetName
  cidr                M         1       String                   Subnet cidr
  ipVersion           M         1       Int                      Ip type
                                                                  4,6
  enableDhcp          O         1       boolean                  Whether to allow
                                                                  1: yes;0: no
  gatewayIp           O         1       String                   Gateway ip
dnsNameservers        O         1..n    List          List of servers
  hostRoutes          O         1..     List           List of routes
allocationPools       O         1..n    List           list of allocation
  -->allocation
  -->start            O         1       String                   Start ip
  -->end              O         1       String                   End ip
================ ========= ============ ======== ================================

202: accepted

500: failed

::

    {

        "returnCode": 0,

        "vimId": "11111",

        "vimName": "11111",

        "status": " ACTIVE",

        "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",

        "tenant": "tenant1",

        "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",

        "name": "subnet1",

        "cidr": "10.43.35.0/24",

        "ipVersion": 4,

        "enableDhcp": 1,

        "gatewayIp": "10.43.35.1",

        "dnsNameservers": [],

        "allocationPools": [{

            "start": "192.168.199.2",

            "end": "192.168.199.254"

        }],

        "hostRoutes": []

    }

5.2. **Delete Subnets**
-----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets/{subnetId}
Operation              Delete
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Delete a subnet on the VIM
===================== =========================================================

5.2.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

5.2.2. **Response**
>>>>>>>>>>>>>>>>>>>

204: no content

5.3. **List Subnets**
---------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets
Operation              Get
Direction              VNFLCM,NSLCM->MULTIVIM
Description            List subnets on the VIM
===================== =========================================================

5.3.1. **Query**
>>>>>>>>>>>>>>>>

msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/subnets?{……}

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name              O         1         String          Filters fields of the response by a name, as a string. A valid value is the name of a subnet
================ ========= ============ ======== ================================

5.3.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String                   vim id
  vimName             O         1       string                   vim name
  cloud-owner         M         1       String                      cloud owner
cloud-region-id       M         1       string                      cloud region id
  subnets             M         0..N    List                     Network list
  status                        1       string                   subnetwork status
  id                            1       string                   subNetwork id
  tenantId            M         1       String                   Tenant UUID
  networkId           O         1       String                   Network Id
  networkName         O         1       String                   Network Name
  name                M         1       String                   SubnetName
  cidr                M         1       String                   Subnet cidr
  ipVersion           M         1       Int                      Ip type
                                                                    4,6
  enableDhcp          O         1       boolean                  Whether to allow
                                                                    1: yes;0: no
  gatewayIp           O         1       String                   Gateway ip
dnsNameservers        O         1..n    List          List of servers
  hostRoutes          O         1..     List           List of routes
allocationPools       O         1..n    List         list of allocation
  -->allocation
  -->start            O         1       String                   Start ip
  -->end              O         1       String                   End ip
================ ========= ============ ======== ================================

**200: ok**

**500: failed**

::

    {

        "vimId": "11111",

        "vimName": "11111",

        "subnets": [

            {

                "status": " ACTIVE",

                "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",

                "tenant": "tenant1",

                "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",

                "name": "subnet1",

                "cidr": "10.43.35.0/24",

                "ipVersion": 4,

                "enableDhcp": 1,

                "gatewayIp": "10.43.35.1",

                "dnsNameservers": [],

                "allocationPools": [{

                    "start": "192.168.199.2",

                    "end": "192.168.199.254"

                }],

                "hostRoutes": []

            }

        ]

    }

5.4. **Get Subnets**
--------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets/{subnetid}
Operation              GET
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Get subnet on the VIM
===================== =========================================================

5.4.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

5.4.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String                   vim id
  vimName             O         1       string                   vim name
  cloud-owner         M         1       String                      cloud owner
cloud-region-id       M         1       string                      cloud region id
  status                        1       string                   subnetwork status
  id                            1       string                   subNetwork id
  tenantId            M         1       String                   Tenant UUID
  networkId           O         1       String                   Network Id
  networkName         O         1       String                   Network Name
  name                M         1       String                   SubnetName
  cidr                M         1       String                   Subnet cidr
  ipVersion           M         1       Int                      Ip type
                                                                   4,6
  enableDhcp          O         1       boolean                  Whether to allow
                                                                   1: yes;0: no
  gatewayIp           O         1       String                   Gateway ip
dnsNameservers        O         1..n    List          List of servers
  hostRoutes          O         1..     List           List of routes
allocationPools       O         1..n    List           list of allocation
  -->allocation
  -->start            O         1       String                   Start ip
  -->end              O         1       String                   End ip
================ ========= ============ ======== ================================

202: accepted

500: failed

::

    {

        "status": " ACTIVE",

        "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",

        "tenant": "tenant1",

        "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",

        "name": "subnet1",

        "cidr": "10.43.35.0/24",

        "ipVersion": 4,

        "enableDhcp": 1,

        "gatewayIp": "10.43.35.1",

        "dnsNameservers": [],

        "allocationPools": [{

            "start": "192.168.199.2",

            "end": "192.168.199.254"

        }],

        "hostRoutes": []

    }

6. **Virtual Port**
^^^^^^^^^^^^^^^^^^^

6.1. **Create Virtual Port**
----------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports
Operation              POST
Direction              VNFLCM->MULTIVIM
Description            Create a vport on the VIM
===================== =========================================================

6.1.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  networkId           M         1       string          Network UUID
  subnetId            O         1       string          Subnet UUID
  name                M         1       string          Port name
  macAddress          O         1       string          Mac address
  ip                  O         1       string          Ip address
  vnicType            O         1       string          Virtual network card type,
                                                          the value of three kinds of normal/direct/macvtap
  securityGroups     O          1       string      The IDs of security groups applied to the port
================ ========= ============ ======== ================================

6.1.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  returnCode          M         1       int             0: Already exist 1: Newly created
  vimId               M         1       String          vim id
  vimName             O         1       string          vim name
  cloud-owner         M         1       String          cloud owner
cloud-region-id       M         1       string          cloud region id
  status              M         1       string          status
  id                  M         1       string          Port Id
  name                M         1       string          Port name
  tenantId            M         1       String          Tenant UUID
  networkName         M         1       string          Network name
  networkId           M         1       string          Network Id
  subnetName          M         1       string          Subnet name
  subnetId            M         1       string          SubnetId
  macAddress          O         1       string          Mac address
  ip                  O         1       string          Ip address
  vnicType            O         1       string          Virtual network card type,
                                                          the value of three kinds of normal/direct/macvtap
  securityGroups     O          1       string      List of security group names.
================ ========= ============ ======== ================================

6.2. **Delete Virtual Port**
----------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports/{portid}
Operation              POST
Direction              VNFLCM->MULTIVIM
Description            Delete a vport on the VIM
===================== =========================================================

6.2.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

6.2.2. **Response**
>>>>>>>>>>>>>>>>>>>

204: no content

6.3. **List Virtual Port**
--------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            List vports on the VIM
===================== =========================================================

6.3.1. **Query**
>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name              M         1         string          Port name to filter out list of virtual ports
================ ========= ============ ======== ================================

6.3.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String          vim id
  vimName             O         1       string          vim name
  cloud-owner         M         1       String          cloud owner
cloud-region-id       M         1       string          cloud region id
  tenantId            M         1       String          Tenant UUID
  Ports               M         0..N    List            ports
  id                  M         1       string          Port Id
  name                M         1       string          Port name
  status              M         1       string          status
  networkName         O         1       string          Network name
  networkId           M         1       string          Network Id
  subnetName          O         1       string          Subnet name
  subnetId            M         1       string          SubnetId
  macAddress          O         1       string          Mac address
  ip                  O         1       string          Ip address
  vnicType            O         1       string          Virtual network card type,
                                                          the value of three kinds of normal/direct/macvtap
  securityGroups      O         1       string          List of security group names.
================ ========= ============ ======== ================================

**200: ok**

**500: failed**


6.4. **Get Virtual Port**
-------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports/{portid}
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            Get a vport on the VIM
===================== =========================================================

6.4.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

6.4.2. **Response**
>>>>>>>>>>>>>>>>>>>

=============== ========= ============ ======== =================================
Parameter       Qualifier Cardinality  Content    Description
=============== ========= ============ ======== =================================
  vimId              M         1       String          vim id
  vimName            O         1       string          vim name
  cloud-owner        M         1       String          cloud owner
cloud-region-id      M         1       string          cloud region id
  status             M         1       string          status
  id                 M         1       string          Port Id
  name               M         1       string          Port name
  tenantId           M         1       String          Tenant UUID
  networkName        M         1       string          Network name
  networkId          M         1       string          Network Id
  subnetName         M         1       string          Subnet name
  subnetId           M         1       string          SubnetId
  macAddress         O         1       string          Mac address
  ip                 O         1       string          Ip address
  vnicType           O         1       string          Virtual network card type,
                                                         the value of three kinds of normal/direct/macvtap
securityGroups       O         1       string          List of security group names
=============== ========= ============ ======== =================================

**200: ok**

**500: failed**


7. **Server Management**
^^^^^^^^^^^^^^^^^^^^^^^^

7.1. **Create Server**
----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers
Operation              POST
Direction              VNFLCM->MULTIVIM
Description            Create a vserver on the VIM
===================== =========================================================

7.1.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name                M         1       string       server name
  boot                M         1       String       Start parameters
  nicArray            O         1..n    List         List
  contextArray        O         1..n    list         list of context
  volumeArray         O         1..n    List         List
availabilityZone      O         1       string       Usable field
  flavorId            M         1       String       server Flavor id
  metadata            O         1       List         Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
  userdata            O         1       string       Configuration information or scripts to use upon launch. Must be Base64 encoded.
                                                        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.
  securityGroups      O         1       List         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.
  serverGroup         O         1       string       the ServerGroup for anti-affinity and affinity
================ ========= ============ ======== ================================


**boot**

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  type                M         1       int        Startup mode
                                                     1. boot from the volume
                                                     2. boot from image
  volumeId            O         1       string          Volume Id(type=1)
  imageId             O         1       String          ImageId(type=2)
================ ========= ============ ======== ================================

**contextArray**

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  fileName            M         1       String          Injection file name
  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. )
================ ========= ============ ======== ================================


**volumeArray**

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  volumeId            M         1       String          Volume Id
================ ========= ============ ======== ================================

**nicArray**

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  portId              M         1       String          Port Id
================ ========= ============ ======== ================================


::

    {

        "tenant": "tenant1",

        "name": "vm1",

        "availabilityZone": "az1",

        "flavorName": "vm_large",

        "boot": {

            "type": 1,

            " volumeName": "volume1"

        },

        "flavorId": "vm_large_134213",

        "contextArray": [{

            "fileName": "test.yaml",

            "fileData": "…."

        }],

        "volumeArray": [{

            "volumeName": "vol1",

        }],

        "nicArray": [{

            "portId": "port_a"

        }],

        "metada": {

            "foo": "foo value"

        },

        "userdata": "abcdedf"

    }

7.1.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String     vim id
  vimName             O         1       string     vim name
  cloud-owner         M         1       String     cloud owner
cloud-region-id       M         1       string     cloud region id
  returnCode                    1       int        0: Already exist 1: Newly created
  id                  M         1       string     server id
  name                          1       string     server name
  tenantId            M         1       String     Tenant UUID
  boot                M         1       String      Start parameters
  nicArray            O         1..n    List           List
  volumeArray         O         1..n    List            List
availabilityZone      O         1       string           Usable field
  flavorId            M         1       String          server Flavor
  metadata            O         1       List            Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
  securityGroups      O         1       List            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.
  serverGroup         O          1      string           the ServerGroup for anti-affinity and affinity
  status              M          1      string           Server status,
                                                            0:INACTIVE,1:ACTIVE,2:ERROR
================ ========= ============ ======== ================================


202: accepted

500: failed

::

    {

    "id": "3c9eebdbbfd345658269340b9ea6fb73",

    "name": "vm1",

    "returnCode": 1,

    }

7.2. **Delete Server**
----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers/{serverid}
Operation              DELETE
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Delete a vserver on the VIM
===================== =========================================================

7.2.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

7.2.2. **Response**
>>>>>>>>>>>>>>>>>>>

204: no content

7.3. **List Server**
--------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers
Operation              GET
Direction              VNFLCM,NSLCM->MULTIVIM
Description            List vservers on the VIM
===================== =========================================================

7.3.1. **Request**
>>>>>>>>>>>>>>>>>>

msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/vms?{……}

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name                M         1       string          server name
================ ========= ============ ======== ================================

7.3.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String                                  vim id
  vimName             O         1       string                                  vim name
  cloud-owner         M         1       String                      cloud owner
cloud-region-id       M         1       string                      cloud region id
  servers             M         1       array                                   server list
  id                  M         1       string                                  server id
  name                M         1       string                                  server name
  tenantId            M         1       String                                  Tenant UUID
  boot                M         1       String                                  Start parameters
  nicArray             O        1..n    List                             List
  volumeArray          O        1..n    List                          List
availabilityZone      O         1       string                                  Usable field
  flavorId            M         1       String                                  server Flavor
  metada              O         1       keypair                                 Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
  securityGroups      O         1       List          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.
  serverGroup          O         1      string                              the ServerGroup for anti-affinity and affinity
================ ========= ============ ======== ================================


200: ok

500: failed

7.4. **Get Server**
-------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers/{serverid}
Operation              GET
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Get a vserver on the VIM
===================== =========================================================

7.4.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

7.4.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String      vim id
  vimName             O         1       string      vim name
  cloud-owner         M         1       String      cloud owner
cloud-region-id       M         1       string      cloud region id
  id                  M         1       string      server id
  name                M         1       string      server name
  tenantId            M         1       String      Tenant UUID
  boot                M         1       String      Start parameters
  nicArray             O        1..n    List        List
volumeArray            O        1..n    List        List
availabilityZone      O         1       string      Usable field
  flavorId            M         1       String      server Flavor
  metadata            O         1       List        Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
  serverGroup         O         1       List        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.
  serverGroup         O         1       string      the ServerGroup for anti-affinity and affinity
================ ========= ============ ======== ================================


200: ok

500: failed


7.5. **Heal Server**
----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers/{serverid}/action
Operation              POST
Direction              VNFLCM,NSLCM->MULTIVIM
Description            Act on a vserver on the VIM
===================== =========================================================

7.5.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  os-start            M         1       none       The action to start a stopped server.
  os-stop             M         1       none       The action to stop a running server.
  reboot              M         1       object     The action to reboot a server.
  type                O         1       int        The type of the reboot action.
                                                      The valid values are HARD and SOFT
================ ========= ============ ======== ================================


7.5.2. **Response**
>>>>>>>>>>>>>>>>>>>

Normal response codes: 202

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)

8. **Flavor Management**
^^^^^^^^^^^^^^^^^^^^^^^^

8.1. **Create Flavor**
----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors
Operation              POST
Direction              VNFLCM->MULTIVIM
Description            Create a flavor on the VIM
===================== =========================================================

8.1.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name                M         1       string     Flavor Name
  vcpu                M         1       int        Virtual CPU number
  memory              M         1       int        Memory size
  disk                M         1       int        The size of the root disk
  ephemeral           O         1       int        The size of the ephemeral disk
  swap                O         1       int        The size of the swap disk
  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.
  extraSpecs          O         0..N    List       EPA parameter
================ ========= ============ ======== ================================


8.1.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  id                  M         1       string     Flavor id
  name                M         1       string     Flavor name
  returnCode          M         1       int        0: Already exist 1: Newly created
  tenantId            M         1       String     Tenant UUID
  vcpu                M         1       int        Virtual CPU number
  memory              M         1       int        Memory size
  disk                M         1       int        The size of the root disk
  ephemeral           M         1       int        The size of the ephemeral disk
  swap                M         1       int        The size of the swap disk
  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.
  extraSpecs          O        0..N     List       EPA parameter
  vimId               M         1       String     vim id
  vimName             O         1       string     vim name
  cloud-owner         M         1       String     cloud owner
cloud-region-id       M         1       string     cloud region id
================ ========= ============ ======== ================================


8.2. **Delete Flavor**
----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors /{flavorid}
Operation              DELETE
Direction              VNFLCM->MULTIVIM
Description            Delete a flavor on the VIM
===================== =========================================================

8.2.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

8.2.2. **Response**
>>>>>>>>>>>>>>>>>>>

204: no content

8.3. **List Flavor**
--------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors
Operation              GET
Direction              VNFLCM,NSLCM->MULTIVIM
Description            List flavors on the VIM
===================== =========================================================

8.3.1. **Query**
>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name                M         1       string          Flavor name to filter out list
================ ========= ============ ======== ================================

8.3.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  flavors             M         0..N    list      Vm list
  id                  M         1       string    Flavor id
  name                M         1       string    Flavor Name
  vcpu                M         1       int       Virtual CPU number
  memory              M         1       int       Memory size
  disk                M         1       int       The size of the root disk
  ephemeral           M         1       int       The size of the ephemeral disk
  swap                M         1       int       The size of the swap disk
  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.
  extraSpecs          O         0..N    List      EPA parameter
  vimId               M         1       String    vim id
  vimName             O         1       string    vim name
  cloud-owner         M         1       String    cloud owner
cloud-region-id       M         1       string    cloud region id
  tenantId            M         1       String    Tenant UUID
================ ========= ============ ======== ================================


200: ok

500: failed

8.4. **Get Flavor**
-------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors/{flavorid}
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            Get a flavor on the VIM
===================== =========================================================

8.4.1. **Request**
>>>>>>>>>>>>>>>>>>

N/A

8.4.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  id                  M         1       string     Flavor id
  name                M         1       string     Flavor Name
  vcpu                M         1       int        Virtual CPU number
  memory              M         1       int        Memory size
  disk                M         1       int        The size of the root disk
  ephemeral           M         1       int        The size of the ephemeral disk
  swap                M         1       int        The size of the swap disk
  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.
  extraSpecs          O         0..N    List       EPA parameter
  vimId               M         1       String     vim id
  vimName             O         1       string     vim name
  cloud-owner         M         1       String     cloud owner
cloud-region-id       M         1       string     cloud region id
  tenantId            M         1       String     Tenant UUID
================ ========= ============ ======== ================================

200: ok

500: failed

9. **Volume Management**
^^^^^^^^^^^^^^^^^^^^^^^^

9.1. **Create Volume**
----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes
Operation              POST
Direction              VNFLCM->MULTIVIM
Description            Create volume on the VIM
===================== =========================================================

9.1.1. **Request**
>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name                M         1       string          Volume name
  volumeSize          M         1       int             Volume size
  imageId             O         1       string          Image UUID
  volumeType          O         1       string          Volume type
availabilityZone      O         1       string          Usable field
================ ========= ============ ======== ================================

::

    {

    "tenant": "tenant1",

    "volumeName": "volume1",

    "volumeSize": 3,

    "imageName": "cirros.qcow2",

    "volumeType": "volumetype1",

    "availabilityZone": "zone1"

    }

9.1.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  returnCode          M         1       int             0: Already exist 1: Newly created
  vimId               M         1       String          vim id
  vimName             O         1       string          vim name
  cloud-owner         M         1       String          cloud owner
cloud-region-id       M         1       string          cloud region id
  tenantId            M         1       String          Tenant UUID
  status              M         1       string          Volume status
  id                  M         1       string          Volume id
  name                M         1       string          Volume name
  volumeType          O         1       string          Volume type
availabilityZone      O         1       string          Availability Zone
================ ========= ============ ======== ================================

202: accepted

500: failed

::

    {

    "id": "bc9eebdbbfd356458269340b9ea6fb73",

    "name": "volume1",

    "returnCode": 1,

    }

9.2. **Delete Volume**
----------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes/{volumeId}
Operation              DELETE
Direction              VNFLCM->MULTIVIM
Description            Delete volume on the VIM
===================== =========================================================

9.2.1. **Request**
>>>>>>>>>>>>>>>>>>

    N/A

9.2.2. **Response**
>>>>>>>>>>>>>>>>>>>

    204: no content

9.3. **List Volumes**
---------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            List volumes on the VIM
===================== =========================================================

9.3.1. **Request**
>>>>>>>>>>>>>>>>>>

    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/volumes?{……}

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  name                M         1       string          Volume name
================ ========= ============ ======== ================================

9.3.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String                 vim id
  vimName             O         1       string                 vim name
  cloud-owner         M         1       String       cloud owner
cloud-region-id       M         1       string        cloud region id
  tenantId            M         1       String                 Tenant UUID
  volumes             M         1       Array
  id                  M         1       string                 Volume id
  name                M         1       string                 Volume name
  createTime          O         1       string                 Create time
  status              M         1       string                 Volume status
  volumeSize          M         1       int                    Volume size
  volumeType          M         1       string                 Volume type
availabilityZone      M         1       string                 Availability Zone
  attachments         M         1..n    list        List of additional information on the cloud disk
================ ========= ============ ======== ================================

200: ok

500: failed

::

    {

        "volumes": [

            {

                "status": "available",

                "name": "test",

                "attachments": [],

                "createTime": "2015-12-02T07:57:23.000000",

                " volumeType ": "ws",

                "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",

                "size": 20

            },

            {

                "status": "in-use",

                "name": "wangsong",

                "attachments": [

                    {

                        "device": "/dev/vdc",

                        "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",

                        "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",

                        "hostName": null,

                        "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"

                    }

                ],

                "createTime": "2015-12-02T06:39:40.000000",

                " volumeType ": null,

                "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",

                "size": 40

            }

        ]

    }

9.4. **Get Volumes**
--------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes/{volumeid}
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            Get volume on the VIM
===================== =========================================================

9.4.1. **Request**
>>>>>>>>>>>>>>>>>>

    N/A

9.4.2. **Response**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String                 vim id
  vimName             O         1       string                 vim name
  cloud-owner         M         1       String                      cloud owner
cloud-region-id       M         1       string                      cloud region id
  tenantId            M         1       String                 Tenant UUID
  id                            1       string                 Volume id
  name                          1       string                 Volume name
  createTime                    1       string                 Create time
  status                        1       string                 Volume status
  volumeType                    1       List         Volume type
  volumeSize                    1       int                    Volume size
availabilityZone      M         1       string                 Availability Zone
  attachments         M         1..n    list       List of additional information on the cloud disk
================ ========= ============ ======== ================================

**attachment:**

============== ========= ============ ======== ==================================
Parameter      Qualifier Cardinality  Content    Description
============== ========= ============ ======== ==================================
  device                      1       string          Device name
  serverId                    1       string          VM id
  volumeId                    1       string          Volume id
  hostName                    1       string          Host name
  id                          1       string          Device id
============== ========= ============ ======== ==================================

200: ok

500: failed

::

    {

        "status": "in-use",

        "name": "wangsong",

        "attachments": [

            {

                "device": "/dev/vdc",

                "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",

                "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",

                "hostName": null,

                "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"

            }

        ],

        "createTime": "2015-12-02T06:39:40.000000",

        "volumeType ": null,

        "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",

        "volumeSize ": 40

    }

10. **Tenant Management**
^^^^^^^^^^^^^^^^^^^^^^^^^

10.1. **List tenants**
----------------------


===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/tenants
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            List tenants on the VIM
===================== =========================================================


10.1.1. **Query**
>>>>>>>>>>>>>>>>>

================= ========= ============ ======== ================================
Parameter         Qualifier Cardinality  Content    Description
================= ========= ============ ======== ================================
name={tenantname}      O         1       string          Tenant name to filter output list
================= ========= ============ ======== ================================


10.1.2. **Response**
>>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ================================
  vimId               M         1       String          vim id
  vimName             O         1       string          vim name
  cloud-owner         M         1       String          cloud owner
cloud-region-id       M         1       string          cloud region id
  tenants             M         1       Array
  id                  M         1       string          tenant UUID
  name                M         1       string          tenant name
================ ========= ============ ======== ================================

200: ok

500: failed

::

    {

        " tenants ": [

            {

                "id": "1",

                "name": "test\_a"

            }

        ]

    }

11. **Limits**
^^^^^^^^^^^^^^

11.1. **List Limits of resouces**
---------------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/limits
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            Get limits on the VIM
===================== =========================================================


11.1.1. **Request**
>>>>>>>>>>>>>>>>>>>

N/A

11.1.2. **Response**
>>>>>>>>>>>>>>>>>>>>

======================== ========= ============ ======== ========================
Parameter                Qualifier Cardinality  Content    Description
======================== ========= ============ ======== ========================
  vimId                       M         1       String          vim id                                                          vimName                     O         1       string          vim name
  cloud-owner                 M         1       String          cloud owner
cloud-region-id               M         1       string          cloud region id                                       tenantId                      M         1       string          Tenant UUID                                                     maxPersonality                O         1       int             The number of allowed injected files for each tenant.
  maxPersonalitySize          O         1       int             The number of allowed bytes of content for each injected file.
  maxServerGroupMembers       O         1       int             The number of allowed members for each server group.
  maxServerGroups             O         1       int             The number of allowed server groups for each tenant.
  maxServerMeta               O         1       int             The number of allowed metadata items for each instance.
  maxTotalCores               O         1       int             The number of allowed instance cores for each tenant.
  maxTotalInstances           O         1       int             The number of allowed instances for each tenant.
  maxTotalKeypairs            O         1       int             The number of allowed key pairs for each user.
  maxTotalRAMSize             O         1       int             The amount of allowed instance RAM, in MB, for each tenant.
maxTotalVolumeGigabytes       O         1       int             The maximum total amount of volumes, in gibibytes (GiB).
  maxTotalVolumes             O         1       int             The maximum number of volumes.
  totalVolumesUsed            O         1       int             The total number of volumes used.
  totalGigabytesUsed          O         1       int             The total number of gibibytes (GiB) used.
  network                     O         1       int             The number of networks allowed for each project.
  subnet                      O         1       int             The number of subnets allowed for each project.
  subnetpool                  O         1       int             The number of subnet pools allowed for each project.
  security\_group\_rule       O         1       int             The number of security group rules allowed for each project.
  security\_group             O         1       int             The number of security groups allowed for each project.
  router                      O         1       int             The number of routers allowed for each project.
  port                        O         1       int             The number of ports allowed for each project.
======================== ========= ============ ======== ========================

200: ok

500: failed

::

    {

    "maxPersonality": 5,

    "maxPersonalitySize": 10240,

    "maxServerMeta": 128,

    "maxTotalCores": 20,

    "maxTotalInstances": 10,

    "maxTotalKeypairs": 100,

    "maxTotalRAMSize": 51200,

    "maxServerGroups": 10,

    "maxServerGroupMembers": 10,

    }

12. **Host Management**
^^^^^^^^^^^^^^^^^^^^^^^

12.1. **List hosts**
--------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/hosts
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            list hosts on the VIM
===================== =========================================================

12.1.1. **Request**
>>>>>>>>>>>>>>>>>>>

N/A

12.1.2. **Response**
>>>>>>>>>>>>>>>>>>>>

=============== ========= ============ ======== ==================================
Parameter       Qualifier Cardinality  Content    Description
=============== ========= ============ ======== ==================================
  vimId              M         1       String            vim id
  vimName            O         1       string            vim name
  cloud-owner        M         1       String            cloud owner
cloud-region-id      M         1       string            cloud region id
  tenantId           M         1       string            Tenant Name
  hosts              M         1       Array     List of host information
  service            M         1       string            The service running on the host
  name               M         1       string            host name
  zone               O         1       string            Available zone for the host
=============== ========= ============ ======== ==================================

200: ok

500: failed

::

    {

        "vimId": "123",

        "vimName": "vimName",

        "tenantId": "tenantId1"

        "hosts": [

            {

                "name": "b6e4adbc193d428ea923899d07fb001e",

                "service": "conductor",

                "zone": "internal",

                "vimId": "123",

                "vimName": "vimName",

                "tenantId": "tenantId1"

            },

            {

                "name": "09c025b0efc64211bd23fc50fa974cdf",

                "service": "compute",

                "zone": "nova"

                "vimId": "123",

                "vimName": "vimName",

                "tenantId": "tenantId1"

            },

            {

                "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",

                "service": "consoleauth",

                "zone": "internal"

                "vimId": "123",

                "vimName": "vimName",

                "tenantId": "tenantId1"

            },

            {

                "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",

                "service": "network",

                "zone": "internal"

                "vimId": "123",

                "vimName": "vimName",

                "tenantId": "tenantId1"

            },

            {

                "name": "abffda96592c4eacaf4111c28fddee17",

                "service": "scheduler",

                "zone": "internal"

                "vimId": "123",

                "vimName": "vimName",

                "tenantId": "tenantId1"

            }

        ]

    }

12.2. **Get host**
------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/hosts/{hostname}
Operation              GET
Direction              VNFLCM->MULTIVIM
Description            Get a host on the VIM
===================== =========================================================


12.2.1. **Request**
>>>>>>>>>>>>>>>>>>>

12.2.2. **Response**
>>>>>>>>>>>>>>>>>>>>

=============== ========= ============ ======== ==================================
Parameter       Qualifier Cardinality  Content    Description
=============== ========= ============ ======== ==================================
  vimId              M         1       String                vim id
  vimName            O         1       string                vim name
cloud-owner          M         1       String                cloud owner
cloud-region-id      M         1       string                cloud region id
  tenantId           M         1       string                Tenant Name
  host               M         1       List     Host resource info
  resource           M                 1..N                Object                Resource description
  cpu                M         1       Int                   The cpu info on the host.
  memory_mb          M         1       int                   The memory info on the host (in MB).
  name               M         1       string                host name
  project            M         1       string                Value: total, used_now, used_max or specific project_id
  disk_gb            M         1       int                   The disk info on the host (in GB).
=============== ========= ============ ======== ==================================

200: ok

500: failed

::

    {

        "cpu": 1,

        "disk\_gb": 1028,

        "name": "c1a7de0ac9d94e4baceae031d05caae3",

        "memory\_mb": 8192,

        "vimId": "123",

        "vimName": "vimName",

        "tenantId": "tenantId1",

        "host": [

            {

                "memory\_mb": 4960,

                "name": " c1a7de0ac9d94e4baceae031d05caae3",

                "disk\_gb": 92,

                "project": "(total)",

                "cpu": 4

            },

            {

                "memory\_mb": 1536,

                "name": " c1a7de0ac9d94e4baceae031d05caae3",

                "disk\_gb": 2,

                "project": "(used\_now)",

                "cpu": 2

            },

            {

                "memory\_mb": 1024,

                "name": " c1a7de0ac9d94e4baceae031d05caae3",

                "disk\_gb": 2,

                "project": "(used\_max)",

                "cpu": 2

            },

            {

                "memory\_mb": 1024,

                "name": " c1a7de0ac9d94e4baceae031d05caae3",

                "disk\_gb": 2,

                "project": "568f7ec425db472ba348251bf1e7eebd",

                "cpu": 2

            }

        ],

        "vimName": "openstack\_newton",

        "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",

        "tenantId": "568f7ec425db472ba348251bf1e7eebd"

    }

13. **VIM Management**
^^^^^^^^^^^^^^^^^^^^^^

13.1. **Update VIM Info**
-------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/registry
Operation              POST
Direction              ESR-> MULTICLOUD
Description            Register a VIM instance to ONAP
===================== =========================================================

13.1.1. **Request**
>>>>>>>>>>>>>>>>>>>

============== ========= ============ ======== ==================================
Parameter      Qualifier Cardinality  Content    Description
============== ========= ============ ======== ==================================
defaultTenant       M         1       string          default tenant name
============== ========= ============ ======== ==================================

13.1.2. **Response**
>>>>>>>>>>>>>>>>>>>>

NA

202: accept

400: failed

13.2. **Unregistry VIM**
------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}
Operation              DELETE
Direction              ESR-> MULTICLOUD
Description            Unregister a VIM instance from ONAP
===================== =========================================================


13.2.1. **Request**
>>>>>>>>>>>>>>>>>>>

NA

13.2.2. **Response**
>>>>>>>>>>>>>>>>>>>>

NA

204: No content found

400: failed



14. **infrastructure workload LCM**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

14.1. **Instantiate infrastructure workload**
----------------------------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload
Operation              POST
Direction              SO-> MULTICLOUD
Description            Instantiate infrastructure workload
===================== =========================================================

14.1.1. **Request**
>>>>>>>>>>>>>>>>>>>

================ ========= ============ ======== ==================================
Parameter        Qualifier Cardinality  Content    Description
================ ========= ============ ======== ==================================
generic-vnf-id       O         1        string          generif VNF ID to search AAI object
vf-module-id         O         1        string          vf module id  to search AAI object
oof_directives       O         1        Object          oof directives to update template_data
sdnc_directives      O         1        Object          sdnc directives to update template_data
template_type        M         1        string          template type with which the MultiCloud plugin inteprates template_data
                                                            "heat",etc.
template_data        M         1        Object          workload template data to instantiate workload onto VIM/Cloud instance
================ ========= ============ ======== ==================================

::

  {
     "generic-vnf-id":"vnf-id-111111",
     "vf-module-id":"vf-module-id-2222222",
     "oof_directives":{},
     "sdnc_directives":{},
     "template_type":"heat",
     "template_data":{{
         "files":{  },
         "disable_rollback":true,
         "parameters":{
            "flavor":"m1.heat"
         },
         "stack_name":"teststack",
         "template":{
            "heat_template_version":"2013-05-23",
            "description":"Simple template to test heat commands",
            "parameters":
            {
               "flavor":{
                  "default":"m1.tiny",
                  "type":"string"
               }
            },
            "resources":{
               "hello_world":{
                  "type":"OS::Nova::Server",
                  "properties":{
                     "key_name":"heat_key",
                     "flavor":{
                        "get_param":"flavor"
                     },
                     "image":"40be8d1a-3eb9-40de-8abd-43237517384f",
                     "user_data":"#!/bin/bash -xv\necho \"hello world\" &gt; /root/hello-world.txt\n"
                  }
               }
            }
         },
         "timeout_mins":60
     }
  }

14.1.2. **Response**
>>>>>>>>>>>>>>>>>>>>

================== ========= ============ ======== ==================================
Parameter          Qualifier Cardinality  Content    Description
================== ========= ============ ======== ==================================
template_type          M         1        string          template type with which the MultiCloud plugin inteprates template_data
                                                            "heat",etc.
workload_id            M         1        string          The ID of infrastructure workload resource
template_response      M         1        Object          response from VIM/Cloud instance which is instantiating workload
================== ========= ============ ======== ==================================


201: Created

202: Accepted

400: Bad Request

401: Unauthorized

409: Conflict

::

    {
        "template_type":"heat",
        "workload_id": "1234567890abcd"
        "template_response":
        {
            "stack": {
            "id": "1234567890abcd",
            "links": [
                {
                     "href": "",
                     "rel": "self"
                }
            ]
        }
    }


14.2. **Query infrastructure workload**
---------------------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload/{workload-id}
Operation              GET
Direction              SO-> MULTICLOUD
Description            Query the status of the infrastructure workload
===================== =========================================================


14.2.1. **Request**
>>>>>>>>>>>>>>>>>>>

NA

14.2.2. **Response**
>>>>>>>>>>>>>>>>>>>>

================== ========= ============ ======== ==================================
Parameter          Qualifier Cardinality  Content    Description
================== ========= ============ ======== ==================================
template_type          M         1        string          template type with which the MultiCloud plugin inteprates template_data
                                                            "heat",etc.
workload_id            M         1        string          The ID of infrastructure workload resource
workload_status        M         1        string          Status of infrastructure workload:
                                                              DELETE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED
                                                              DELETE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED
                                                              UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED
================== ========= ============ ======== ==================================


200: OK

400: Bad Request

401: Unauthorized

404: Not Found

500: Internal Server Error

::

    {
        "template_type":"heat",
        "workload_id": "1234567890abcd",
        "workload_status":"CREATE_IN_PROCESS"
    }


14.3. **Delete infrastructure workload**
----------------------------------------

===================== =========================================================
IF Definition          Description
===================== =========================================================
URI                    msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload/{workload-id}
Operation              DELETE
Direction              SO-> MULTICLOUD
Description            DELETE the infrastructure workload
===================== =========================================================


14.3.1. **Request**
>>>>>>>>>>>>>>>>>>>

NA

14.3.2. **Response**
>>>>>>>>>>>>>>>>>>>>

NA


204: No Content, The server has fulfilled the request by deleting the resource.

400: Bad Request

401: Unauthorized

404: Not Found

500: Internal Server Error