2 This work is licensed under a Creative Commons Attribution 4.0
5 ================================
6 MultiCloud API v1 Specification
7 ================================
9 The is the specification for MultiCloud API version v1.
11 Note: "MultiCloud API Specification V1" refers to the specification for MultiCloud API version v0
19 The scope of the present document is to describe the MutliCloud NorthBound API
22 2. **Terms, Definitions and Abbreviations**
23 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25 For the purposes of the present document, the following abbreviations
28 ===================== =========================================================
29 Abbreviation Description
30 ===================== =========================================================
31 NFVO Network Functions Virtualization Orchestrator
32 VNFM Virtual Network Function Management
33 VIM Virtualized Infrastructure Manager
34 MultiVIM/MultiCloud MultVIM driver services for OPEN-O to drive VIM instances
35 ===================== =========================================================
37 3. **Image Management**
38 ^^^^^^^^^^^^^^^^^^^^^^^
43 ===================== =========================================================
44 IF Definition Description
45 ===================== =========================================================
46 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images
48 Direction NSLCM->MULTIVIM
49 Description Create Image and Upload the image file to the VIM
50 ===================== =========================================================
55 ================ ========= ============ ======== ================================
56 Parameter Qualifier Cardinality Content Description
57 ================ ========= ============ ======== ================================
58 name M 1 String Image Name
59 imagePath M 1 String Image Local Path from catalog
60 imageType M 1 String Image Type
61 ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
62 visibility O 1 string Visibility for this image.
63 public, private, shared, or community
64 containerFormat M 1 string ami,ari,aki,bare,ovf,ova, docker
65 properties O 0..N List Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic"
66 ================ ========= ============ ======== ================================
73 "imageName": "cirros",
75 "imagePath": "/home/cirros.qcow2",
79 "containerFormat":"bare"
86 ================ ========= ============ ======== ================================
87 Parameter Qualifier Cardinality Content Description
88 ================ ========= ============ ======== ================================
89 id M 1 String Image UUID in the VIM
90 name M 1 String Image Name
91 returnCode M 1 Int 0: Already exist 1: Newly created
92 imageType M 1 String Image Type
93 ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
94 containerFormat M 1 string ami,?ari,?aki,?bare,?ovf,?ova, ?docker
95 visibility O 1 string Visibility for this image.
96 public, private, shared, or community
97 properties O 0..N List of key-value pairs
98 vimid M 1 String vim id
99 vimName O 1 string vim name
100 cloud-owner M 1 String cloud owner
101 cloud-region-id M 1 string cloud region id
102 tenantId M 1 String Tenant UUID
103 ================ ========= ============ ======== ================================
112 "id": "3c9eebdbbfd345658269340b9ea6fb73",
117 3.2. **Delete Image**
118 ---------------------
120 ===================== =========================================================
121 IF Definition Description
122 ===================== =========================================================
123 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images/{imageId}
125 Direction NSLCM->MULTIVIM
126 Description Delete Image
127 ===================== =========================================================
142 ===================== =========================================================
143 IF Definition Description
144 ===================== =========================================================
145 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images
147 Direction NSLCM->MULTIVIM
148 Description Query Image list
149 ===================== =========================================================
154 ============== ========= ============ ======== ================================
155 Parameter Qualifier Cardinality Content Description
156 ============== ========= ============ ======== ================================
157 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.
158 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.
159 name O 1 String Filters the response by a name, as a string. A valid value is the name of an image
160 ============== ========= ============ ======== ================================
167 ================ ========= ============ ======== ================================
168 Parameter Qualifier Cardinality Content Description
169 ================ ========= ============ ======== ================================
170 images M 0..N List Image List
172 id M 1 String Image ID
174 size M 1 int Image Size
176 name M 1 String Image Name
178 status M 1 String Image Status
180 imageType M 1 String Image Type
181 ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
182 containerFormat M 1 string ami,?ari,?aki,?bare,?ovf,?ova, ?docker
183 visibility O 1 string Visibility for this image.
184 public, private, shared, or community
185 vimId M 1 String vim id
186 vimName O 1 string vim name
187 cloud-owner M 1 String cloud owner
188 cloud-region-id M 1 string cloud region id
189 tenantId M 1 String Tenant UUID
190 ================ ========= ============ ======== ================================
203 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
205 "name": "vim-plus-cgsl40g-z.qcow2"
213 ===================== =========================================================
214 IF Definition Description
215 ===================== =========================================================
216 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/images/{imageid}
218 Direction NSLCM->MULTIVIM
219 Description Query Image Information
220 ===================== =========================================================
232 ================ ========= ============ ======== ================================
233 Parameter Qualifier Cardinality Content Description
234 ================ ========= ============ ======== ================================
235 id M 1 String Image ID
236 size M 1 int Image Size
237 name M 1 String Image Name
238 status M 1 String Image Status
239 imageType M 1 String Image Type
240 ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso
241 containerFormat M 1 string ami,?ari,?aki,?bare,?ovf,?ova, ?docker
242 visibility O 1 string Visibility for this image.
243 public, private, shared, or community
244 vimId M 1 String vim id
245 vimName M 1 string vim name
246 cloud-owner M 1 String cloud owner
247 cloud-region-id M 1 string cloud region id
248 tenantId M 1 String Tenant UUID
249 ================ ========= ============ ======== ================================
261 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
263 "name": "vim-plus-cgsl40g-z.qcow2"
266 4. **Network Management**
267 ^^^^^^^^^^^^^^^^^^^^^^^^^
269 4.1. **Create Network**
270 -----------------------
272 ===================== =========================================================
273 IF Definition Description
274 ===================== =========================================================
275 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks
277 Direction VNFLCM,NSLCM->MULTIVIM
278 Description Create network on the VIM
279 ===================== =========================================================
284 ================ ========= ============ ======== ================================
285 Parameter Qualifier Cardinality Content Description
286 ================ ========= ============ ======== ================================
287 name M 1 String Logical network name
288 shared M 1 boolean Whether to share(1:sharing;0:private)
289 vlanTransparent O 1 boolean Whether to support VLAN pass through(1:true;0:false)
290 networkType O 1 String Network type
291 flat, vlan, vxlan, gre, portgroup
292 segmentationId O 1 Int id of paragraph
293 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.
294 routerExternal O 1 boolean Indicates whether this network can provide floating IPs via a router.
295 ================ ========= ============ ======== ================================
302 "networkName": "ommnet",
304 "vlanTransparent": 1,
305 "networkType": "vlan",
306 "segmentationId": 202,
307 "physicalNetwork": "ctrl",
314 ================ ========= ============ ======== ================================
315 Parameter Qualifier Cardinality Content Description
316 ================ ========= ============ ======== ================================
317 status M 1 string Network status
318 id M 1 string Network id
319 name M 1 string Network name
320 tenantId M 1 String Tenant UUID
321 segmentationId O 1 int Segmentation id
322 networkType O 1 string Network type
323 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.
324 vlanTransparent O 1 boolean Whether to support VLAN pass through(1:true;0:false)
325 shared O 1 boolean Whether to share(1:sharing;0:private)
326 routerExternal O 1 boolean Indicates whether this network can provide floating IPs via a router.
327 returnCode M 1 int 0: Already exist 1: Newly created
328 vimId M 1 String vim id
329 vimName O 1 string vim name
330 cloud-owner M 1 String cloud owner
331 cloud-region-id M 1 string cloud region id
332 ================ ========= ============ ======== ================================
345 "id": "3c9eebdbbfd345658269340b9ea6fb73",
348 "networkName": "ommnet",
350 "vlanTransparent": 1,
351 "networkType": "vlan",
352 "segmentationId": 202,
353 "physicalNetwork": "ctrl",
357 4.2. **Delete Network**
358 -----------------------
360 ===================== =========================================================
361 IF Definition Description
362 ===================== =========================================================
363 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks/{networkId}
365 Direction VNFLCM,NSLCM->MULTIVIM
366 Description Delete a network on the VIM
367 ===================== =========================================================
379 4.3. **List Network**
380 ---------------------
382 ===================== =========================================================
383 IF Definition Description
384 ===================== =========================================================
385 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks
387 Direction VNFLCM,NSLCM->MULTIVIM
388 Description List networks on the VIM
389 ===================== =========================================================
394 ================ ========= ============ ======== ================================
395 Parameter Qualifier Cardinality Content Description
396 ================ ========= ============ ======== ================================
397 name O 1 String Filters the response by a name, as a string. A valid value is the name of a network
398 ================ ========= ============ ======== ================================
403 ================ ========= ============ ======== ================================
404 Parameter Qualifier Cardinality Content Description
405 ================ ========= ============ ======== ================================
406 vimId M 1 String vim id
407 vimName O 1 string vim name
408 cloud-owner M 1 String cloud owner
409 cloud-region-id M 1 string cloud region id
410 networks 0..N List Network list
411 status M 1 string Network status
412 id M 1 string Network id
413 name M 1 string Network name
414 tenantId M 1 String Tenant UUID
415 segmentationId O 1 int Segmentation id
416 networkType O 1 string Network type
417 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.
418 vlanTransparent O 1 boolean Whether to support VLAN pass through(1:true;0:false)
419 shared O 1 boolean Whether to share(1:sharing;0:private)
420 routerExternal O 1 boolean Indicates whether this network can provide floating IPs via a router
421 ================ ========= ============ ======== ================================
441 "id": "3c9eebdbbfd345658269340b9ea6fb73",
447 "networkName": "ommnet",
451 "vlanTransparent": 1,
453 "networkType": "vlan",
455 "segmentationId": 202,
457 "physicalNetwork ": "ctrl",
468 ===================== =========================================================
469 IF Definition Description
470 ===================== =========================================================
471 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/networks/{networkId}
473 Direction VNFLCM,NSLCM->MULTIVIM
474 Description Get a network on the VIM
475 ===================== =========================================================
485 ================ ========= ============ ======== ================================
486 Parameter Qualifier Cardinality Content Description
487 ================ ========= ============ ======== ================================
488 status M 1 string Network status
489 id M 1 string Network id
490 name M 1 string Network name
491 tenantId M 1 String Tenant UUID
492 segmentationId O 1 int Segmentation id
493 networkType O 1 string Network type
494 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.
495 vlanTransparent O 1 boolean Whether to support VLAN pass through(1:true;0:false)
496 shared O 1 boolean Whether to share(1:sharing;0:private)
497 routerExternal O 1 boolean Indicates whether this network can provide floating IPs via a router.
498 returnCode M 1 int 0: Already exist 1: Newly created
499 vimId M 1 String vim id
500 vimName O 1 string vim name
501 cloud-owner M 1 String cloud owner
502 cloud-region-id M 1 string cloud region id
503 ================ ========= ============ ======== ================================
519 "id": "3c9eebdbbfd345658269340b9ea6fb73",
525 "networkName": "ommnet",
529 "vlanTransparent": 1,
531 "networkType":"vlan",
533 "segmentationId":202,
535 "physicalNetwork ":"ctrl",
541 5. **Subnetwork Management**
542 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
544 5.1. **Create Subnets**
545 -----------------------
548 ===================== =========================================================
549 IF Definition Description
550 ===================== =========================================================
551 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets
553 Direction VNFLCM,NSLCM->MULTIVIM
554 Description Create subnet on the VIM
555 ===================== =========================================================
560 ================ ========= ============ ======== ================================
561 Parameter Qualifier Cardinality Content Description
562 ================ ========= ============ ======== ================================
563 networkId M 1 String Network Id
564 name M 1 String SubnetName
565 cidr M 1 String Subnet cidr
566 ipVersion M 1 Int Ip type
568 enableDhcp O 1 boolean Whether to allow
570 gatewayIp O 1 String Gateway ip
571 dnsNameservers O 1..n List List of servers
572 hostRoutes O 1..n List List of routes
573 allocationPools O 1..n list List of allocation
575 -->start O 1 String Start ip
576 -->end O 1 String End ip
577 ================ ========= ============ ======== ================================
585 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
587 "subnetName": "subnet1",
589 "cidr": "10.43.35.0/24",
595 "gatewayIp": "10.43.35.1",
597 "dnsNameservers": [],
599 "allocationPools": [{
601 "start": "192.168.199.2",
603 "end": "192.168.199.254"
614 ================ ========= ============ ======== ================================
615 Parameter Qualifier Cardinality Content Description
616 ================ ========= ============ ======== ================================
617 returnCode M 1 int 0: Already exist 1: Newly created
618 vimId M 1 String vim id
619 vimName O 1 string vim name
620 cloud-owner M 1 String cloud owner
621 cloud-region-id M 1 string cloud region id
622 status M 1 string subnetwork status
623 id M 1 string subNetwork id
624 tenantId M 1 String Tenant UUID
625 networkId O 1 String Network Id
626 networkName O 1 String Network Name
627 name M 1 String SubnetName
628 cidr M 1 String Subnet cidr
629 ipVersion M 1 Int Ip type
631 enableDhcp O 1 boolean Whether to allow
633 gatewayIp O 1 String Gateway ip
634 dnsNameservers O 1..n List List of servers
635 hostRoutes O 1.. List List of routes
636 allocationPools O 1..n List list of allocation
638 -->start O 1 String Start ip
639 -->end O 1 String End ip
640 ================ ========= ============ ======== ================================
658 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
662 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
666 "cidr": "10.43.35.0/24",
672 "gatewayIp": "10.43.35.1",
674 "dnsNameservers": [],
676 "allocationPools": [{
678 "start": "192.168.199.2",
680 "end": "192.168.199.254"
688 5.2. **Delete Subnets**
689 -----------------------
691 ===================== =========================================================
692 IF Definition Description
693 ===================== =========================================================
694 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets/{subnetId}
696 Direction VNFLCM,NSLCM->MULTIVIM
697 Description Delete a subnet on the VIM
698 ===================== =========================================================
710 5.3. **List Subnets**
711 ---------------------
713 ===================== =========================================================
714 IF Definition Description
715 ===================== =========================================================
716 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets
718 Direction VNFLCM,NSLCM->MULTIVIM
719 Description List subnets on the VIM
720 ===================== =========================================================
725 msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/subnets?{……}
727 ================ ========= ============ ======== ================================
728 Parameter Qualifier Cardinality Content Description
729 ================ ========= ============ ======== ================================
730 name O 1 String Filters fields of the response by a name, as a string. A valid value is the name of a subnet
731 ================ ========= ============ ======== ================================
736 ================ ========= ============ ======== ================================
737 Parameter Qualifier Cardinality Content Description
738 ================ ========= ============ ======== ================================
739 vimId M 1 String vim id
740 vimName O 1 string vim name
741 cloud-owner M 1 String cloud owner
742 cloud-region-id M 1 string cloud region id
743 subnets M 0..N List Network list
744 status 1 string subnetwork status
745 id 1 string subNetwork id
746 tenantId M 1 String Tenant UUID
747 networkId O 1 String Network Id
748 networkName O 1 String Network Name
749 name M 1 String SubnetName
750 cidr M 1 String Subnet cidr
751 ipVersion M 1 Int Ip type
753 enableDhcp O 1 boolean Whether to allow
755 gatewayIp O 1 String Gateway ip
756 dnsNameservers O 1..n List List of servers
757 hostRoutes O 1.. List List of routes
758 allocationPools O 1..n List list of allocation
760 -->start O 1 String Start ip
761 -->end O 1 String End ip
762 ================ ========= ============ ======== ================================
782 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
786 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
790 "cidr": "10.43.35.0/24",
796 "gatewayIp": "10.43.35.1",
798 "dnsNameservers": [],
800 "allocationPools": [{
802 "start": "192.168.199.2",
804 "end": "192.168.199.254"
819 ===================== =========================================================
820 IF Definition Description
821 ===================== =========================================================
822 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/subnets/{subnetid}
824 Direction VNFLCM,NSLCM->MULTIVIM
825 Description Get subnet on the VIM
826 ===================== =========================================================
836 ================ ========= ============ ======== ================================
837 Parameter Qualifier Cardinality Content Description
838 ================ ========= ============ ======== ================================
839 vimId M 1 String vim id
840 vimName O 1 string vim name
841 cloud-owner M 1 String cloud owner
842 cloud-region-id M 1 string cloud region id
843 status 1 string subnetwork status
844 id 1 string subNetwork id
845 tenantId M 1 String Tenant UUID
846 networkId O 1 String Network Id
847 networkName O 1 String Network Name
848 name M 1 String SubnetName
849 cidr M 1 String Subnet cidr
850 ipVersion M 1 Int Ip type
852 enableDhcp O 1 boolean Whether to allow
854 gatewayIp O 1 String Gateway ip
855 dnsNameservers O 1..n List List of servers
856 hostRoutes O 1.. List List of routes
857 allocationPools O 1..n List list of allocation
859 -->start O 1 String Start ip
860 -->end O 1 String End ip
861 ================ ========= ============ ======== ================================
873 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
877 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
881 "cidr": "10.43.35.0/24",
887 "gatewayIp": "10.43.35.1",
889 "dnsNameservers": [],
891 "allocationPools": [{
893 "start": "192.168.199.2",
895 "end": "192.168.199.254"
906 6.1. **Create Virtual Port**
907 ----------------------------
909 ===================== =========================================================
910 IF Definition Description
911 ===================== =========================================================
912 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports
914 Direction VNFLCM->MULTIVIM
915 Description Create a vport on the VIM
916 ===================== =========================================================
921 ================ ========= ============ ======== ================================
922 Parameter Qualifier Cardinality Content Description
923 ================ ========= ============ ======== ================================
924 networkId M 1 string Network UUID
925 subnetId O 1 string Subnet UUID
926 name M 1 string Port name
927 macAddress O 1 string Mac address
928 ip O 1 string Ip address
929 vnicType O 1 string Virtual network card type,
930 the value of three kinds of normal/direct/macvtap
931 securityGroups O 1 string The IDs of security groups applied to the port
932 ================ ========= ============ ======== ================================
937 ================ ========= ============ ======== ================================
938 Parameter Qualifier Cardinality Content Description
939 ================ ========= ============ ======== ================================
940 returnCode M 1 int 0: Already exist 1: Newly created
941 vimId M 1 String vim id
942 vimName O 1 string vim name
943 cloud-owner M 1 String cloud owner
944 cloud-region-id M 1 string cloud region id
945 status M 1 string status
946 id M 1 string Port Id
947 name M 1 string Port name
948 tenantId M 1 String Tenant UUID
949 networkName M 1 string Network name
950 networkId M 1 string Network Id
951 subnetName M 1 string Subnet name
952 subnetId M 1 string SubnetId
953 macAddress O 1 string Mac address
954 ip O 1 string Ip address
955 vnicType O 1 string Virtual network card type,
956 the value of three kinds of normal/direct/macvtap
957 securityGroups O 1 string List of security group names.
958 ================ ========= ============ ======== ================================
960 6.2. **Delete Virtual Port**
961 ----------------------------
963 ===================== =========================================================
964 IF Definition Description
965 ===================== =========================================================
966 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports/{portid}
968 Direction VNFLCM->MULTIVIM
969 Description Delete a vport on the VIM
970 ===================== =========================================================
982 6.3. **List Virtual Port**
983 --------------------------
985 ===================== =========================================================
986 IF Definition Description
987 ===================== =========================================================
988 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports
990 Direction VNFLCM->MULTIVIM
991 Description List vports on the VIM
992 ===================== =========================================================
997 ================ ========= ============ ======== ================================
998 Parameter Qualifier Cardinality Content Description
999 ================ ========= ============ ======== ================================
1000 name M 1 string Port name to filter out list of virtual ports
1001 ================ ========= ============ ======== ================================
1006 ================ ========= ============ ======== ================================
1007 Parameter Qualifier Cardinality Content Description
1008 ================ ========= ============ ======== ================================
1009 vimId M 1 String vim id
1010 vimName O 1 string vim name
1011 cloud-owner M 1 String cloud owner
1012 cloud-region-id M 1 string cloud region id
1013 tenantId M 1 String Tenant UUID
1014 Ports M 0..N List ports
1015 id M 1 string Port Id
1016 name M 1 string Port name
1017 status M 1 string status
1018 networkName O 1 string Network name
1019 networkId M 1 string Network Id
1020 subnetName O 1 string Subnet name
1021 subnetId M 1 string SubnetId
1022 macAddress O 1 string Mac address
1023 ip O 1 string Ip address
1024 vnicType O 1 string Virtual network card type,
1025 the value of three kinds of normal/direct/macvtap
1026 securityGroups O 1 string List of security group names.
1027 ================ ========= ============ ======== ================================
1034 6.4. **Get Virtual Port**
1035 -------------------------
1037 ===================== =========================================================
1038 IF Definition Description
1039 ===================== =========================================================
1040 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/ports/{portid}
1042 Direction VNFLCM->MULTIVIM
1043 Description Get a vport on the VIM
1044 ===================== =========================================================
1054 =============== ========= ============ ======== =================================
1055 Parameter Qualifier Cardinality Content Description
1056 =============== ========= ============ ======== =================================
1057 vimId M 1 String vim id
1058 vimName O 1 string vim name
1059 cloud-owner M 1 String cloud owner
1060 cloud-region-id M 1 string cloud region id
1061 status M 1 string status
1062 id M 1 string Port Id
1063 name M 1 string Port name
1064 tenantId M 1 String Tenant UUID
1065 networkName M 1 string Network name
1066 networkId M 1 string Network Id
1067 subnetName M 1 string Subnet name
1068 subnetId M 1 string SubnetId
1069 macAddress O 1 string Mac address
1070 ip O 1 string Ip address
1071 vnicType O 1 string Virtual network card type,
1072 the value of three kinds of normal/direct/macvtap
1073 securityGroups O 1 string List of security group names
1074 =============== ========= ============ ======== =================================
1081 7. **Server Management**
1082 ^^^^^^^^^^^^^^^^^^^^^^^^
1084 7.1. **Create Server**
1085 ----------------------
1087 ===================== =========================================================
1088 IF Definition Description
1089 ===================== =========================================================
1090 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers
1092 Direction VNFLCM->MULTIVIM
1093 Description Create a vserver on the VIM
1094 ===================== =========================================================
1099 ================ ========= ============ ======== ================================
1100 Parameter Qualifier Cardinality Content Description
1101 ================ ========= ============ ======== ================================
1102 name M 1 string server name
1103 boot M 1 String Start parameters
1104 nicArray O 1..n List List
1105 contextArray O 1..n list list of context
1106 volumeArray O 1..n List List
1107 availabilityZone O 1 string Usable field
1108 flavorId M 1 String server Flavor id
1109 metadata O 1 List Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
1110 userdata O 1 string Configuration information or scripts to use upon launch. Must be Base64 encoded.
1111 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.
1112 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.
1113 serverGroup O 1 string the ServerGroup for anti-affinity and affinity
1114 ================ ========= ============ ======== ================================
1119 ================ ========= ============ ======== ================================
1120 Parameter Qualifier Cardinality Content Description
1121 ================ ========= ============ ======== ================================
1122 type M 1 int Startup mode
1123 1. boot from the volume
1125 volumeId O 1 string Volume Id(type=1)
1126 imageId O 1 String ImageId(type=2)
1127 ================ ========= ============ ======== ================================
1131 ================ ========= ============ ======== ================================
1132 Parameter Qualifier Cardinality Content Description
1133 ================ ========= ============ ======== ================================
1134 fileName M 1 String Injection file name
1135 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. )
1136 ================ ========= ============ ======== ================================
1141 ================ ========= ============ ======== ================================
1142 Parameter Qualifier Cardinality Content Description
1143 ================ ========= ============ ======== ================================
1144 volumeId M 1 String Volume Id
1145 ================ ========= ============ ======== ================================
1149 ================ ========= ============ ======== ================================
1150 Parameter Qualifier Cardinality Content Description
1151 ================ ========= ============ ======== ================================
1152 portId M 1 String Port Id
1153 ================ ========= ============ ======== ================================
1160 "tenant": "tenant1",
1164 "availabilityZone": "az1",
1166 "flavorName": "vm_large",
1172 " volumeName": "volume1"
1176 "flavorId": "vm_large_134213",
1180 "fileName": "test.yaml",
1188 "volumeName": "vol1",
1204 "userdata": "abcdedf"
1211 ================ ========= ============ ======== ================================
1212 Parameter Qualifier Cardinality Content Description
1213 ================ ========= ============ ======== ================================
1214 vimId M 1 String vim id
1215 vimName O 1 string vim name
1216 cloud-owner M 1 String cloud owner
1217 cloud-region-id M 1 string cloud region id
1218 returnCode 1 int 0: Already exist 1: Newly created
1219 id M 1 string server id
1220 name 1 string server name
1221 tenantId M 1 String Tenant UUID
1222 boot M 1 String Start parameters
1223 nicArray O 1..n List List
1224 volumeArray O 1..n List List
1225 availabilityZone O 1 string Usable field
1226 flavorId M 1 String server Flavor
1227 metadata O 1 List Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
1228 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.
1229 serverGroup O 1 string the ServerGroup for anti-affinity and affinity
1230 status M 1 string Server status,
1231 0:INACTIVE,1:ACTIVE,2:ERROR
1232 ================ ========= ============ ======== ================================
1243 "id": "3c9eebdbbfd345658269340b9ea6fb73",
1251 7.2. **Delete Server**
1252 ----------------------
1254 ===================== =========================================================
1255 IF Definition Description
1256 ===================== =========================================================
1257 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers/{serverid}
1259 Direction VNFLCM,NSLCM->MULTIVIM
1260 Description Delete a vserver on the VIM
1261 ===================== =========================================================
1273 7.3. **List Server**
1274 --------------------
1276 ===================== =========================================================
1277 IF Definition Description
1278 ===================== =========================================================
1279 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers
1281 Direction VNFLCM,NSLCM->MULTIVIM
1282 Description List vservers on the VIM
1283 ===================== =========================================================
1288 msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/vms?{……}
1290 ================ ========= ============ ======== ================================
1291 Parameter Qualifier Cardinality Content Description
1292 ================ ========= ============ ======== ================================
1293 name M 1 string server name
1294 ================ ========= ============ ======== ================================
1299 ================ ========= ============ ======== ================================
1300 Parameter Qualifier Cardinality Content Description
1301 ================ ========= ============ ======== ================================
1302 vimId M 1 String vim id
1303 vimName O 1 string vim name
1304 cloud-owner M 1 String cloud owner
1305 cloud-region-id M 1 string cloud region id
1306 servers M 1 array server list
1307 id M 1 string server id
1308 name M 1 string server name
1309 tenantId M 1 String Tenant UUID
1310 boot M 1 String Start parameters
1311 nicArray O 1..n List List
1312 volumeArray O 1..n List List
1313 availabilityZone O 1 string Usable field
1314 flavorId M 1 String server Flavor
1315 metada O 1 keypair Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
1316 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.
1317 serverGroup O 1 string the ServerGroup for anti-affinity and affinity
1318 ================ ========= ============ ======== ================================
1328 ===================== =========================================================
1329 IF Definition Description
1330 ===================== =========================================================
1331 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers/{serverid}
1333 Direction VNFLCM,NSLCM->MULTIVIM
1334 Description Get a vserver on the VIM
1335 ===================== =========================================================
1345 ================ ========= ============ ======== ================================
1346 Parameter Qualifier Cardinality Content Description
1347 ================ ========= ============ ======== ================================
1348 vimId M 1 String vim id
1349 vimName O 1 string vim name
1350 cloud-owner M 1 String cloud owner
1351 cloud-region-id M 1 string cloud region id
1352 id M 1 string server id
1353 name M 1 string server name
1354 tenantId M 1 String Tenant UUID
1355 boot M 1 String Start parameters
1356 nicArray O 1..n List List
1357 volumeArray O 1..n List List
1358 availabilityZone O 1 string Usable field
1359 flavorId M 1 String server Flavor
1360 metadata O 1 List Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
1361 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.
1362 serverGroup O 1 string the ServerGroup for anti-affinity and affinity
1363 ================ ========= ============ ======== ================================
1371 7.5. **Heal Server**
1372 ----------------------
1374 ===================== =========================================================
1375 IF Definition Description
1376 ===================== =========================================================
1377 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/servers/{serverid}/action
1379 Direction VNFLCM,NSLCM->MULTIVIM
1380 Description Act on a vserver on the VIM
1381 ===================== =========================================================
1386 ================ ========= ============ ======== ================================
1387 Parameter Qualifier Cardinality Content Description
1388 ================ ========= ============ ======== ================================
1389 os-start M 1 none The action to start a stopped server.
1390 os-stop M 1 none The action to stop a running server.
1391 reboot M 1 object The action to reboot a server.
1392 type O 1 int The type of the reboot action.
1393 The valid values are HARD and SOFT
1394 ================ ========= ============ ======== ================================
1400 Normal response codes: 202
1402 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
1404 8. **Flavor Management**
1405 ^^^^^^^^^^^^^^^^^^^^^^^^
1407 8.1. **Create Flavor**
1408 ----------------------
1410 ===================== =========================================================
1411 IF Definition Description
1412 ===================== =========================================================
1413 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors
1415 Direction VNFLCM->MULTIVIM
1416 Description Create a flavor on the VIM
1417 ===================== =========================================================
1422 ================ ========= ============ ======== ================================
1423 Parameter Qualifier Cardinality Content Description
1424 ================ ========= ============ ======== ================================
1425 name M 1 string Flavor Name
1426 vcpu M 1 int Virtual CPU number
1427 memory M 1 int Memory size
1428 disk M 1 int The size of the root disk
1429 ephemeral O 1 int The size of the ephemeral disk
1430 swap O 1 int The size of the swap disk
1431 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.
1432 extraSpecs O 0..N List EPA parameter
1433 ================ ========= ============ ======== ================================
1439 ================ ========= ============ ======== ================================
1440 Parameter Qualifier Cardinality Content Description
1441 ================ ========= ============ ======== ================================
1442 id M 1 string Flavor id
1443 name M 1 string Flavor name
1444 returnCode M 1 int 0: Already exist 1: Newly created
1445 tenantId M 1 String Tenant UUID
1446 vcpu M 1 int Virtual CPU number
1447 memory M 1 int Memory size
1448 disk M 1 int The size of the root disk
1449 ephemeral M 1 int The size of the ephemeral disk
1450 swap M 1 int The size of the swap disk
1451 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.
1452 extraSpecs O 0..N List EPA parameter
1453 vimId M 1 String vim id
1454 vimName O 1 string vim name
1455 cloud-owner M 1 String cloud owner
1456 cloud-region-id M 1 string cloud region id
1457 ================ ========= ============ ======== ================================
1460 8.2. **Delete Flavor**
1461 ----------------------
1463 ===================== =========================================================
1464 IF Definition Description
1465 ===================== =========================================================
1466 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors /{flavorid}
1468 Direction VNFLCM->MULTIVIM
1469 Description Delete a flavor on the VIM
1470 ===================== =========================================================
1482 8.3. **List Flavor**
1483 --------------------
1485 ===================== =========================================================
1486 IF Definition Description
1487 ===================== =========================================================
1488 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors
1490 Direction VNFLCM,NSLCM->MULTIVIM
1491 Description List flavors on the VIM
1492 ===================== =========================================================
1497 ================ ========= ============ ======== ================================
1498 Parameter Qualifier Cardinality Content Description
1499 ================ ========= ============ ======== ================================
1500 name M 1 string Flavor name to filter out list
1501 ================ ========= ============ ======== ================================
1506 ================ ========= ============ ======== ================================
1507 Parameter Qualifier Cardinality Content Description
1508 ================ ========= ============ ======== ================================
1509 flavors M 0..N list Vm list
1510 id M 1 string Flavor id
1511 name M 1 string Flavor Name
1512 vcpu M 1 int Virtual CPU number
1513 memory M 1 int Memory size
1514 disk M 1 int The size of the root disk
1515 ephemeral M 1 int The size of the ephemeral disk
1516 swap M 1 int The size of the swap disk
1517 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.
1518 extraSpecs O 0..N List EPA parameter
1519 vimId M 1 String vim id
1520 vimName O 1 string vim name
1521 cloud-owner M 1 String cloud owner
1522 cloud-region-id M 1 string cloud region id
1523 tenantId M 1 String Tenant UUID
1524 ================ ========= ============ ======== ================================
1534 ===================== =========================================================
1535 IF Definition Description
1536 ===================== =========================================================
1537 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/flavors/{flavorid}
1539 Direction VNFLCM->MULTIVIM
1540 Description Get a flavor on the VIM
1541 ===================== =========================================================
1551 ================ ========= ============ ======== ================================
1552 Parameter Qualifier Cardinality Content Description
1553 ================ ========= ============ ======== ================================
1554 id M 1 string Flavor id
1555 name M 1 string Flavor Name
1556 vcpu M 1 int Virtual CPU number
1557 memory M 1 int Memory size
1558 disk M 1 int The size of the root disk
1559 ephemeral M 1 int The size of the ephemeral disk
1560 swap M 1 int The size of the swap disk
1561 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.
1562 extraSpecs O 0..N List EPA parameter
1563 vimId M 1 String vim id
1564 vimName O 1 string vim name
1565 cloud-owner M 1 String cloud owner
1566 cloud-region-id M 1 string cloud region id
1567 tenantId M 1 String Tenant UUID
1568 ================ ========= ============ ======== ================================
1574 9. **Volume Management**
1575 ^^^^^^^^^^^^^^^^^^^^^^^^
1577 9.1. **Create Volume**
1578 ----------------------
1580 ===================== =========================================================
1581 IF Definition Description
1582 ===================== =========================================================
1583 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes
1585 Direction VNFLCM->MULTIVIM
1586 Description Create volume on the VIM
1587 ===================== =========================================================
1592 ================ ========= ============ ======== ================================
1593 Parameter Qualifier Cardinality Content Description
1594 ================ ========= ============ ======== ================================
1595 name M 1 string Volume name
1596 volumeSize M 1 int Volume size
1597 imageId O 1 string Image UUID
1598 volumeType O 1 string Volume type
1599 availabilityZone O 1 string Usable field
1600 ================ ========= ============ ======== ================================
1606 "tenant": "tenant1",
1608 "volumeName": "volume1",
1612 "imageName": "cirros.qcow2",
1614 "volumeType": "volumetype1",
1616 "availabilityZone": "zone1"
1623 ================ ========= ============ ======== ================================
1624 Parameter Qualifier Cardinality Content Description
1625 ================ ========= ============ ======== ================================
1626 returnCode M 1 int 0: Already exist 1: Newly created
1627 vimId M 1 String vim id
1628 vimName O 1 string vim name
1629 cloud-owner M 1 String cloud owner
1630 cloud-region-id M 1 string cloud region id
1631 tenantId M 1 String Tenant UUID
1632 status M 1 string Volume status
1633 id M 1 string Volume id
1634 name M 1 string Volume name
1635 volumeType O 1 string Volume type
1636 availabilityZone O 1 string Availability Zone
1637 ================ ========= ============ ======== ================================
1647 "id": "bc9eebdbbfd356458269340b9ea6fb73",
1655 9.2. **Delete Volume**
1656 ----------------------
1658 ===================== =========================================================
1659 IF Definition Description
1660 ===================== =========================================================
1661 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes/{volumeId}
1663 Direction VNFLCM->MULTIVIM
1664 Description Delete volume on the VIM
1665 ===================== =========================================================
1677 9.3. **List Volumes**
1678 ---------------------
1680 ===================== =========================================================
1681 IF Definition Description
1682 ===================== =========================================================
1683 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes
1685 Direction VNFLCM->MULTIVIM
1686 Description List volumes on the VIM
1687 ===================== =========================================================
1692 msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/volumes?{……}
1694 ================ ========= ============ ======== ================================
1695 Parameter Qualifier Cardinality Content Description
1696 ================ ========= ============ ======== ================================
1697 name M 1 string Volume name
1698 ================ ========= ============ ======== ================================
1703 ================ ========= ============ ======== ================================
1704 Parameter Qualifier Cardinality Content Description
1705 ================ ========= ============ ======== ================================
1706 vimId M 1 String vim id
1707 vimName O 1 string vim name
1708 cloud-owner M 1 String cloud owner
1709 cloud-region-id M 1 string cloud region id
1710 tenantId M 1 String Tenant UUID
1712 id M 1 string Volume id
1713 name M 1 string Volume name
1714 createTime O 1 string Create time
1715 status M 1 string Volume status
1716 volumeSize M 1 int Volume size
1717 volumeType M 1 string Volume type
1718 availabilityZone M 1 string Availability Zone
1719 attachments M 1..n list List of additional information on the cloud disk
1720 ================ ========= ============ ======== ================================
1734 "status": "available",
1740 "createTime": "2015-12-02T07:57:23.000000",
1742 " volumeType ": "ws",
1744 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
1760 "device": "/dev/vdc",
1762 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
1764 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
1768 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
1774 "createTime": "2015-12-02T06:39:40.000000",
1776 " volumeType ": null,
1778 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
1788 9.4. **Get Volumes**
1789 --------------------
1791 ===================== =========================================================
1792 IF Definition Description
1793 ===================== =========================================================
1794 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/volumes/{volumeid}
1796 Direction VNFLCM->MULTIVIM
1797 Description Get volume on the VIM
1798 ===================== =========================================================
1808 ================ ========= ============ ======== ================================
1809 Parameter Qualifier Cardinality Content Description
1810 ================ ========= ============ ======== ================================
1811 vimId M 1 String vim id
1812 vimName O 1 string vim name
1813 cloud-owner M 1 String cloud owner
1814 cloud-region-id M 1 string cloud region id
1815 tenantId M 1 String Tenant UUID
1816 id 1 string Volume id
1817 name 1 string Volume name
1818 createTime 1 string Create time
1819 status 1 string Volume status
1820 volumeType 1 List Volume type
1821 volumeSize 1 int Volume size
1822 availabilityZone M 1 string Availability Zone
1823 attachments M 1..n list List of additional information on the cloud disk
1824 ================ ========= ============ ======== ================================
1828 ============== ========= ============ ======== ==================================
1829 Parameter Qualifier Cardinality Content Description
1830 ============== ========= ============ ======== ==================================
1831 device 1 string Device name
1832 serverId 1 string VM id
1833 volumeId 1 string Volume id
1834 hostName 1 string Host name
1835 id 1 string Device id
1836 ============== ========= ============ ======== ==================================
1854 "device": "/dev/vdc",
1856 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
1858 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
1862 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
1868 "createTime": "2015-12-02T06:39:40.000000",
1870 "volumeType ": null,
1872 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
1878 10. **Tenant Management**
1879 ^^^^^^^^^^^^^^^^^^^^^^^^^
1881 10.1. **List tenants**
1882 ----------------------
1885 ===================== =========================================================
1886 IF Definition Description
1887 ===================== =========================================================
1888 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/tenants
1890 Direction VNFLCM->MULTIVIM
1891 Description List tenants on the VIM
1892 ===================== =========================================================
1898 ================= ========= ============ ======== ================================
1899 Parameter Qualifier Cardinality Content Description
1900 ================= ========= ============ ======== ================================
1901 name={tenantname} O 1 string Tenant name to filter output list
1902 ================= ========= ============ ======== ================================
1905 10.1.2. **Response**
1906 >>>>>>>>>>>>>>>>>>>>
1908 ================ ========= ============ ======== ================================
1909 Parameter Qualifier Cardinality Content Description
1910 ================ ========= ============ ======== ================================
1911 vimId M 1 String vim id
1912 vimName O 1 string vim name
1913 cloud-owner M 1 String cloud owner
1914 cloud-region-id M 1 string cloud region id
1916 id M 1 string tenant UUID
1917 name M 1 string tenant name
1918 ================ ========= ============ ======== ================================
1945 11.1. **List Limits of resouces**
1946 ---------------------------------
1948 ===================== =========================================================
1949 IF Definition Description
1950 ===================== =========================================================
1951 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/limits
1953 Direction VNFLCM->MULTIVIM
1954 Description Get limits on the VIM
1955 ===================== =========================================================
1963 11.1.2. **Response**
1964 >>>>>>>>>>>>>>>>>>>>
1966 ======================== ========= ============ ======== ========================
1967 Parameter Qualifier Cardinality Content Description
1968 ======================== ========= ============ ======== ========================
1969 vimId M 1 String vim id vimName O 1 string vim name
1970 cloud-owner M 1 String cloud owner
1971 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.
1972 maxPersonalitySize O 1 int The number of allowed bytes of content for each injected file.
1973 maxServerGroupMembers O 1 int The number of allowed members for each server group.
1974 maxServerGroups O 1 int The number of allowed server groups for each tenant.
1975 maxServerMeta O 1 int The number of allowed metadata items for each instance.
1976 maxTotalCores O 1 int The number of allowed instance cores for each tenant.
1977 maxTotalInstances O 1 int The number of allowed instances for each tenant.
1978 maxTotalKeypairs O 1 int The number of allowed key pairs for each user.
1979 maxTotalRAMSize O 1 int The amount of allowed instance RAM, in MB, for each tenant.
1980 maxTotalVolumeGigabytes O 1 int The maximum total amount of volumes, in gibibytes (GiB).
1981 maxTotalVolumes O 1 int The maximum number of volumes.
1982 totalVolumesUsed O 1 int The total number of volumes used.
1983 totalGigabytesUsed O 1 int The total number of gibibytes (GiB) used.
1984 network O 1 int The number of networks allowed for each project.
1985 subnet O 1 int The number of subnets allowed for each project.
1986 subnetpool O 1 int The number of subnet pools allowed for each project.
1987 security\_group\_rule O 1 int The number of security group rules allowed for each project.
1988 security\_group O 1 int The number of security groups allowed for each project.
1989 router O 1 int The number of routers allowed for each project.
1990 port O 1 int The number of ports allowed for each project.
1991 ======================== ========= ============ ======== ========================
2001 "maxPersonality": 5,
2003 "maxPersonalitySize": 10240,
2005 "maxServerMeta": 128,
2007 "maxTotalCores": 20,
2009 "maxTotalInstances": 10,
2011 "maxTotalKeypairs": 100,
2013 "maxTotalRAMSize": 51200,
2015 "maxServerGroups": 10,
2017 "maxServerGroupMembers": 10,
2021 12. **Host Management**
2022 ^^^^^^^^^^^^^^^^^^^^^^^
2024 12.1. **List hosts**
2025 --------------------
2027 ===================== =========================================================
2028 IF Definition Description
2029 ===================== =========================================================
2030 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/hosts
2032 Direction VNFLCM->MULTIVIM
2033 Description list hosts on the VIM
2034 ===================== =========================================================
2041 12.1.2. **Response**
2042 >>>>>>>>>>>>>>>>>>>>
2044 =============== ========= ============ ======== ==================================
2045 Parameter Qualifier Cardinality Content Description
2046 =============== ========= ============ ======== ==================================
2047 vimId M 1 String vim id
2048 vimName O 1 string vim name
2049 cloud-owner M 1 String cloud owner
2050 cloud-region-id M 1 string cloud region id
2051 tenantId M 1 string Tenant Name
2052 hosts M 1 Array List of host information
2053 service M 1 string The service running on the host
2054 name M 1 string host name
2055 zone O 1 string Available zone for the host
2056 =============== ========= ============ ======== ==================================
2068 "vimName": "vimName",
2070 "tenantId": "tenantId1"
2076 "name": "b6e4adbc193d428ea923899d07fb001e",
2078 "service": "conductor",
2084 "vimName": "vimName",
2086 "tenantId": "tenantId1"
2092 "name": "09c025b0efc64211bd23fc50fa974cdf",
2094 "service": "compute",
2100 "vimName": "vimName",
2102 "tenantId": "tenantId1"
2108 "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2110 "service": "consoleauth",
2116 "vimName": "vimName",
2118 "tenantId": "tenantId1"
2124 "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2126 "service": "network",
2132 "vimName": "vimName",
2134 "tenantId": "tenantId1"
2140 "name": "abffda96592c4eacaf4111c28fddee17",
2142 "service": "scheduler",
2148 "vimName": "vimName",
2150 "tenantId": "tenantId1"
2161 ===================== =========================================================
2162 IF Definition Description
2163 ===================== =========================================================
2164 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/{tenantid}/hosts/{hostname}
2166 Direction VNFLCM->MULTIVIM
2167 Description Get a host on the VIM
2168 ===================== =========================================================
2174 12.2.2. **Response**
2175 >>>>>>>>>>>>>>>>>>>>
2177 =============== ========= ============ ======== ==================================
2178 Parameter Qualifier Cardinality Content Description
2179 =============== ========= ============ ======== ==================================
2180 vimId M 1 String vim id
2181 vimName O 1 string vim name
2182 cloud-owner M 1 String cloud owner
2183 cloud-region-id M 1 string cloud region id
2184 tenantId M 1 string Tenant Name
2185 host M 1 List Host resource info
2186 resource M 1..N Object Resource description
2187 cpu M 1 Int The cpu info on the host.
2188 memory_mb M 1 int The memory info on the host (in MB).
2189 name M 1 string host name
2190 project M 1 string Value: total, used_now, used_max or specific project_id
2191 disk_gb M 1 int The disk info on the host (in GB).
2192 =============== ========= ============ ======== ==================================
2206 "name": "c1a7de0ac9d94e4baceae031d05caae3",
2212 "vimName": "vimName",
2214 "tenantId": "tenantId1",
2222 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2226 "project": "(total)",
2236 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2240 "project": "(used\_now)",
2250 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2254 "project": "(used\_max)",
2264 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2268 "project": "568f7ec425db472ba348251bf1e7eebd",
2276 "vimName": "openstack\_newton",
2278 "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2280 "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2284 13. **VIM Management**
2285 ^^^^^^^^^^^^^^^^^^^^^^
2287 13.1. **Update VIM Info**
2288 -------------------------
2290 ===================== =========================================================
2291 IF Definition Description
2292 ===================== =========================================================
2293 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/registry
2295 Direction ESR-> MULTICLOUD
2296 Description Register a VIM instance to ONAP
2297 ===================== =========================================================
2302 ============== ========= ============ ======== ==================================
2303 Parameter Qualifier Cardinality Content Description
2304 ============== ========= ============ ======== ==================================
2305 defaultTenant M 1 string default tenant name
2306 ============== ========= ============ ======== ==================================
2308 13.1.2. **Response**
2309 >>>>>>>>>>>>>>>>>>>>
2317 13.2. **Get registry status**
2318 -----------------------------
2320 +---------------------+----------------------------------------------------------------------------------------------+
2321 | **IF Definition** | **Description** |
2322 +=====================+==============================================================================================+
2323 | URI | http://msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region}/registry |
2324 +---------------------+----------------------------------------------------------------------------------------------+
2326 +---------------------+----------------------------------------------------------------------------------------------+
2327 | Direction | ESR-> MULTICLOUD |
2328 +---------------------+----------------------------------------------------------------------------------------------+
2335 13.2.2. **Response**
2336 >>>>>>>>>>>>>>>>>>>>
2346 13.3. **Unregistry VIM**
2347 ------------------------
2349 ===================== =========================================================
2350 IF Definition Description
2351 ===================== =========================================================
2352 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}
2354 Direction ESR-> MULTICLOUD
2355 Description Unregister a VIM instance from ONAP
2356 ===================== =========================================================
2364 13.2.2. **Response**
2365 >>>>>>>>>>>>>>>>>>>>
2369 204: No content found
2375 14. **infrastructure workload LCM**
2376 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2378 14.1. **Instantiate infrastructure workload**
2379 ----------------------------------------------
2381 ===================== =========================================================
2382 IF Definition Description
2383 ===================== =========================================================
2384 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload
2386 Direction SO-> MULTICLOUD
2387 Description Instantiate infrastructure workload
2388 ===================== =========================================================
2393 ================ ========= ============ ======== ================================================
2394 Parameter Qualifier Cardinality Content Description
2395 ================ ========= ============ ======== ================================================
2396 generic-vnf-id O 1 string generif VNF ID to search AAI object
2397 vf-module-id O 1 string vf module id to search AAI object
2398 user_directives O 1 Object user directives to update template_data
2399 This directives take 1st precedence
2400 over the other directives
2401 oof_directives O 1 Object oof directives to update template_data
2402 This directives take 2nd precedence
2403 sdnc_directives O 1 Object sdnc directives to update template_data
2404 This directives take 3rd precedence
2405 template_type M 1 string template type with which the
2406 MultiCloud plugin inteprates template_data
2408 template_data M 1 Object workload template data to
2409 instantiate workload onto VIM/Cloud instance
2410 ================ ========= ============ ======== ================================================
2412 ================================= ========= ============ ======== ======================================
2413 vf-module-model-customization-id O 1 string uuid which is used to retrieve VNF
2415 ================================= ========= ============ ======== ======================================
2420 "generic-vnf-id": "2115b07a-0c45-46ab-929a-0e98764a6ff3",
2421 "vf-module-id": "86d30674-e096-4957-8ec0-7e0aef68868c",
2422 "vf-module-model-invariant-id": "aa83cd86-a6f2-4b97-90d4-46bd7cd8748b",
2423 "vf-module-model-version-id": "9e4386fb-8cdb-45b8-9b01-ae37bc0ba452",
2424 "vf-module-model-customization-id": "a9e47763-adb7-4689-8dad-f5b780bf1af4",
2425 "oof_directives":{},
2426 "sdnc_directives":{},
2427 "user_directives":{},
2428 "template_type":"heat",
2431 "disable_rollback":true,
2435 "stack_name":"teststack",
2436 "template":"<escaped template file content>",
2441 14.1.2. **Response**
2442 >>>>>>>>>>>>>>>>>>>>
2444 ================== ========= ============ ======== ==============================================================
2445 Parameter Qualifier Cardinality Content Description
2446 ================== ========= ============ ======== ==============================================================
2447 template_type M 1 string template type with which the MultiCloud
2448 plugin inteprates template_data "heat",etc.
2449 workload_id M 1 string The ID of infrastructure workload resource
2450 template_response O 1 Object response from VIM/Cloud instance
2451 which is instantiating workload
2452 workload_status M 1 string progress of workload instantiating process:
2453 "CREATE_IN_PROGRESS","CREATE_COMPLETE","CREATE_FAILED"
2454 ================== ========= ============ ======== ==============================================================
2456 ====================== ========= ============ ======== ==============================================================
2457 workload_status_reason M 1 Object stack object which is instantiated
2458 ====================== ========= ============ ======== ==============================================================
2474 "template_type": "HEAT",
2475 "workload_status_reason": {
2476 "id": "dca67f9d-37c1-4863-b5e0-0e3d3c53196e",
2479 "href": "http://msb-iag.onap:80/api/multicloud-titaniumcloud/v1/CloudOwner/ONAP-POD-01-Rail-06/orchestration/v1/709ba629fe194f8699b12f9d6ffd86a0/stacks/vlb_vfm_ewm_1/dca67f9d-37c1-4863-b5e0-0e3d3c53196e",
2484 "workload_status": "CREATE_IN_PROGRESS",
2485 "workload_id": "dca67f9d-37c1-4863-b5e0-0e3d3c53196e"
2489 14.2. **Query infrastructure workload**
2490 ---------------------------------------
2492 ===================== =========================================================
2493 IF Definition Description
2494 ===================== =========================================================
2495 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload/{workload-id}
2497 Direction SO-> MULTICLOUD
2498 Description Query the status of the infrastructure workload
2499 ===================== =========================================================
2507 14.2.2. **Response**
2508 >>>>>>>>>>>>>>>>>>>>
2510 ================== ========= ============ ======== ==============================================================
2511 Parameter Qualifier Cardinality Content Description
2512 ================== ========= ============ ======== ==============================================================
2513 template_type M 1 string Workload Template type e.g. "heat",etc.
2514 workload_id M 1 string The ID of infrastructure workload resource
2515 workload_status M 1 string progress of workload operation process:
2516 CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED
2517 DELETE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED
2518 UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED
2519 ================== ========= ============ ======== ==============================================================
2521 ====================== ========= ============ ======== ==============================================================
2522 workload_status_reason M 1 Object stack object which is instantiated
2523 ====================== ========= ============ ======== ==============================================================
2534 500: Internal Server Error
2539 "template_type": "HEAT",
2540 "workload_status_reason": {
2541 "id": "dca67f9d-37c1-4863-b5e0-0e3d3c53196e",
2544 "href": "http://msb-iag.onap:80/api/multicloud-titaniumcloud/v1/CloudOwner/ONAP-POD-01-Rail-06/orchestration/v1/709ba629fe194f8699b12f9d6ffd86a0/stacks/vlb_vfm_ewm_1/dca67f9d-37c1-4863-b5e0-0e3d3c53196e",
2549 "workload_status": "CREATE_IN_PROGRESS",
2550 "workload_id": "dca67f9d-37c1-4863-b5e0-0e3d3c53196e"
2554 14.3. **Delete infrastructure workload**
2555 ----------------------------------------
2557 ===================== =========================================================
2558 IF Definition Description
2559 ===================== =========================================================
2560 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload/{workload-id}
2562 Direction SO-> MULTICLOUD
2563 Description DELETE the infrastructure workload
2564 ===================== =========================================================
2572 14.3.2. **Response**
2573 >>>>>>>>>>>>>>>>>>>>
2575 ================== ========= ============ ======== ================================================
2576 Parameter Qualifier Cardinality Content Description
2577 ================== ========= ============ ======== ================================================
2578 template_type M 1 string Workload Template type e.g. "heat",etc.
2579 workload_id M 1 string The ID of infrastructure workload resource
2580 workload_status M 1 string progress of workload operation process:
2581 DELETE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED
2582 ================== ========= ============ ======== ================================================
2584 ====================== ========= ============ ======== ==============================================================
2585 workload_status_reason M 1 Object stack object which is instantiated
2586 ====================== ========= ============ ======== ==============================================================
2590 204: No Content, The server has fulfilled the request by deleting the resource.
2598 500: Internal Server Error
2603 "template_type": "HEAT",
2604 "workload_status_reason": {
2605 "id": "dca67f9d-37c1-4863-b5e0-0e3d3c53196e",
2608 "href": "http://msb-iag.onap:80/api/multicloud-titaniumcloud/v1/CloudOwner/ONAP-POD-01-Rail-06/orchestration/v1/709ba629fe194f8699b12f9d6ffd86a0/stacks/vlb_vfm_ewm_1/dca67f9d-37c1-4863-b5e0-0e3d3c53196e",
2613 "workload_status": "DELETE_IN_PROGRESS",
2614 "workload_id": "dca67f9d-37c1-4863-b5e0-0e3d3c53196e"
2619 14.4. **Update infrastructure workload into AAI Inventory**
2620 ------------------------------------------------------------
2622 ===================== =========================================================
2623 IF Definition Description
2624 ===================== =========================================================
2625 URI msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload/{workload-id}
2627 Direction SO-> MULTICLOUD
2628 Description Update infrastructure workload into AAI
2629 ===================== =========================================================
2637 14.4.2. **Response**
2638 >>>>>>>>>>>>>>>>>>>>
2640 ================== ========= ============ ======== ================================================
2641 Parameter Qualifier Cardinality Content Description
2642 ================== ========= ============ ======== ================================================
2643 template_type M 1 string Workload Template type e.g. "heat",etc.
2644 workload_id M 1 string The ID of infrastructure workload resource
2645 workload_status M 1 string progress of workload operation process:
2646 UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED
2647 ================== ========= ============ ======== ================================================
2649 ====================== ========= ============ ======== ==============================================================
2650 workload_status_reason M 1 Object stack object which is instantiated
2651 ====================== ========= ============ ======== ==============================================================
2662 500: Internal Server Error
2667 "template_type": "HEAT",
2668 "workload_status_reason": {
2670 "workload_status": "UPDATE_IN_PROGRESS",
2671 "workload_id": "dca67f9d-37c1-4863-b5e0-0e3d3c53196e"
2675 15. **Proxied OpenStack APIs**
2676 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2679 -------------------------
2681 +---------------------+----------------------------------------------------------------------------------------------+
2682 | **IF Definition** | **Description** |
2683 +=====================+==============================================================================================+
2684 | URI | http://msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{region-id}/identity/v3/auth/tokens |
2685 +---------------------+----------------------------------------------------------------------------------------------+
2686 | Operation | POST |
2687 +---------------------+----------------------------------------------------------------------------------------------+
2688 | Direction | NSLCM-> MULTICLOUD |
2689 +---------------------+----------------------------------------------------------------------------------------------+
2694 +-----------------+-----------------+-------------------+---------------+-----------------------+
2695 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2696 +=================+=================+===================+===============+=======================+
2697 | auth | O | 1 | Object | Same as OpenStack |
2698 | | | | | Identity Tokens API |
2699 +-----------------+-----------------+-------------------+---------------+-----------------------+
2707 15.1.2. **Response**
2708 >>>>>>>>>>>>>>>>>>>>
2711 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2712 | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2713 +=================+=================+===================+=====================+==============================================================+
2714 | X-Subject-Token | M | 1 | String | The authentication token in Header |
2715 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2716 | token | O | 1 | Object | Token response, the same as OpenStack Identity Tokens API |
2717 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2731 X-Subject-Token: a33f3b209e9b471a97fbeab8324a9a45
2742 "id" : "9efb043c7629497a8028d7325ca1afb0",
2750 "interface" : "public",
2751 "id" : "39583c1508ad4b71b380570a745ee10a",
2752 "url" : "http://172.16.77.10:80/api/multicloud-titaniumcloud/v1/CloudOwner/RegionOne/network",
2753 "region_id" : "RegionOne",
2754 "region" : "RegionOne"
2758 "id" : "99aefcc82a9246f98f8c281e61ffc754"
2764 "id" : "fcca3cc49d5e42caae15459e27103efc",
2770 "is_domain" : false,
2771 "expires_at" : "2017-09-11T03:52:29.000000Z"