Gitiles
Code Review Sign In
gerrit.nordix.org / onap / so / af4ed9296d736c18982402da7354610ec0e083bf / . / docs / SO_R1_Interface.rst
blob: 10b894c45703d982a8c5e6d57fe91d849a64c4ef [file] [log] [blame]
seshukmcdcf19b2017-11-06 12:16:25 +0530[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright 2017 Huawei Technologies Co., Ltd.
4
seshukm30345e82017-11-16 19:04:51 +0530[diff] [blame]5SO Amsterdam Interfaces
seshukmcdcf19b2017-11-06 12:16:25 +0530[diff] [blame]6================
7
8.. image:: images/SO_R1_1.png
9
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]10SO APIs
11============
12
seshukmfffbc992017-12-18 14:36:48 +0530[diff] [blame]13North Bound APIs
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]14----------------
15Create service instance
16++++++++++++++++++++++++
17
18+--------------------+-------------------------------------+
19|Interface Definition|Description |
20+====================+=====================================+
21|URI |{serverRoot}/serviceInstances/v2 |
22+--------------------+-------------------------------------+
23|Operation Type |POST |
24+--------------------+-------------------------------------+
25|Content-Type |application/json |
26+--------------------+-------------------------------------+
27
28Request Body:
29
30+----------------+---------+-----------+--------------------------+-------------------------------------------+
31|Attribute |Qualifier|Cardinality|Content |Description |
32+================+=========+===========+==========================+===========================================+
33|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
34+----------------+---------+-----------+--------------------------+-------------------------------------------+
35
36RequestDetails Object
37
38+-------------------+-------------------------+-------------------------------------------------+
39|Attribute |Content |Description |
40+===================+=========================+=================================================+
41|modelInfo |modelInfo Object |Content of modelInfo object. |
42+-------------------+-------------------------+-------------------------------------------------+
43|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
44+-------------------+-------------------------+-------------------------------------------------+
45|requestInfo |requestInfo Object |Content of requestInfo object. |
46+-------------------+-------------------------+-------------------------------------------------+
47|requestParameters |requestParameters Object |Content of requestParameters object. |
48+-------------------+-------------------------+-------------------------------------------------+
49
50ModelInfo Object
51
52+-------------------------+------------------+-------------------------------------------------+
53|Attribute |Content |Description |
54+=========================+==================+=================================================+
55|ModelType |String |Type of model |
56+-------------------------+------------------+-------------------------------------------------+
57|ModelInvariantId |String |The Model Invariant Id. |
58+-------------------------+------------------+-------------------------------------------------+
59|ModelNameVersionId |String |The modelname Version Id |
60+-------------------------+------------------+-------------------------------------------------+
61|ModelName |String |Name of the Model |
62+-------------------------+------------------+-------------------------------------------------+
63|ModelVersion |String |Version of the model |
64+-------------------------+------------------+-------------------------------------------------+
65|ModelCustomization Name |String |The Model Customization name |
66+-------------------------+------------------+-------------------------------------------------+
67
68SubscriberInfo Object
69
70+-------------------------+------------------+-------------------------------------------------+
71|Attribute |Content |Description |
72+=========================+==================+=================================================+
73|GlobalSubscriberId |String |Global customer Id (in A&AI) |
74+-------------------------+------------------+-------------------------------------------------+
75|SubscriberName |String |Name of the Subscriber |
76+-------------------------+------------------+-------------------------------------------------+
77
78RequestInfo Object
79
80+-------------------------+------------------+-------------------------------------------------+
81|Attribute |Content |Description |
82+=========================+==================+=================================================+
83|InstanceName |String |The instance Name |
84+-------------------------+------------------+-------------------------------------------------+
85|ProductFamilyId |String |The product family Id. |
86+-------------------------+------------------+-------------------------------------------------+
87|Source |String |source of the request |
88+-------------------------+------------------+-------------------------------------------------+
89|SuppressRollback |Boolean |SuppressRollback |
90+-------------------------+------------------+-------------------------------------------------+
91
92RequestParameters Object
93
94+-------------------------+------------------+-------------------------------------------------+
95|Attribute |Content |Description |
96+=========================+==================+=================================================+
97|SubscriptionServiceType |String |The service type of the Subscription |
98+-------------------------+------------------+-------------------------------------------------+
99|UserParams |Array |The product family Id. |
100+-------------------------+------------------+-------------------------------------------------+
101
102UserParams Object
103
104+-------------------------+------------------+-------------------------------------------------+
105|Attribute |Content |Description |
106+=========================+==================+=================================================+
107|name |String |Tag name of attribute |
108+-------------------------+------------------+-------------------------------------------------+
109|value |String |Value of the tag |
110+-------------------------+------------------+-------------------------------------------------+
111
112Delete service instance
113++++++++++++++++++++++++
114
115+--------------------+---------------------------------------------------------+
116|Interface Definition|Description |
117+====================+=========================================================+
118|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId} |
119+--------------------+---------------------------------------------------------+
120|Operation Type |DELETE |
121+--------------------+---------------------------------------------------------+
122|Content-Type |application/json |
123+--------------------+---------------------------------------------------------+
124
125Request Body:
126
127+----------------+---------+-----------+--------------------------+-------------------------------------------+
128|Attribute |Qualifier|Cardinality|Content |Description |
129+================+=========+===========+==========================+===========================================+
130|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
131+----------------+---------+-----------+--------------------------+-------------------------------------------+
132
133RequestDetails Object
134
135+-------------------+-------------------------+-------------------------------------------------+
136|Attribute |Content |Description |
137+===================+=========================+=================================================+
138|modelInfo |modelInfo Object |Content of modelInfo object. |
139+-------------------+-------------------------+-------------------------------------------------+
140|requestInfo |requestInfo Object |Content of requestInfo object. |
141+-------------------+-------------------------+-------------------------------------------------+
142
143ModelInfo Object
144
145+-------------------------+------------------+-------------------------------------------------+
146|Attribute |Content |Description |
147+=========================+==================+=================================================+
148|ModelType |String |Type of model |
149+-------------------------+------------------+-------------------------------------------------+
150|ModelInvariantId |String |The Model Invariant Id. |
151+-------------------------+------------------+-------------------------------------------------+
152|ModelName |String |Name of the Model |
153+-------------------------+------------------+-------------------------------------------------+
154|ModelVersion |String |Version of the model |
155+-------------------------+------------------+-------------------------------------------------+
156
157RequestInfo Object
158
159+-------------------------+------------------+-------------------------------------------------+
160|Attribute |Content |Description |
161+=========================+==================+=================================================+
162|Source |String |source of the request |
163+-------------------------+------------------+-------------------------------------------------+
164
165Create Volume Group
166++++++++++++++++++++++++
167
168+--------------------+-------------------------------------------------------------------------------------------+
169|Interface Definition|Description |
170+====================+===========================================================================================+
171|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
172+--------------------+-------------------------------------------------------------------------------------------+
173|Operation Type |POST |
174+--------------------+-------------------------------------------------------------------------------------------+
175|Content-Type |application/json |
176+--------------------+-------------------------------------------------------------------------------------------+
177
178Request Body:
179
180+----------------+---------+-----------+--------------------------+-------------------------------------------+
181|Attribute |Qualifier|Cardinality|Content |Description |
182+================+=========+===========+==========================+===========================================+
183|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
184+----------------+---------+-----------+--------------------------+-------------------------------------------+
185
186RequestDetails Object
187
188+---------------------+-------------------------+-------------------------------------------------+
189|Attribute |Content |Description |
190+=====================+=========================+=================================================+
191|modelInfo |modelInfo Object |Content of modelInfo object. |
192+---------------------+-------------------------+-------------------------------------------------+
193|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
194+---------------------+-------------------------+-------------------------------------------------+
195|requestInfo |requestInfo Object |Content of requestInfo object. |
196+---------------------+-------------------------+-------------------------------------------------+
197|relatedInstanceList |List |Content of relatedInstanceList. |
198+---------------------+-------------------------+-------------------------------------------------+
199
200ModelInfo Object
201
202+-------------------------+------------------+-------------------------------------------------+
203|Attribute |Content |Description |
204+=========================+==================+=================================================+
205|ModelType |String |Type of model |
206+-------------------------+------------------+-------------------------------------------------+
207|ModelInvariantId |String |The Model Invariant Id. |
208+-------------------------+------------------+-------------------------------------------------+
209|ModelNameVersionId |String |The modelname Version Id |
210+-------------------------+------------------+-------------------------------------------------+
211|ModelName |String |Name of the Model |
212+-------------------------+------------------+-------------------------------------------------+
213|ModelVersion |String |Version of the model |
214+-------------------------+------------------+-------------------------------------------------+
215|ModelCustomization Name |String |The Model Customization name |
216+-------------------------+------------------+-------------------------------------------------+
217
218CloudConfiguration Object
219
220+-------------------------+------------------+-------------------------------------------------+
221|Attribute |Content |Description |
222+=========================+==================+=================================================+
223|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
224+-------------------------+------------------+-------------------------------------------------+
225|tenantId |String |Name of the Subscriber |
226+-------------------------+------------------+-------------------------------------------------+
227
228RequestInfo Object
229
230+-------------------------+------------------+-------------------------------------------------+
231|Attribute |Content |Description |
232+=========================+==================+=================================================+
233|InstanceName |String |The instance Name |
234+-------------------------+------------------+-------------------------------------------------+
235|Source |String |source of the request |
236+-------------------------+------------------+-------------------------------------------------+
237|SuppressRollback |Boolean |SuppressRollback |
238+-------------------------+------------------+-------------------------------------------------+
239
240relatedInstance List
241
242+-------------------------+------------------+-------------------------------------------------+
243|Attribute |Content |Description |
244+=========================+==================+=================================================+
245|relatedInstance |Object |relatedInstance Object |
246+-------------------------+------------------+-------------------------------------------------+
247
248relatedInstance List
249
250+-------------------------+------------------+-------------------------------------------------+
251|Attribute |Content |Description |
252+=========================+==================+=================================================+
253|instanceId |String |instanceId |
254+-------------------------+------------------+-------------------------------------------------+
255|modelInfo |Object |Content of modelInfo object. |
256+-------------------------+------------------+-------------------------------------------------+
257
258Delete Volume Group
259++++++++++++++++++++++++
260
261+--------------------+---------------------------------------------------------------------------------------------------------------------+
262|Interface Definition|Description |
263+====================+=====================================================================================================================+
264|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
265+--------------------+---------------------------------------------------------------------------------------------------------------------+
266|Operation Type |DELETE |
267+--------------------+---------------------------------------------------------------------------------------------------------------------+
268|Content-Type |application/json |
269+--------------------+---------------------------------------------------------------------------------------------------------------------+
270
271Request Body:
272
273+----------------+---------+-----------+--------------------------+-------------------------------------------+
274|Attribute |Qualifier|Cardinality|Content |Description |
275+================+=========+===========+==========================+===========================================+
276|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
277+----------------+---------+-----------+--------------------------+-------------------------------------------+
278
279RequestDetails Object
280
281+---------------------+-------------------------+-------------------------------------------------+
282|Attribute |Content |Description |
283+=====================+=========================+=================================================+
284|modelInfo |modelInfo Object |Content of modelInfo object. |
285+---------------------+-------------------------+-------------------------------------------------+
286|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
287+---------------------+-------------------------+-------------------------------------------------+
288|requestInfo |requestInfo Object |Content of requestInfo object. |
289+---------------------+-------------------------+-------------------------------------------------+
290
291ModelInfo Object
292
293+-------------------------+------------------+-------------------------------------------------+
294|Attribute |Content |Description |
295+=========================+==================+=================================================+
296|ModelType |String |Type of model |
297+-------------------------+------------------+-------------------------------------------------+
298|ModelName |String |Name of the Model |
299+-------------------------+------------------+-------------------------------------------------+
300
301CloudConfiguration Object
302
303+-------------------------+------------------+-------------------------------------------------+
304|Attribute |Content |Description |
305+=========================+==================+=================================================+
306|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
307+-------------------------+------------------+-------------------------------------------------+
308|tenantId |String |Name of the Subscriber |
309+-------------------------+------------------+-------------------------------------------------+
310
311RequestInfo Object
312
313+-------------------------+------------------+-------------------------------------------------+
314|Attribute |Content |Description |
315+=========================+==================+=================================================+
316|Source |String |source of the request |
317+-------------------------+------------------+-------------------------------------------------+
318
319Create VF Module
320+++++++++++++++++
321
322+--------------------+----------------------------------------------------------------------------------------+
323|Interface Definition|Description |
324+====================+========================================================================================+
325|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
326+--------------------+----------------------------------------------------------------------------------------+
327|Operation Type |POST |
328+--------------------+----------------------------------------------------------------------------------------+
329|Content-Type |application/json |
330+--------------------+----------------------------------------------------------------------------------------+
331
332Request Body:
333
334+----------------+---------+-----------+--------------------------+-------------------------------------------+
335|Attribute |Qualifier|Cardinality|Content |Description |
336+================+=========+===========+==========================+===========================================+
337|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
338+----------------+---------+-----------+--------------------------+-------------------------------------------+
339
340RequestDetails Object
341
342+---------------------+-------------------------+-------------------------------------------------+
343|Attribute |Content |Description |
344+=====================+=========================+=================================================+
345|modelInfo |modelInfo Object |Content of modelInfo object. |
346+---------------------+-------------------------+-------------------------------------------------+
347|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
348+---------------------+-------------------------+-------------------------------------------------+
349|requestInfo |requestInfo Object |Content of requestInfo object. |
350+---------------------+-------------------------+-------------------------------------------------+
351|relatedInstanceList |List |Content of relatedInstanceList. |
352+---------------------+-------------------------+-------------------------------------------------+
353
354ModelInfo Object
355
356+-------------------------+------------------+-------------------------------------------------+
357|Attribute |Content |Description |
358+=========================+==================+=================================================+
359|ModelType |String |Type of model |
360+-------------------------+------------------+-------------------------------------------------+
361|ModelInvariantId |String |The Model Invariant Id. |
362+-------------------------+------------------+-------------------------------------------------+
363|ModelNameVersionId |String |The modelname Version Id |
364+-------------------------+------------------+-------------------------------------------------+
365|ModelName |String |Name of the Model |
366+-------------------------+------------------+-------------------------------------------------+
367|ModelVersion |String |Version of the model |
368+-------------------------+------------------+-------------------------------------------------+
369|ModelCustomization Name |String |The Model Customization name |
370+-------------------------+------------------+-------------------------------------------------+
371
372CloudConfiguration Object
373
374+-------------------------+------------------+-------------------------------------------------+
375|Attribute |Content |Description |
376+=========================+==================+=================================================+
377|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
378+-------------------------+------------------+-------------------------------------------------+
379|tenantId |String |Name of the Subscriber |
380+-------------------------+------------------+-------------------------------------------------+
381
382RequestInfo Object
383
384+-------------------------+------------------+-------------------------------------------------+
385|Attribute |Content |Description |
386+=========================+==================+=================================================+
387|InstanceName |String |The instance Name |
388+-------------------------+------------------+-------------------------------------------------+
389|Source |String |source of the request |
390+-------------------------+------------------+-------------------------------------------------+
391|SuppressRollback |Boolean |SuppressRollback |
392+-------------------------+------------------+-------------------------------------------------+
393
394relatedInstance List
395
396+-------------------------+------------------+-------------------------------------------------+
397|Attribute |Content |Description |
398+=========================+==================+=================================================+
399|relatedInstance |Object |relatedInstance Object |
400+-------------------------+------------------+-------------------------------------------------+
401
402relatedInstance List
403
404+-------------------------+------------------+-------------------------------------------------+
405|Attribute |Content |Description |
406+=========================+==================+=================================================+
407|instanceId |String |instanceId |
408+-------------------------+------------------+-------------------------------------------------+
409|modelInfo |Object |Content of modelInfo object. |
410+-------------------------+------------------+-------------------------------------------------+
411|instanceName |String |Name of the instance |
412+-------------------------+------------------+-------------------------------------------------+
413
414Delete Volume Group
415++++++++++++++++++++++++
416
417+--------------------+--------------------------------------------------------------------------------------------------------------+
418|Interface Definition|Description |
419+====================+==============================================================================================================+
420|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
421+--------------------+--------------------------------------------------------------------------------------------------------------+
422|Operation Type |DELETE |
423+--------------------+--------------------------------------------------------------------------------------------------------------+
424|Content-Type |application/json |
425+--------------------+--------------------------------------------------------------------------------------------------------------+
426
427Request Body:
428
429+----------------+---------+-----------+--------------------------+-------------------------------------------+
430|Attribute |Qualifier|Cardinality|Content |Description |
431+================+=========+===========+==========================+===========================================+
432|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
433+----------------+---------+-----------+--------------------------+-------------------------------------------+
434
435RequestDetails Object
436
437+---------------------+-------------------------+-------------------------------------------------+
438|Attribute |Content |Description |
439+=====================+=========================+=================================================+
440|modelInfo |modelInfo Object |Content of modelInfo object. |
441+---------------------+-------------------------+-------------------------------------------------+
442|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
443+---------------------+-------------------------+-------------------------------------------------+
444|requestInfo |requestInfo Object |Content of requestInfo object. |
445+---------------------+-------------------------+-------------------------------------------------+
446
447ModelInfo Object
448
449+-------------------------+------------------+-------------------------------------------------+
450|Attribute |Content |Description |
451+=========================+==================+=================================================+
452|ModelType |String |Type of model |
453+-------------------------+------------------+-------------------------------------------------+
454|ModelInvariantId |String |The Model Invariant Id. |
455+-------------------------+------------------+-------------------------------------------------+
456|ModelNameVersionId |String |The modelname Version Id |
457+-------------------------+------------------+-------------------------------------------------+
458|ModelName |String |Name of the Model |
459+-------------------------+------------------+-------------------------------------------------+
460|ModelVersion |String |Version of the model |
461+-------------------------+------------------+-------------------------------------------------+
462|ModelCustomization Name |String |The Model Customization name |
463+-------------------------+------------------+-------------------------------------------------+
464
465CloudConfiguration Object
466
467+-------------------------+------------------+-------------------------------------------------+
468|Attribute |Content |Description |
469+=========================+==================+=================================================+
470|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
471+-------------------------+------------------+-------------------------------------------------+
472|tenantId |String |Name of the Subscriber |
473+-------------------------+------------------+-------------------------------------------------+
474
475RequestInfo Object
476
477+-------------------------+------------------+-------------------------------------------------+
478|Attribute |Content |Description |
479+=========================+==================+=================================================+
480|Source |String |source of the request |
481+-------------------------+------------------+-------------------------------------------------+
482
483Create Network
484+++++++++++++++
485
486+--------------------+------------------------------------------------------------------+
487|Interface Definition|Description |
488+====================+==================================================================+
489|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/networks |
490+--------------------+------------------------------------------------------------------+
491|Operation Type |POST |
492+--------------------+------------------------------------------------------------------+
493|Content-Type |application/json |
494+--------------------+------------------------------------------------------------------+
495
496Request Body:
497
498+----------------+---------+-----------+--------------------------+-------------------------------------------+
499|Attribute |Qualifier|Cardinality|Content |Description |
500+================+=========+===========+==========================+===========================================+
501|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
502+----------------+---------+-----------+--------------------------+-------------------------------------------+
503
504RequestDetails Object
505
506+---------------------+-------------------------+-------------------------------------------------+
507|Attribute |Content |Description |
508+=====================+=========================+=================================================+
509|modelInfo |modelInfo Object |Content of modelInfo object. |
510+---------------------+-------------------------+-------------------------------------------------+
511|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
512+---------------------+-------------------------+-------------------------------------------------+
513|requestInfo |requestInfo Object |Content of requestInfo object. |
514+---------------------+-------------------------+-------------------------------------------------+
515|relatedInstanceList |List |Content of relatedInstanceList. |
516+---------------------+-------------------------+-------------------------------------------------+
517|requestParameters |requestParameters Object |Content of requestParameters object. |
518+---------------------+-------------------------+-------------------------------------------------+
519
520ModelInfo Object
521
522+-------------------------+------------------+-------------------------------------------------+
523|Attribute |Content |Description |
524+=========================+==================+=================================================+
525|ModelType |String |Type of model |
526+-------------------------+------------------+-------------------------------------------------+
527|ModelName |String |Name of the Model |
528+-------------------------+------------------+-------------------------------------------------+
529
530CloudConfiguration Object
531
532+-------------------------+------------------+-------------------------------------------------+
533|Attribute |Content |Description |
534+=========================+==================+=================================================+
535|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
536+-------------------------+------------------+-------------------------------------------------+
537|tenantId |String |Name of the Subscriber |
538+-------------------------+------------------+-------------------------------------------------+
539
540RequestInfo Object
541
542+-------------------------+------------------+-------------------------------------------------+
543|Attribute |Content |Description |
544+=========================+==================+=================================================+
545|InstanceName |String |The instance Name |
546+-------------------------+------------------+-------------------------------------------------+
547|ProductFamilyId |String |The product family Id. |
548+-------------------------+------------------+-------------------------------------------------+
549|Source |String |source of the request |
550+-------------------------+------------------+-------------------------------------------------+
551|SuppressRollback |Boolean |SuppressRollback |
552+-------------------------+------------------+-------------------------------------------------+
553
554relatedInstance List
555
556+-------------------------+------------------+-------------------------------------------------+
557|Attribute |Content |Description |
558+=========================+==================+=================================================+
559|relatedInstance |Object |relatedInstance Object |
560+-------------------------+------------------+-------------------------------------------------+
561
562relatedInstance List
563
564+-------------------------+------------------+-------------------------------------------------+
565|Attribute |Content |Description |
566+=========================+==================+=================================================+
567|instanceId |String |instanceId |
568+-------------------------+------------------+-------------------------------------------------+
569|modelInfo |Object |Content of modelInfo object. |
570+-------------------------+------------------+-------------------------------------------------+
571
572RequestParameters Object
573
574+-------------------------+------------------+-------------------------------------------------+
575|Attribute |Content |Description |
576+=========================+==================+=================================================+
577|UserParams |Array |The product family Id. |
578+-------------------------+------------------+-------------------------------------------------+
579
580UserParams Object
581
582+-------------------------+------------------+-------------------------------------------------+
583|Attribute |Content |Description |
584+=========================+==================+=================================================+
585|name |String |Tag name of attribute |
586+-------------------------+------------------+-------------------------------------------------+
587|value |String |Value of the tag |
588+-------------------------+------------------+-------------------------------------------------+
589
590Delete Network
591+++++++++++++++
592
593+--------------------+--------------------------------------------------------------------------------------+
594|Interface Definition|Description |
595+====================+======================================================================================+
596|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/networks/{networkInstanceId} |
597+--------------------+--------------------------------------------------------------------------------------+
598|Operation Type |DELETE |
599+--------------------+--------------------------------------------------------------------------------------+
600|Content-Type |application/json |
601+--------------------+--------------------------------------------------------------------------------------+
602
603Request Body:
604
605+----------------+---------+-----------+--------------------------+-------------------------------------------+
606|Attribute |Qualifier|Cardinality|Content |Description |
607+================+=========+===========+==========================+===========================================+
608|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
609+----------------+---------+-----------+--------------------------+-------------------------------------------+
610
611RequestDetails Object
612
613+---------------------+-------------------------+-------------------------------------------------+
614|Attribute |Content |Description |
615+=====================+=========================+=================================================+
616|modelInfo |modelInfo Object |Content of modelInfo object. |
617+---------------------+-------------------------+-------------------------------------------------+
618|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
619+---------------------+-------------------------+-------------------------------------------------+
620|requestInfo |requestInfo Object |Content of requestInfo object. |
621+---------------------+-------------------------+-------------------------------------------------+
622
623ModelInfo Object
624
625+-------------------------+------------------+-------------------------------------------------+
626|Attribute |Content |Description |
627+=========================+==================+=================================================+
628|ModelType |String |Type of model |
629+-------------------------+------------------+-------------------------------------------------+
630|ModelName |String |Name of the Model |
631+-------------------------+------------------+-------------------------------------------------+
632
633CloudConfiguration Object
634
635+-------------------------+------------------+-------------------------------------------------+
636|Attribute |Content |Description |
637+=========================+==================+=================================================+
638|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
639+-------------------------+------------------+-------------------------------------------------+
640|tenantId |String |Name of the Subscriber |
641+-------------------------+------------------+-------------------------------------------------+
642
643RequestInfo Object
644
645+-------------------------+------------------+-------------------------------------------------+
646|Attribute |Content |Description |
647+=========================+==================+=================================================+
648|Source |String |source of the request |
649+-------------------------+------------------+-------------------------------------------------+
650
651Create VNF
652+++++++++++++++
653
654+--------------------+--------------------------------------------------------------+
655|Interface Definition|Description |
656+====================+==============================================================+
657|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs |
658+--------------------+--------------------------------------------------------------+
659|Operation Type |POST |
660+--------------------+--------------------------------------------------------------+
661|Content-Type |application/json |
662+--------------------+--------------------------------------------------------------+
663
664Request Body:
665
666+----------------+---------+-----------+--------------------------+-------------------------------------------+
667|Attribute |Qualifier|Cardinality|Content |Description |
668+================+=========+===========+==========================+===========================================+
669|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
670+----------------+---------+-----------+--------------------------+-------------------------------------------+
671
672RequestDetails Object
673
674+---------------------+-------------------------+-------------------------------------------------+
675|Attribute |Content |Description |
676+=====================+=========================+=================================================+
677|modelInfo |modelInfo Object |Content of modelInfo object. |
678+---------------------+-------------------------+-------------------------------------------------+
679|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
680+---------------------+-------------------------+-------------------------------------------------+
681|requestInfo |requestInfo Object |Content of requestInfo object. |
682+---------------------+-------------------------+-------------------------------------------------+
683|relatedInstanceList |List |Content of relatedInstanceList. |
684+---------------------+-------------------------+-------------------------------------------------+
685|requestParameters |requestParameters Object |Content of requestParameters object. |
686+---------------------+-------------------------+-------------------------------------------------+
687
688ModelInfo Object
689
690+-------------------------+------------------+-------------------------------------------------+
691|Attribute |Content |Description |
692+=========================+==================+=================================================+
693|ModelType |String |Type of model |
694+-------------------------+------------------+-------------------------------------------------+
695|ModelInvariantId |String |The Model Invariant Id. |
696+-------------------------+------------------+-------------------------------------------------+
697|ModelNameVersionId |String |The modelname Version Id |
698+-------------------------+------------------+-------------------------------------------------+
699|ModelName |String |Name of the Model |
700+-------------------------+------------------+-------------------------------------------------+
701|ModelVersion |String |Version of the model |
702+-------------------------+------------------+-------------------------------------------------+
703|ModelCustomization Name |String |The Model Customization name |
704+-------------------------+------------------+-------------------------------------------------+
705
706CloudConfiguration Object
707
708+-------------------------+------------------+-------------------------------------------------+
709|Attribute |Content |Description |
710+=========================+==================+=================================================+
711|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
712+-------------------------+------------------+-------------------------------------------------+
713|tenantId |String |Name of the Subscriber |
714+-------------------------+------------------+-------------------------------------------------+
715
716RequestInfo Object
717
718+-------------------------+------------------+-------------------------------------------------+
719|Attribute |Content |Description |
720+=========================+==================+=================================================+
721|InstanceName |String |The instance Name |
722+-------------------------+------------------+-------------------------------------------------+
723|ProductFamilyId |String |The product family Id. |
724+-------------------------+------------------+-------------------------------------------------+
725|Source |String |source of the request |
726+-------------------------+------------------+-------------------------------------------------+
727|SuppressRollback |Boolean |SuppressRollback |
728+-------------------------+------------------+-------------------------------------------------+
729
730relatedInstance List
731
732+-------------------------+------------------+-------------------------------------------------+
733|Attribute |Content |Description |
734+=========================+==================+=================================================+
735|relatedInstance |Object |relatedInstance Object |
736+-------------------------+------------------+-------------------------------------------------+
737
738relatedInstance List
739
740+-------------------------+------------------+-------------------------------------------------+
741|Attribute |Content |Description |
742+=========================+==================+=================================================+
743|instanceId |String |instanceId |
744+-------------------------+------------------+-------------------------------------------------+
745|modelInfo |Object |Content of modelInfo object. |
746+-------------------------+------------------+-------------------------------------------------+
747
748RequestParameters Object
749
750+-------------------------+------------------+-------------------------------------------------+
751|Attribute |Content |Description |
752+=========================+==================+=================================================+
753|UserParams |Array |The product family Id. |
754+-------------------------+------------------+-------------------------------------------------+
755
756UserParams Object
757
758+-------------------------+------------------+-------------------------------------------------+
759|Attribute |Content |Description |
760+=========================+==================+=================================================+
761|name |String |Tag name of attribute |
762+-------------------------+------------------+-------------------------------------------------+
763|value |String |Value of the tag |
764+-------------------------+------------------+-------------------------------------------------+
765
766Delete VNF
767+++++++++++++++
768
769+--------------------+------------------------------------------------------------------------------+
770|Interface Definition|Description |
771+====================+==============================================================================+
772|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId} |
773+--------------------+------------------------------------------------------------------------------+
774|Operation Type |DELETE |
775+--------------------+------------------------------------------------------------------------------+
776|Content-Type |application/json |
777+--------------------+------------------------------------------------------------------------------+
778
779Request Body:
780
781+----------------+---------+-----------+--------------------------+-------------------------------------------+
782|Attribute |Qualifier|Cardinality|Content |Description |
783+================+=========+===========+==========================+===========================================+
784|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
785+----------------+---------+-----------+--------------------------+-------------------------------------------+
786
787RequestDetails Object
788
789+---------------------+-------------------------+-------------------------------------------------+
790|Attribute |Content |Description |
791+=====================+=========================+=================================================+
792|modelInfo |modelInfo Object |Content of modelInfo object. |
793+---------------------+-------------------------+-------------------------------------------------+
794|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
795+---------------------+-------------------------+-------------------------------------------------+
796|requestInfo |requestInfo Object |Content of requestInfo object. |
797+---------------------+-------------------------+-------------------------------------------------+
798|requestParameters |requestParameters Object |Content of requestParameters object. |
799+---------------------+-------------------------+-------------------------------------------------+
800
801ModelInfo Object
802
803+-------------------------+------------------+-------------------------------------------------+
804|Attribute |Content |Description |
805+=========================+==================+=================================================+
806|ModelType |String |Type of model |
807+-------------------------+------------------+-------------------------------------------------+
808|ModelName |String |Name of the Model |
809+-------------------------+------------------+-------------------------------------------------+
810
811CloudConfiguration Object
812
813+-------------------------+------------------+-------------------------------------------------+
814|Attribute |Content |Description |
815+=========================+==================+=================================================+
816|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
817+-------------------------+------------------+-------------------------------------------------+
818|tenantId |String |Name of the Subscriber |
819+-------------------------+------------------+-------------------------------------------------+
820
821RequestInfo Object
822
823+-------------------------+------------------+-------------------------------------------------+
824|Attribute |Content |Description |
825+=========================+==================+=================================================+
826|Source |String |source of the request |
827+-------------------------+------------------+-------------------------------------------------+
828
829RequestParameters Object
830
831+-------------------------+------------------+-------------------------------------------------+
832|Attribute |Content |Description |
833+=========================+==================+=================================================+
834|UserParams |Array |The product family Id. |
835+-------------------------+------------------+-------------------------------------------------+
836
837UserParams Object
838
839+-------------------------+------------------+-------------------------------------------------+
840|Attribute |Content |Description |
841+=========================+==================+=================================================+
842|name |String |Tag name of attribute |
843+-------------------------+------------------+-------------------------------------------------+
844|value |String |Value of the tag |
845+-------------------------+------------------+-------------------------------------------------+
846
847GET Orchestration Request
848++++++++++++++++++++++++++
849
850+--------------------+--------------------------------------------------------------+
851|Interface Definition|Description |
852+====================+==============================================================+
853|URI |{serverRoot}/orchestrationRequests/v2/{request-id} |
854+--------------------+--------------------------------------------------------------+
855|Operation Type |GET |
856+--------------------+--------------------------------------------------------------+
857|Content-Type |application/json |
858+--------------------+--------------------------------------------------------------+
859
860Response Body:
861
862+----------------+---------+-----------+--------------------------+-------------------------------------------+
863|Attribute |Qualifier|Cardinality|Content |Description |
864+================+=========+===========+==========================+===========================================+
865|request |M |1 |request Object |Content of request object. |
866+----------------+---------+-----------+--------------------------+-------------------------------------------+
867
868Request Object
869
870+-------------------+---------+-----------+--------------------------+-------------------------------------------+
871|Attribute |Qualifier|Cardinality|Content |Description |
872+===================+=========+===========+==========================+===========================================+
873|requestId |M |1 |String |Request Id |
874+-------------------+---------+-----------+--------------------------+-------------------------------------------+
875|startTime |M |1 |request Object |Start time. |
876+-------------------+---------+-----------+--------------------------+-------------------------------------------+
877|serviceInstanceId |M |1 |request Object |Service Instance id. |
878+-------------------+---------+-----------+--------------------------+-------------------------------------------+
879|requestScope |M |1 |request Object |Scope of the request. |
880+-------------------+---------+-----------+--------------------------+-------------------------------------------+
881|requestType |M |1 |request Object |Type of the request. |
882+-------------------+---------+-----------+--------------------------+-------------------------------------------+
883|requestDetails |M |1 |requestDetails Object |Type of the request. |
884+-------------------+---------+-----------+--------------------------+-------------------------------------------+
885|requestStatus |M |1 |requestStatus Object |Type of the request. |
886+-------------------+---------+-----------+--------------------------+-------------------------------------------+
887
888RequestDetails Object
889
890+-------------------+-------------------------+-------------------------------------------------+
891|Attribute |Content |Description |
892+===================+=========================+=================================================+
893|modelInfo |modelInfo Object |Content of modelInfo object. |
894+-------------------+-------------------------+-------------------------------------------------+
895|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
896+-------------------+-------------------------+-------------------------------------------------+
897|requestInfo |requestInfo Object |Content of requestInfo object. |
898+-------------------+-------------------------+-------------------------------------------------+
899|requestParameters |requestParameters Object |Content of requestParameters object. |
900+-------------------+-------------------------+-------------------------------------------------+
901
902ModelInfo Object
903
904+-------------------------+------------------+-------------------------------------------------+
905|Attribute |Content |Description |
906+=========================+==================+=================================================+
907|ModelType |String |Type of model |
908+-------------------------+------------------+-------------------------------------------------+
909|ModelInvariantId |String |The Model Invariant Id. |
910+-------------------------+------------------+-------------------------------------------------+
911|ModelNameVersionId |String |The modelname Version Id |
912+-------------------------+------------------+-------------------------------------------------+
913|ModelName |String |Name of the Model |
914+-------------------------+------------------+-------------------------------------------------+
915|ModelVersion |String |Version of the model |
916+-------------------------+------------------+-------------------------------------------------+
917
918SubscriberInfo Object
919
920+-------------------------+------------------+-------------------------------------------------+
921|Attribute |Content |Description |
922+=========================+==================+=================================================+
923|GlobalSubscriberId |String |Global customer Id (in A&AI) |
924+-------------------------+------------------+-------------------------------------------------+
925|SubscriberName |String |Name of the Subscriber |
926+-------------------------+------------------+-------------------------------------------------+
927
928RequestInfo Object
929
930+-------------------------+------------------+-------------------------------------------------+
931|Attribute |Content |Description |
932+=========================+==================+=================================================+
933|InstanceName |String |The instance Name |
934+-------------------------+------------------+-------------------------------------------------+
935|Source |String |source of the request |
936+-------------------------+------------------+-------------------------------------------------+
937|SuppressRollback |Boolean |SuppressRollback |
938+-------------------------+------------------+-------------------------------------------------+
939
940RequestParameters Object
941
942+-------------------------+------------------+-------------------------------------------------+
943|Attribute |Content |Description |
944+=========================+==================+=================================================+
945|SubscriptionServiceType |String |The service type of the Subscription |
946+-------------------------+------------------+-------------------------------------------------+
947
948RequestStatus Object
949
950+-------------------------+------------------+-------------------------------------------------+
951|Attribute |Content |Description |
952+=========================+==================+=================================================+
953|timestamp |String |Time |
954+-------------------------+------------------+-------------------------------------------------+
955|requestState |String |state of the request |
956+-------------------------+------------------+-------------------------------------------------+
957|statusMessage |String |statusMessage |
958+-------------------------+------------------+-------------------------------------------------+
959|percentProgress |String |percentage of progress |
960+-------------------------+------------------+-------------------------------------------------+
961
962GET Orchestration Requests
963++++++++++++++++++++++++++
964
965+--------------------+--------------------------------------------------------------+
966|Interface Definition|Description |
967+====================+==============================================================+
968|URI |{serverRoot}/orchestrationRequests/v2 |
969+--------------------+--------------------------------------------------------------+
970|Operation Type |GET |
971+--------------------+--------------------------------------------------------------+
972|Content-Type |application/json |
973+--------------------+--------------------------------------------------------------+
974
975Response Body:
976
977+----------------+---------+-----------+--------------------------+-------------------------------------------+
978|Attribute |Qualifier|Cardinality|Content |Description |
979+================+=========+===========+==========================+===========================================+
980|requestList |M |1 |Array |Content of request List. |
981+----------------+---------+-----------+--------------------------+-------------------------------------------+
982
983RequestList :
984
985+----------------+---------+-----------+--------------------------+-------------------------------------------+
986|Attribute |Qualifier|Cardinality|Content |Description |
987+================+=========+===========+==========================+===========================================+
988|request |M |1 |request Object |Content of request object. |
989+----------------+---------+-----------+--------------------------+-------------------------------------------+
990
991Request Object
992
993+-------------------+---------+-----------+--------------------------+-------------------------------------------+
994|Attribute |Qualifier|Cardinality|Content |Description |
995+===================+=========+===========+==========================+===========================================+
996|requestId |M |1 |String |Request Id |
997+-------------------+---------+-----------+--------------------------+-------------------------------------------+
998|startTime |M |1 |request Object |Start time. |
999+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1000|serviceInstanceId |M |1 |request Object |Service Instance id. |
1001+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1002|requestScope |M |1 |request Object |Scope of the request. |
1003+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1004|requestType |M |1 |request Object |Type of the request. |
1005+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1006|requestDetails |M |1 |requestDetails Object |Type of the request. |
1007+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1008|requestStatus |M |1 |requestStatus Object |Type of the request. |
1009+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1010
1011RequestDetails Object
1012
1013+-------------------+-------------------------+-------------------------------------------------+
1014|Attribute |Content |Description |
1015+===================+=========================+=================================================+
1016|modelInfo |modelInfo Object |Content of modelInfo object. |
1017+-------------------+-------------------------+-------------------------------------------------+
1018|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
1019+-------------------+-------------------------+-------------------------------------------------+
1020|requestInfo |requestInfo Object |Content of requestInfo object. |
1021+-------------------+-------------------------+-------------------------------------------------+
1022|requestParameters |requestParameters Object |Content of requestParameters object. |
1023+-------------------+-------------------------+-------------------------------------------------+
1024
1025ModelInfo Object
1026
1027+-------------------------+------------------+-------------------------------------------------+
1028|Attribute |Content |Description |
1029+=========================+==================+=================================================+
1030|ModelType |String |Type of model |
1031+-------------------------+------------------+-------------------------------------------------+
1032|ModelInvariantId |String |The Model Invariant Id. |
1033+-------------------------+------------------+-------------------------------------------------+
1034|ModelNameVersionId |String |The modelname Version Id |
1035+-------------------------+------------------+-------------------------------------------------+
1036|ModelName |String |Name of the Model |
1037+-------------------------+------------------+-------------------------------------------------+
1038|ModelVersion |String |Version of the model |
1039+-------------------------+------------------+-------------------------------------------------+
1040
1041SubscriberInfo Object
1042
1043+-------------------------+------------------+-------------------------------------------------+
1044|Attribute |Content |Description |
1045+=========================+==================+=================================================+
1046|GlobalSubscriberId |String |Global customer Id (in A&AI) |
1047+-------------------------+------------------+-------------------------------------------------+
1048|SubscriberName |String |Name of the Subscriber |
1049+-------------------------+------------------+-------------------------------------------------+
1050
1051RequestInfo Object
1052
1053+-------------------------+------------------+-------------------------------------------------+
1054|Attribute |Content |Description |
1055+=========================+==================+=================================================+
1056|InstanceName |String |The instance Name |
1057+-------------------------+------------------+-------------------------------------------------+
1058|Source |String |source of the request |
1059+-------------------------+------------------+-------------------------------------------------+
1060|SuppressRollback |Boolean |SuppressRollback |
1061+-------------------------+------------------+-------------------------------------------------+
1062
1063RequestParameters Object
1064
1065+-------------------------+------------------+-------------------------------------------------+
1066|Attribute |Content |Description |
1067+=========================+==================+=================================================+
1068|SubscriptionServiceType |String |The service type of the Subscription |
1069+-------------------------+------------------+-------------------------------------------------+
1070
1071RequestStatus Object
1072
1073+-------------------------+------------------+-------------------------------------------------+
1074|Attribute |Content |Description |
1075+=========================+==================+=================================================+
1076|timestamp |String |Time |
1077+-------------------------+------------------+-------------------------------------------------+
1078|requestState |String |state of the request |
1079+-------------------------+------------------+-------------------------------------------------+
1080|statusMessage |String |statusMessage |
1081+-------------------------+------------------+-------------------------------------------------+
1082|percentProgress |String |percentage of progress |
1083+-------------------------+------------------+-------------------------------------------------+
1084
1085SDC API
1086--------
1087
1088Get List of Existing Catalog Assets
1089+++++++++++++++++++++++++++++++++++
1090
1091+--------------------+--------------------------+
1092|Interface Definition|Description |
1093+====================+==========================+
1094|URI |sdc/v1/catalog/{assetType}|
1095+--------------------+--------------------------+
1096|Operation Type |GET |
1097+--------------------+--------------------------+
1098
1099Request Parameters:
1100
1101+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1102|Attribute |Qualifier|Cardinality|Content|Description |
1103+===================+=========+===========+=======+=============================================================+
1104|assetType |M |1 |String |The requested asset type.valid values are resources/services.|
1105+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1106|service-type |M |1 |String |Service Type |
1107+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1108|service-instance-id|M |1 |String |Service Instance ID |
1109+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1110
1111Request Headers:
1112
1113+-------------------+---------+-----------------------------------------------------------------------------------------+
1114|Header Name |Qualifier|Description |
1115+===================+=========+=========================================================================================+
1116|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1117+-------------------+---------+-----------------------------------------------------------------------------------------+
1118|X-ECOMP-InstanceID |Y |Instance ID |
1119+-------------------+---------+-----------------------------------------------------------------------------------------+
1120|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1121+-------------------+---------+-----------------------------------------------------------------------------------------+
1122|Authorization |Y |Base64 encoded username:password |
1123+-------------------+---------+-----------------------------------------------------------------------------------------+
1124
1125Response:
1126
1127+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1128|Attribute |Qualifier|Cardinality|Content|Description |
1129+==================+=========+===========+=======+======================================================================================+
1130|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1131+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1132|invariantUUID |M |1 |String |UUID generated by SDC per each asset. |
1133+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1134|name |M |1 |String |The name of the asset |
1135+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1136|version |M |1 |String |The asset version in SDC catalog. |
1137+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1138|toscaModelURL |M |1 |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
1139+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1140|category |M |1 |String |Category of the asset. |
1141+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1142|subcategory |M |1 |String |Sub-category of the asset |
1143+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1144|resourceType |M |1 |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF. |
1145+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1146|lifecycleState |M |1 |String |The lifecycle state of the asset |
1147+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1148|lastUpdaterUserId |M |1 |String |UserID of the SDC designer who was the last to update the asset for this major version|
1149+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1150
1151Get Specific Asset Detailed Metadata
1152++++++++++++++++++++++++++++++++++++
1153
1154+--------------------+-------------------------------------------+
1155|Interface Definition|Description |
1156+====================+===========================================+
1157|URI |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
1158+--------------------+-------------------------------------------+
1159|Operation Type |GET |
1160+--------------------+-------------------------------------------+
1161
1162Request Parameters:
1163
1164+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1165|Attribute |Qualifier|Cardinality|Content|Description |
1166+===================+=========+===========+=======+=====================================================================================+
1167|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1168+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1169|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
1170+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1171
1172Request Headers:
1173
1174+-------------------+---------+-----------------------------------------------------------------------------------------+
1175|Header Name |Qualifier|Description |
1176+===================+=========+=========================================================================================+
1177|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1178+-------------------+---------+-----------------------------------------------------------------------------------------+
1179|X-ECOMP-InstanceID |Y |Instance ID |
1180+-------------------+---------+-----------------------------------------------------------------------------------------+
1181|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1182+-------------------+---------+-----------------------------------------------------------------------------------------+
1183|Authorization |Y |Base64 encoded username:password |
1184+-------------------+---------+-----------------------------------------------------------------------------------------+
1185
1186Response:
1187
1188+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1189|Attribute |Qualifier|Content|Description |
1190+====================+=========+=======+======================================================================================+
1191|uuid |M |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1192+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1193|invariantUUID |M |String |UUID generated by SDC per each asset. |
1194+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1195|name |M |String |The name of the asset |
1196+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1197|version |M |String |The asset version in SDC catalog. |
1198+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1199|toscaModelURL |M |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
1200+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1201|description |M |String |Short description of the resource |
1202+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1203|lastUpdaterUserId |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1204+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1205|lastUpdaterFullName |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1206+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1207|category |M |String |Category of the asset |
1208+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1209|subCategory |M |String |Sub-category of the asset. |
1210+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1211|toscaResourceName |M |String |The full name of the asset |
1212+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1213|resourceType |M |String |The type of resource. |
1214+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1215|lifecycleState |M |String |The lifecycle state of the asset |
1216+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1217|resources |N |Object |Category of the asset |
1218+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1219|artifacts |M |Object |Category of the asset |
1220+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1221
1222Resource Object:
1223
1224+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1225|Attribute |Qualifier|Content|Description | |
1226+=====================+=========+=======+===================================================================================================================+
1227|resourceInstanceName |M |String |Logical Resource Instance Name.Unique Identifier of the instance of the specific resource in the service context.|
1228+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1229|resourceName |M |String |Resource Name |
1230+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1231|resourceInvariantUUID|M |String |The invariant UUID of the resource |
1232+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1233|resourceVersion |M |String |Resource Version |
1234+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1235|resoucreType |M |String |Resource Type |
1236+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1237|resourceUUID |M |String |Global UUID of the resource that specific artifact belongs to |
1238+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1239|artifacts |M |Object |Array of resource instance deployment artifacts. |
1240+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1241
1242Artifact Metadata Object:
1243
1244+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1245|Attribute |Qualifier|Content |Description |
1246+=====================+=========+========+===================================================================================================================+
1247|artifactName |M |String |Artifact File name |
1248+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1249|artifactLabel |M |String |Identifier of the artifact within the VF / Service. |
1250+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1251|artifactType |M |String |Artifact Type |
1252+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1253|artifactGroupType |M |String |Whether the artifact is informational or deployment. |
1254+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1255|artifactURL |M |String |Relative artifact’s URL. |
1256+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1257|artifactDescription |M |String |Artifact Description |
1258+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1259|artifactTimeout |N |Integer |Artifact Description |
1260+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1261|artifactChecksum |M |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1262+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1263|artifactUUID |M |String |Global UUID generated by SDC each time when artifact payload is updated. |
1264+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1265|artifactVersion |M |String |Service Version |
1266+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1267|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1268+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1269
1270Download (CSAR of) Specific Asset
1271+++++++++++++++++++++++++++++++++
1272
1273+--------------------+-----------------------------------------------------------+
1274|Interface Definition|Description |
1275+====================+===========================================================+
1276|URI |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
1277+--------------------+-----------------------------------------------------------+
1278|Operation Type |GET |
1279+--------------------+-----------------------------------------------------------+
1280
1281Request Parameters:
1282
1283+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1284|Attribute |Qualifier|Cardinality|Content|Description |
1285+===================+=========+===========+=======+=====================================================================================+
1286|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1287+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1288|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1289+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1290|artifactUUID |M |1 |String |The artifactUUID of the asset as published in the metadata |
1291+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1292
1293Response:
1294
1295+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1296|Header name |Qualifier|Description |
1297+====================+=========+==========================================================================================================================+
1298|Content-Type |M |Specifies the downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
1299+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1300|Content-Length |M |Streamed artifact payload size |
1301+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1302|Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . |
1303+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1304
1305Upload Artifact
1306+++++++++++++++
1307
1308+--------------------+-----------------------------------------------------------------------------------------------+
1309|Interface Definition|Description |
1310+====================+===============================================================================================+
1311|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
1312+--------------------+-----------------------------------------------------------------------------------------------+
1313|Operation Type |POST |
1314+--------------------+-----------------------------------------------------------------------------------------------+
1315
1316Request Parameters:
1317
1318+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1319|Attribute |Qualifier|Cardinality|Content|Description |
1320+==============================+=========+===========+=======+=====================================================================================+
1321|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1322+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1323|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1324+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1325|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1326+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1327
1328Request Body
1329++++++++++++
1330
1331+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1332|Attribute |Qualifier|Cardinality|Content|Description |
1333+==============================+=========+===========+=======+=====================================================================================+
1334|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1335+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1336|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1337+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1338|artifactName |M |1 |String |The name of the artifact |
1339+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1340|artifactType |M |1 |String |The type of the artifact |
1341+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1342|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1343+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1344|description |M |1 |String |Description of the artifact |
1345+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1346
1347Request Headers:
1348
1349+-------------------+---------+-----------------------------------------------------------------------------------------+
1350|Header Name |Qualifier|Description |
1351+===================+=========+=========================================================================================+
1352|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1353+-------------------+---------+-----------------------------------------------------------------------------------------+
1354|X-ECOMP-InstanceID |Y |Instance ID |
1355+-------------------+---------+-----------------------------------------------------------------------------------------+
1356|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1357+-------------------+---------+-----------------------------------------------------------------------------------------+
1358|Authorization |Y |Base64 encoded username:password |
1359+-------------------+---------+-----------------------------------------------------------------------------------------+
1360|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1361+-------------------+---------+-----------------------------------------------------------------------------------------+
1362|Content-Type |Y |Valid value is : application/json |
1363+-------------------+---------+-----------------------------------------------------------------------------------------+
1364|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1365+-------------------+---------+-----------------------------------------------------------------------------------------+
1366
1367Response:
1368
1369+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1370|Attribute |Qualifier|Content|Description |
1371+====================+=========+=======+===================================================================================================+
1372|artifactName |M |String |Artifact File name |
1373+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1374|artifactType |M |String |Artifact Type |
1375+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1376|artifactURL |M |String |Relative artifact’s URL. |
1377+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1378|artifactDescription |M |String |Artifact Description. |
1379+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1380|artifactTimeout |N |String |Will be populated only if its value is not 0. |
1381+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1382|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1383+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1384|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1385+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1386|artifactVersion |Y |String |Service Version . |
1387+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1388|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1389+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1390
1391Update Artifact
1392+++++++++++++++
1393
1394+--------------------+--------------------------------------------------------------------------------------------------------------+
1395|Interface Definition|Description |
1396+====================+==============================================================================================================+
1397|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1398+--------------------+--------------------------------------------------------------------------------------------------------------+
1399|Operation Type |POST |
1400+--------------------+--------------------------------------------------------------------------------------------------------------+
1401
1402Request Parameters:
1403
1404+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1405|Attribute |Qualifier|Cardinality|Content|Description |
1406+==============================+=========+===========+=======+=====================================================================================+
1407|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1408+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1409|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1410+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1411|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1412+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1413|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1414+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1415
1416Request Headers:
1417
1418+-------------------+---------+-----------------------------------------------------------------------------------------+
1419|Header Name |Qualifier|Description |
1420+===================+=========+=========================================================================================+
1421|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1422+-------------------+---------+-----------------------------------------------------------------------------------------+
1423|X-ECOMP-InstanceID |Y |Instance ID |
1424+-------------------+---------+-----------------------------------------------------------------------------------------+
1425|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1426+-------------------+---------+-----------------------------------------------------------------------------------------+
1427|Authorization |Y |Base64 encoded username:password |
1428+-------------------+---------+-----------------------------------------------------------------------------------------+
1429|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1430+-------------------+---------+-----------------------------------------------------------------------------------------+
1431|Content-Type |Y |Valid value is : application/json |
1432+-------------------+---------+-----------------------------------------------------------------------------------------+
1433|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1434+-------------------+---------+-----------------------------------------------------------------------------------------+
1435
1436Request Body:
1437
1438+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1439|Attribute |Qualifier|Cardinality|Content|Description |
1440+==============================+=========+===========+=======+=====================================================================================+
1441|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1442+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1443|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1444+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1445|artifactName |M |1 |String |The name of the artifact |
1446+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1447|artifactType |M |1 |String |The type of the artifact |
1448+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1449|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1450+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1451|description |M |1 |String |Description of the artifact |
1452+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1453
1454Response:
1455
1456+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1457|Attribute |Qualifier|Content|Description |
1458+====================+=========+=======+===================================================================================================+
1459|artifactName |M |String |Artifact File name |
1460+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1461|artifactType |M |String |Artifact Type |
1462+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1463|artifactURL |M |String |Relative artifact’s URL. |
1464+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1465|artifactDescription |M |String |Artifact Description. |
1466+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1467|artifactTimeout |N |String |Will be populated only if its value is not 0. |
1468+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1469|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1470+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1471|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1472+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1473|artifactVersion |Y |String |Service Version . |
1474+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1475|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1476+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1477
1478Delete Artifact
1479+++++++++++++++
1480
1481+--------------------+--------------------------------------------------------------------------------------------------------------+
1482|Interface Definition|Description |
1483+====================+==============================================================================================================+
1484|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1485+--------------------+--------------------------------------------------------------------------------------------------------------+
1486|Operation Type |DELETE |
1487+--------------------+--------------------------------------------------------------------------------------------------------------+
1488
1489Request Parameters:
1490
1491+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1492|Attribute |Qualifier|Cardinality|Content|Description |
1493+==============================+=========+===========+=======+=====================================================================================+
1494|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1495+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1496|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1497+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1498|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1499+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1500|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1501+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1502
1503Request Headers:
1504
1505+-------------------+---------+-----------------------------------------------------------------------------------------+
1506|Header Name |Qualifier|Description |
1507+===================+=========+=========================================================================================+
1508|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1509+-------------------+---------+-----------------------------------------------------------------------------------------+
1510|X-ECOMP-InstanceID |Y |Instance ID |
1511+-------------------+---------+-----------------------------------------------------------------------------------------+
1512|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1513+-------------------+---------+-----------------------------------------------------------------------------------------+
1514|Authorization |Y |Base64 encoded username:password |
1515+-------------------+---------+-----------------------------------------------------------------------------------------+
1516|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1517+-------------------+---------+-----------------------------------------------------------------------------------------+
1518
1519Response:
1520
1521+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1522|Attribute |Qualifier|Content|Description |
1523+====================+=========+=======+===================================================================================================+
1524|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1525+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1526
1527Update Lifecycle
1528++++++++++++++++
1529
1530+--------------------+--------------------------------------------------------------------------------------------------------------+
1531|Interface Definition|Description |
1532+====================+==============================================================================================================+
1533|URI |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation} |
1534+--------------------+--------------------------------------------------------------------------------------------------------------+
1535|Operation Type |POST |
1536+--------------------+--------------------------------------------------------------------------------------------------------------+
1537
1538Request Parameters:
1539
1540+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1541|Attribute |Qualifier|Cardinality|Content|Description |
1542+==============================+=========+===========+=======+=====================================================================================================+
1543|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1544+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1545|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1546+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1547|lifecycleOperation |M |1 |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout / Certify |
1548+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1549
1550Request Headers:
1551
1552+-------------------+---------+-----------------------------------------------------------------------------------------+
1553|Header Name |Qualifier|Description |
1554+===================+=========+=========================================================================================+
1555|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1556+-------------------+---------+-----------------------------------------------------------------------------------------+
1557|X-ECOMP-InstanceID |Y |Instance ID |
1558+-------------------+---------+-----------------------------------------------------------------------------------------+
1559|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1560+-------------------+---------+-----------------------------------------------------------------------------------------+
1561|Authorization |Y |Base64 encoded username:password |
1562+-------------------+---------+-----------------------------------------------------------------------------------------+
1563|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1564+-------------------+---------+-----------------------------------------------------------------------------------------+
1565
1566Request Parameters:
1567
1568+-------------------+---------+-----------------------------------------------------------------------------------------+
1569|Attribute |Qualifier|Description |
1570+===================+=========+=========================================================================================+
1571|userRemarks |N |Short description (free text) about the asset version being changed |
1572+-------------------+---------+-----------------------------------------------------------------------------------------+
1573
1574Response:
1575
1576+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1577|Attribute |Qualifier|Content|Description |
1578+====================+=========+=======+===================================================================================================+
1579|uuid |Y |String |UUID generated by SDC per each major version of the asset |
1580+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1581|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1582+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1583|name |Y |String |The name of the asset. |
1584+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1585|version |Y |String |The asset version in SDC catalog |
1586+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1587|category |Y |String |Category of the asset. |
1588+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1589|subcategory |Y |String |Sub-category of the asset. |
1590+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1591|resourceType |Y |String |The type of resource. |
1592+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1593|lifecycleState |Y |String |The lifecycle state of the asset. |
1594+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1595|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1596+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1597
1598Create Resource
1599+++++++++++++++
1600
1601+--------------------+--------------------------------------------------------------------------------------------------------------+
1602|Interface Definition|Description |
1603+====================+==============================================================================================================+
1604|URI |/sdc/v1/catalog/resources |
1605+--------------------+--------------------------------------------------------------------------------------------------------------+
1606|Operation Type |POST |
1607+--------------------+--------------------------------------------------------------------------------------------------------------+
1608
1609Request Headers:
1610
1611+-------------------+---------+-----------------------------------------------------------------------------------------+
1612|Header Name |Qualifier|Description |
1613+===================+=========+=========================================================================================+
1614|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1615+-------------------+---------+-----------------------------------------------------------------------------------------+
1616|X-ECOMP-InstanceID |Y |Instance ID |
1617+-------------------+---------+-----------------------------------------------------------------------------------------+
1618|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1619+-------------------+---------+-----------------------------------------------------------------------------------------+
1620|Authorization |Y |Base64 encoded username:password |
1621+-------------------+---------+-----------------------------------------------------------------------------------------+
1622|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1623+-------------------+---------+-----------------------------------------------------------------------------------------+
1624|Content-Type |Y |Valid value is : application/json |
1625+-------------------+---------+-----------------------------------------------------------------------------------------+
1626
1627Request Parameters:
1628
1629+-------------------+---------+-----------------------------------------------------------------------------------------+
1630|Attribute |Qualifier|Description |
1631+===================+=========+=========================================================================================+
1632|name |Y |The name of the resource |
1633+-------------------+---------+-----------------------------------------------------------------------------------------+
1634|description |Y |Short description of the resource |
1635+-------------------+---------+-----------------------------------------------------------------------------------------+
1636|resourceType |Y |“VFCMT” / “VF” / “PNF” |
1637+-------------------+---------+-----------------------------------------------------------------------------------------+
1638|category |Y |VFCMT category is “Template”. |
1639+-------------------+---------+-----------------------------------------------------------------------------------------+
1640|subcategory |Y |VFCMT subcategory is “Monitoring Template”. |
1641+-------------------+---------+-----------------------------------------------------------------------------------------+
1642|vendorName |Y |Vendor Name |
1643+-------------------+---------+-----------------------------------------------------------------------------------------+
1644|vendorRelease |Y |Vendor Release |
1645+-------------------+---------+-----------------------------------------------------------------------------------------+
1646|tags |Y |The tags are used for search options. |
1647+-------------------+---------+-----------------------------------------------------------------------------------------+
1648|icon |Y |The icon should be pre-defined in SDC. |
1649+-------------------+---------+-----------------------------------------------------------------------------------------+
1650|contactId |Y |The user ID of user responsible for this VFCMT. |
1651+-------------------+---------+-----------------------------------------------------------------------------------------+
1652
1653Response:
1654
1655+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1656|Attribute |Qualifier|Content|Description |
1657+====================+=========+=======+===================================================================================================+
1658|uuid |Y |String |UUID generated by SDC per each major version of the asset |
1659+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1660|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1661+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1662|name |Y |String |The name of the asset. |
1663+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1664|version |Y |String |The asset version in SDC catalog |
1665+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1666|category |Y |String |Category of the asset. |
1667+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1668|subcategory |Y |String |Sub-category of the asset. |
1669+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1670|resourceType |Y |String |The type of resource. |
1671+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1672|lifecycleState |Y |String |The lifecycle state of the asset. |
1673+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1674|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1675+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1676
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1677UUI API
1678----------------
1679Create E2E service instance
1680++++++++++++++++++++++++++++
1681
1682+--------------------+-------------------------------------+
1683|Interface Definition|Description |
1684+====================+=====================================+
1685|URI |{serverRoot}/e2eServiceInstances/v3 |
1686+--------------------+-------------------------------------+
1687|Operation Type |POST |
1688+--------------------+-------------------------------------+
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]1689|Content-Type |application/json |
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1690+--------------------+-------------------------------------+
1691
1692Request Body:
1693
1694+---------+---------+-----------+--------------------------+-----------------------------+
1695|Attribute|Qualifier|Cardinality|Content |Description |
1696+=========+=========+===========+==========================+=============================+
1697|service |M |1 |Service Object |Content of service object. |
1698+---------+---------+-----------+--------------------------+-----------------------------+
1699
1700Service Object
1701
1702+----------------+------------------+-------------------------------------------------+
1703|Attribute |Content |Description |
1704+================+==================+=================================================+
1705|name |String |Service instance name. |
1706+----------------+------------------+-------------------------------------------------+
1707|description |String |Service instance description |
1708+----------------+------------------+-------------------------------------------------+
1709|serviceDef ID |String |The service invariantUUID. It is defined in SDC. |
1710+----------------+------------------+-------------------------------------------------+
1711|templateId |String |The service Template UUID. It is defined in SDC. |
1712+----------------+------------------+-------------------------------------------------+
1713|parameters |Parameter Object |Parameter Object |
1714+----------------+------------------+-------------------------------------------------+
1715
1716Parameter Object
1717
1718+----------------------+------------------+-----------------------------------------------------+
1719|Attribute |Content |Description |
1720+======================+==================+=====================================================+
1721|globalSubscriberId |String |The subscriber id. It is defined in AAI |
1722+----------------------+------------------+-----------------------------------------------------+
1723|subscriberName |String |The subscriber name. It is defined in AAI |
1724+----------------------+------------------+-----------------------------------------------------+
1725|serviceType |String |The service type. It is defined in AAI |
1726+----------------------+------------------+-----------------------------------------------------+
1727|templateName |String |The service Template name |
1728+----------------------+------------------+-----------------------------------------------------+
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]1729|resources |Object |This field manages parameters of resources |
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1730+----------------------+------------------+-----------------------------------------------------+
1731|resourceName |String |The resource name |
1732+----------------------+------------------+-----------------------------------------------------+
1733|resouceDefId |String |The resource invariantUUID. It is defined in SDC. |
1734+----------------------+------------------+-----------------------------------------------------+
1735|resourceId |String |The resource UUID. It is defined in SDC. |
1736+----------------------+------------------+-----------------------------------------------------+
1737|nsParameters |String |Parameters for current resource object. |
1738+----------------------+------------------+-----------------------------------------------------+
1739|locationConstraints |String |The DC location info for each VNF of current service |
1740+----------------------+------------------+-----------------------------------------------------+
1741|vnfProfileId |String |VNFD id |
1742+----------------------+------------------+-----------------------------------------------------+
1743|additionalParamForNs |String |The parameter for current resource |
1744+----------------------+------------------+-----------------------------------------------------+
1745
1746
1747Response:
1748
1749+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1750|Attribute |Qualifier|Cardinality|Content|Description |
1751+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1752|serviceId |M |1 |String |Service instance ID. |
1753+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1754|operationId |M |1 |String |Service Operation ID. |
1755+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1756
1757Delete E2E service instance
1758++++++++++++++++++++++++++++
1759
1760+--------------------+-----------------------------------------------+
1761|Interface Definition|Description |
1762+====================+===============================================+
1763|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
1764+--------------------+-----------------------------------------------+
1765|Operation Type |DELETE |
1766+--------------------+-----------------------------------------------+
1767
1768Request Parameters:
1769
1770+-------------------+---------+-----------+-------+----------------------------------------+
1771|Attribute |Qualifier|Cardinality|Content|Description |
1772+===================+=========+===========+=======+========================================+
1773|globalSubscriberId |M |1 |String |The subscriber id. It is defined in AAI |
1774+-------------------+---------+-----------+-------+----------------------------------------+
1775|serviceType |M |1 |String |The service type. It is defined in AAI |
1776+-------------------+---------+-----------+-------+----------------------------------------+
1777
1778Response:
1779
1780+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1781|Attribute |Qualifier|Cardinality|Content|Description |
1782+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1783|operationId |M |1 |String |The operation id. |
1784+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1785
1786Query E2E service operation result
1787++++++++++++++++++++++++++
1788
1789+--------------------+------------------------------------------------------------------------+
1790|Interface Definition|Description |
1791+====================+========================================================================+
1792|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
1793+--------------------+------------------------------------------------------------------------+
1794|Operation Type |GET |
1795+--------------------+------------------------------------------------------------------------+
1796
1797Request Parameters:
1798
1799+--------------+---------+-----------+-------+--------------+
1800|Attribute |Qualifier|Cardinality|Content|Description |
1801+==============+=========+===========+=======+==============+
1802|serviceId |M |1 |Service instance ID. |
1803+--------------+---------+-----------+-------+--------------+
1804|operationId |M |1 |Service Operation ID. |
1805+--------------+---------+-----------+-------+--------------+
1806
1807Response:
1808
1809+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1810|Attribute |Qualifier|Cardinality|Content|Description |
1811+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1812|operation |M |1 |String |Operation object identify. |
1813+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1814|operationId |M |1 |String |Operation ID. |
1815+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1816|operation |M |1 |String |Operation type, create|delete. |
1817+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1818|result |M |1 |String |Operation result: finished, error, processing. |
1819+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1820|reason |M |1 |String |If failing, need to write fail reason. |
1821+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1822|userId |M |1 |String |Operation user ID. |
1823+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1824|operationContent |M |1 |String |The status detail of current operation which is being executing. |
1825+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1826|progress |M |1 |String |Current operation progress. |
1827+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1828|operateAt |M |1 |String |Time that it starts to execute operation. |
1829+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1830|finishedAt |M |1 |String |Time that it finished executing operation. |
1831+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1832
seshukmfffbc992017-12-18 14:36:48 +0530[diff] [blame]1833Inventory APIs
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1834----------------
1835
1836create or update an existing service-instance
1837+++++++++++++++++++++++++++++++++++++++++++++
1838
1839+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1840|Interface Definition|Description |
1841+====================+====================================================================================================================================================================+
1842|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1843+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1844|Operation Type |PUT |
1845+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1846
1847Request Parameters:
1848
1849+-------------------+---------+-----------+-------+-----------------------+
1850|Attribute |Qualifier|Cardinality|Content|Description |
1851+===================+=========+===========+=======+=======================+
1852|global-customer-id |M |1 |String |Global Customer ID |
1853+-------------------+---------+-----------+-------+-----------------------+
1854|service-type |M |1 |String |Service Type |
1855+-------------------+---------+-----------+-------+-----------------------+
1856|service-instance-id|M |1 |String |Service Instance ID |
1857+-------------------+---------+-----------+-------+-----------------------+
1858
1859Response:
1860
1861+---------+---------+-----------+-------+-------------------+
1862|Attribute|Qualifier|Cardinality|Content|Description |
1863+---------+---------+-----------+-------+-------------------+
1864|HTTP code|M |1 |Integer|HTTP response code |
1865+---------+---------+-----------+-------+-------------------+
1866
1867delete an existing service-instance
1868+++++++++++++++++++++++++++++++++++
1869
1870+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1871|Interface Definition|Description |
1872+====================+====================================================================================================================================================================+
1873|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1874+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1875|Operation Type |DELETE |
1876+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1877
1878Request Parameters:
1879
1880+-------------------+---------+-----------+-------+-----------------------+
1881|Attribute |Qualifier|Cardinality|Content|Description |
1882+===================+=========+===========+=======+=======================+
1883|global-customer-id |M |1 |String |Global Customer ID |
1884+-------------------+---------+-----------+-------+-----------------------+
1885|service-type |M |1 |String |Service Type |
1886+-------------------+---------+-----------+-------+-----------------------+
1887|service-instance-id|M |1 |String |Service Instance ID |
1888+-------------------+---------+-----------+-------+-----------------------+
1889
1890Response:
1891
1892+---------+---------+-----------+-------+-------------------+
1893|Attribute|Qualifier|Cardinality|Content|Description |
1894+---------+---------+-----------+-------+-------------------+
1895|HTTP code|M |1 |Integer|HTTP response code |
1896+---------+---------+-----------+-------+-------------------+
1897
1898get service-instances
1899+++++++++++++++++++++
1900
1901+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1902|Interface Definition|Description |
1903+====================+=============================================================================================================================+
1904|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
1905+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1906|Operation Type |GET |
1907+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1908
1909Request Parameters:
1910
1911+-------------------+---------+-----------+-------+-----------------------+
1912|Attribute |Qualifier|Cardinality|Content|Description |
1913+===================+=========+===========+=======+=======================+
1914|global-customer-id |M |1 |String |Global Customer ID |
1915+-------------------+---------+-----------+-------+-----------------------+
1916|service-type |M |1 |String |Service Type |
1917+-------------------+---------+-----------+-------+-----------------------+
1918
1919Response:
1920
1921+-----------------+---------+-----------+----------------+-------------------+
1922|Attribute |Qualifier|Cardinality|Content |Description |
1923+-----------------+---------+-----------+----------------+-------------------+
1924|service-instances|M |1 |ServiceInstances|Service Instances |
1925+-----------------+---------+-----------+----------------+-------------------+
1926
1927get service-instance
1928++++++++++++++++++++
1929
1930+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1931|Interface Definition|Description |
1932+====================+====================================================================================================================================================================+
1933|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1934+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1935|Operation Type |GET |
1936+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1937
1938Request Parameters:
1939
1940+-------------------+---------+-----------+-------+-----------------------+
1941|Attribute |Qualifier|Cardinality|Content|Description |
1942+===================+=========+===========+=======+=======================+
1943|global-customer-id |M |1 |String |Global Customer ID |
1944+-------------------+---------+-----------+-------+-----------------------+
1945|service-type |M |1 |String |Service Type |
1946+-------------------+---------+-----------+-------+-----------------------+
1947|service-instance-id|M |1 |String |Service instance ID |
1948+-------------------+---------+-----------+-------+-----------------------+
1949
1950Response:
1951
1952+-----------------+---------+-----------+----------------+-------------------+
1953|Attribute |Qualifier|Cardinality|Content |Description |
1954+-----------------+---------+-----------+----------------+-------------------+
1955|service-instance |M |1 |ServiceInstance |Service Instance |
1956+-----------------+---------+-----------+----------------+-------------------+
1957
1958see node definition for valid relationships
1959+++++++++++++++++++++++++++++++++++++++++++
1960
1961+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1962|Interface Definition|Description |
1963+====================+===================================================================================================================================================================================================+
1964|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
1965+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1966|Operation Type |PUT |
1967+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1968
1969Request Parameters:
1970
1971+-------------------+---------+-----------+-------+-----------------------+
1972|Attribute |Qualifier|Cardinality|Content|Description |
1973+===================+=========+===========+=======+=======================+
1974|global-customer-id |M |1 |String |Global Customer ID |
1975+-------------------+---------+-----------+-------+-----------------------+
1976|service-type |M |1 |String |Service Type |
1977+-------------------+---------+-----------+-------+-----------------------+
1978|service-instance-id|M |1 |String |Service instance ID |
1979+-------------------+---------+-----------+-------+-----------------------+
1980
1981Response:
1982
1983+---------+---------+-----------+-------+-------------------+
1984|Attribute|Qualifier|Cardinality|Content|Description |
1985+---------+---------+-----------+-------+-------------------+
1986|HTTP code|M |1 |Integer|HTTP response code |
1987+---------+---------+-----------+-------+-------------------+
1988
1989delete an existing relationship
1990+++++++++++++++++++++++++++++++
1991
1992+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1993|Interface Definition|Description |
1994+====================+===================================================================================================================================================================================================+
1995|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
1996+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1997|Operation Type |DELETE |
1998+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1999
2000Request Parameters:
2001
2002+-------------------+---------+-----------+-------+-----------------------+
2003|Attribute |Qualifier|Cardinality|Content|Description |
2004+===================+=========+===========+=======+=======================+
2005|global-customer-id |M |1 |String |Global Customer ID |
2006+-------------------+---------+-----------+-------+-----------------------+
2007|service-type |M |1 |String |Service Type |
2008+-------------------+---------+-----------+-------+-----------------------+
2009|service-instance-id|M |1 |String |Service instance ID |
2010+-------------------+---------+-----------+-------+-----------------------+
2011
2012Response:
2013
2014+---------+---------+-----------+-------+-------------------+
2015|Attribute|Qualifier|Cardinality|Content|Description |
2016+---------+---------+-----------+-------+-------------------+
2017|HTTP code|M |1 |Integer|HTTP response code |
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]2018+---------+---------+-----------+-------+-------------------+
2019
2020
2021VFC APIs
2022---------
2023
2024Create NS
2025+++++++++++
2026
2027+--------------------+-------------------+
2028|Interface Definition|Description |
2029+====================+===================+
2030|URI |/ns |
2031+--------------------+-------------------+
2032|Operation Type |POST |
2033+--------------------+-------------------+
2034|Content-Type |application/json |
2035+--------------------+-------------------+
2036
2037Request Parameters:
2038
2039+-------------------+---------+-----------+-------+-----------------------+
2040|Attribute |Qualifier|Cardinality|Content|Description |
2041+===================+=========+===========+=======+=======================+
2042|context |M |1 |Object |Context |
2043+-------------------+---------+-----------+-------+-----------------------+
2044|csarId |M |1 |String |csarId |
2045+-------------------+---------+-----------+-------+-----------------------+
2046|nsName |M |1 |String |Name of the NS |
2047+-------------------+---------+-----------+-------+-----------------------+
2048|description |M |1 |String |description |
2049+-------------------+---------+-----------+-------+-----------------------+
2050
2051Response:
2052
2053+-----------------+---------+-----------+----------------+-------------------+
2054|Attribute |Qualifier|Cardinality|Content |Description |
2055+-----------------+---------+-----------+----------------+-------------------+
2056|nsInstanceId |M |1 |String |nsInstanceId |
2057+-----------------+---------+-----------+----------------+-------------------+
2058
2059Get NS
2060+++++++
2061
2062+--------------------+-------------------+
2063|Interface Definition|Description |
2064+====================+===================+
2065|URI |/ns |
2066+--------------------+-------------------+
2067|Operation Type |GET |
2068+--------------------+-------------------+
2069|Content-Type |application/json |
2070+--------------------+-------------------+
2071
2072Response:
2073
2074+-----------------+---------+-----------+----------------+-------------------+
2075|Attribute |Qualifier|Cardinality|Content |Description |
2076+-----------------+---------+-----------+----------------+-------------------+
2077|nsInstanceId |M |1 |String |nsInstanceId |
2078+-----------------+---------+-----------+----------------+-------------------+
2079|nsName |M |1 |String |The name of ns |
2080+-----------------+---------+-----------+----------------+-------------------+
2081|description |M |1 |String |description |
2082+-----------------+---------+-----------+----------------+-------------------+
2083|nsdId |M |1 |String |ID of ns |
2084+-----------------+---------+-----------+----------------+-------------------+
2085|vnfInfo |M |1 |Array |Vnf information |
2086+-----------------+---------+-----------+----------------+-------------------+
2087|vlInfo |M |1 |Array |vl information |
2088+-----------------+---------+-----------+----------------+-------------------+
2089|vnffgInfo |M |1 |Array |vnffg information |
2090+-----------------+---------+-----------+----------------+-------------------+
2091|nsState |M |1 |String |state of ns |
2092+-----------------+---------+-----------+----------------+-------------------+
2093
2094vnfInfo Object:
2095
2096+-----------------+---------+-----------+----------------+-------------------+
2097|Attribute |Qualifier|Cardinality|Content |Description |
2098+-----------------+---------+-----------+----------------+-------------------+
2099|vnfInstanceId |M |1 |String |vnfInstanceId |
2100+-----------------+---------+-----------+----------------+-------------------+
2101|vnfInstanceName |M |1 |String |vnfInstanceName |
2102+-----------------+---------+-----------+----------------+-------------------+
2103|vnfdId |M |1 |String |vnfdId |
2104+-----------------+---------+-----------+----------------+-------------------+
2105
2106vlInfo Object:
2107
2108+----------------------+---------+-----------+----------------+-------------------+
2109|Attribute |Qualifier|Cardinality|Content |Description |
2110+----------------------+---------+-----------+----------------+-------------------+
2111|vlInstanceId |M |1 |String |vlInstanceId |
2112+----------------------+---------+-----------+----------------+-------------------+
2113|vlInstanceName |M |1 |String |vlInstanceName |
2114+----------------------+---------+-----------+----------------+-------------------+
2115|vldId |M |1 |String |vldId |
2116+----------------------+---------+-----------+----------------+-------------------+
2117|relatedCpInstanceId |M |1 |Array |relatedCpInstanceId|
2118+----------------------+---------+-----------+----------------+-------------------+
2119
2120relatedCpInstanceId Array:
2121
2122+----------------------+---------+-----------+----------------+-------------------+
2123|Attribute |Qualifier|Cardinality|Content |Description |
2124+----------------------+---------+-----------+----------------+-------------------+
2125|cpInstanceId |M |1 |String |cpInstanceId |
2126+----------------------+---------+-----------+----------------+-------------------+
2127|cpInstanceName |M |1 |String |cpInstanceName |
2128+----------------------+---------+-----------+----------------+-------------------+
2129|cpdId |M |1 |String |cpdId |
2130+----------------------+---------+-----------+----------------+-------------------+
2131
2132vnffgInfo Array:
2133
2134+----------------------+---------+-----------+----------------+-------------------+
2135|Attribute |Qualifier|Cardinality|Content |Description |
2136+----------------------+---------+-----------+----------------+-------------------+
2137|vnffgInstanceId |M |1 |String |vnffgInstanceId |
2138+----------------------+---------+-----------+----------------+-------------------+
2139|vnfId |M |1 |String |vnfId |
2140+----------------------+---------+-----------+----------------+-------------------+
2141|pnfId |M |1 |String |pnfId |
2142+----------------------+---------+-----------+----------------+-------------------+
2143|virtualLinkId |M |1 |Array |virtualLinkId |
2144+----------------------+---------+-----------+----------------+-------------------+
2145|cpId |M |1 |Array |cpId |
2146+----------------------+---------+-----------+----------------+-------------------+
2147|nfp |M |1 |Array |nfp |
2148+----------------------+---------+-----------+----------------+-------------------+
2149
2150Instantiate NS
2151+++++++++++++++
2152
2153+--------------------+-------------------------------------+
2154|Interface Definition|Description |
2155+====================+=====================================+
2156|URI |/ns/{nsInstanceId}/Instantiate |
2157+--------------------+-------------------------------------+
2158|Operation Type |POST |
2159+--------------------+-------------------------------------+
2160|Content-Type |application/json |
2161+--------------------+-------------------------------------+
2162
2163Request Parameters:
2164
2165+----------------------+---------+-----------+-------+-----------------------+
2166|Attribute |Qualifier|Cardinality|Content|Description |
2167+======================+=========+===========+=======+=======================+
2168|LocationConstraints |M |1 |Array |LocationConstraints |
2169+----------------------+---------+-----------+-------+-----------------------+
2170|additionalParamForNs |M |1 |String |additionalParamForNs |
2171+----------------------+---------+-----------+-------+-----------------------+
2172|nsInstanceId |M |1 |String |nsInstanceId |
2173+----------------------+---------+-----------+-------+-----------------------+
2174
2175LocationConstraints Array:
2176
2177+----------------------+---------+-----------+-------+-----------------------+
2178|Attribute |Qualifier|Cardinality|Content|Description |
2179+======================+=========+===========+=======+=======================+
2180|vnfProfileId |M |1 |String |vnfProfileId |
2181+----------------------+---------+-----------+-------+-----------------------+
2182|vimid |M |1 |String |vimid |
2183+----------------------+---------+-----------+-------+-----------------------+
2184
2185Response:
2186
2187+--------------+---------+-----------+-------+-----------------------+
2188|Attribute |Qualifier|Cardinality|Content|Description |
2189+==============+=========+===========+=======+=======================+
2190|jobId |M |1 |String |jobId |
2191+--------------+---------+-----------+-------+-----------------------+
2192
2193Terminate NS
2194+++++++++++++++
2195
2196+--------------------+-------------------------------------+
2197|Interface Definition|Description |
2198+====================+=====================================+
2199|URI |/ns/{ns_instance_id}/terminate |
2200+--------------------+-------------------------------------+
2201|Operation Type |POST |
2202+--------------------+-------------------------------------+
2203|Content-Type |application/json |
2204+--------------------+-------------------------------------+
2205
2206Request Parameters:
2207
2208+----------------------------+---------+-----------+-------+-----------------------------+
2209|Attribute |Qualifier|Cardinality|Content|Description |
2210+============================+=========+===========+=======+=============================+
2211|terminationType |M |1 |String |terminationType |
2212+----------------------------+---------+-----------+-------+-----------------------------+
2213|gracefulTerminationTimeout |M |1 |String |gracefulTerminationTimeout |
2214+----------------------------+---------+-----------+-------+-----------------------------+
2215|nsInstanceId |M |1 |String |nsInstanceId |
2216+----------------------------+---------+-----------+-------+-----------------------------+
2217
2218Response:
2219
2220+--------------+---------+-----------+-------+-----------------------+
2221|Attribute |Qualifier|Cardinality|Content|Description |
2222+==============+=========+===========+=======+=======================+
2223|jobId |M |1 |String |jobId |
2224+--------------+---------+-----------+-------+-----------------------+
2225
2226Delete NS
2227+++++++++++++++
2228
2229+--------------------+-------------------------------------+
2230|Interface Definition|Description |
2231+====================+=====================================+
2232|URI |/ns/{ns_instance_id} |
2233+--------------------+-------------------------------------+
2234|Operation Type |DELETE |
2235+--------------------+-------------------------------------+
2236
2237Request Parameters:
2238
2239+----------------------------+---------+-----------+-------+-----------------------------+
2240|Attribute |Qualifier|Cardinality|Content|Description |
2241+============================+=========+===========+=======+=============================+
2242|nsInstanceId |M |1 |String |nsInstanceId |
2243+----------------------------+---------+-----------+-------+-----------------------------+
2244
2245MultiVIM API
2246----------------
2247Get token
2248++++++++++
2249
2250https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
2251
2252+--------------------+-----------------------------------------------------------------------------------------------+
2253|Interface Definition|Description |
2254+====================+===============================================================================================+
2255|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens |
2256+--------------------+-----------------------------------------------------------------------------------------------+
2257|Operation Type |POST |
2258+--------------------+-----------------------------------------------------------------------------------------------+
2259|Content-Type |application/json |
2260+--------------------+-----------------------------------------------------------------------------------------------+
2261
2262Request Body:
2263
2264+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2265|Attribute |Qualifier|Cardinality|Content |Description |
2266+================+=========+===========+==========================+================================================================================================================================================+
2267|nocatalog |O |1 |string |The authentication response excludes the service catalog. By default, the response includes the service catalog. |
2268+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2269|name |O |1 |string |The user name. Required if you do not specify the ID of the user. If you specify the user name, you must also specify the domain, by ID or name.|
2270+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2271|auth |M |1 |object |An auth object. |
2272+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2273|user |M |1 |object |A user object. |
2274+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2275|scope |O |1 |string |The authorization scope, including either a project or a domain |
2276+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2277|password |M |1 |object |The password object, contains the authentication information. |
2278+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2279|id |O |1 |string |The ID of the user. Required if you do not specify the user name. |
2280+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2281|identity |M |1 |object |An identity object. |
2282+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2283|methods |M |1 |array |The authentication method. For password authentication, specify password. |
2284+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2285
2286Response:
2287
2288+-------------------------+------------------+--------------------------------------------------------------------------+
2289|Attribute |Content |Description |
2290+=========================+==================+==========================================================================+
2291|X-Subject-Token |String |The authentication token. |
2292+-------------------------+------------------+--------------------------------------------------------------------------+
2293|domain |object |A domain object, containing: |
2294+-------------------------+------------------+--------------------------------------------------------------------------+
2295|region_id |String |The ID of the region that contains the service endpoint. |
2296+-------------------------+------------------+--------------------------------------------------------------------------+
2297|methods |array |The authentication method. For password authentication, specify password. |
2298+-------------------------+------------------+--------------------------------------------------------------------------+
2299|roles |array |A list of role objects, each containing: |
2300+-------------------------+------------------+--------------------------------------------------------------------------+
2301|url |String |The endpoint URL. |
2302+-------------------------+------------------+--------------------------------------------------------------------------+
2303|region |String |The geographic location of the service endpoint. |
2304+-------------------------+------------------+--------------------------------------------------------------------------+
2305|token |object |A token object. |
2306+-------------------------+------------------+--------------------------------------------------------------------------+
2307|expires_at |String |The date and time when the token expires. |
2308+-------------------------+------------------+--------------------------------------------------------------------------+
2309|project |object |A project object, containing: |
2310+-------------------------+------------------+--------------------------------------------------------------------------+
2311|issued_at |String |The date and time when the token was issued. |
2312+-------------------------+------------------+--------------------------------------------------------------------------+
2313|catalog |array |A catalog object. |
2314+-------------------------+------------------+--------------------------------------------------------------------------+
2315|extras |object |A set of metadata key and value pairs, if any. |
2316+-------------------------+------------------+--------------------------------------------------------------------------+
2317|user |object |A user object. |
2318+-------------------------+------------------+--------------------------------------------------------------------------+
2319|audit_ids |array |A list of one or two audit IDs. |
2320+-------------------------+------------------+--------------------------------------------------------------------------+
2321|interface |String |The interface type, which describes the visibility of the endpoint. |
2322+-------------------------+------------------+--------------------------------------------------------------------------+
2323|endpoints |array |A list of endpoint objects. |
2324+-------------------------+------------------+--------------------------------------------------------------------------+
2325|type |String |The endpoint type. |
2326+-------------------------+------------------+--------------------------------------------------------------------------+
2327|id |String |The ID of the user. Required if you do not specify the user name. |
2328+-------------------------+------------------+--------------------------------------------------------------------------+
2329|name |String |The user name. |
2330+-------------------------+------------------+--------------------------------------------------------------------------+
2331
2332Create stack
2333+++++++++++++
2334
2335https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
2336
2337+--------------------+-----------------------------------------------------------------------------------------------+
2338|Interface Definition|Description |
2339+====================+===============================================================================================+
2340|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks |
2341+--------------------+-----------------------------------------------------------------------------------------------+
2342|Operation Type |POST |
2343+--------------------+-----------------------------------------------------------------------------------------------+
2344|Content-Type |application/json |
2345+--------------------+-----------------------------------------------------------------------------------------------+
2346
2347Request Body:
2348
2349+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2350|Attribute |Qualifier|Cardinality|Content |Description |
2351+==================+=========+===========+==========================+=================================================================================================+
2352|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2353+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2354|disable_rollback |O |1 |boolean |Enables or disables deletion of all stack resources when stack creation fails. |
2355+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2356|environment |O |1 |object |A JSON environment for the stack. |
2357+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2358|files |O |1 |object |Supplies the contents of files referenced in the template or the environment. |
2359+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2360|parameters |O |1 |object |Supplies arguments for parameters defined in the stack template. |
2361+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2362|stack_name |M |1 |string |A name for the stack. |
2363+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2364|tags |O |1 |string |One or more simple string tags to associate with the stack. |
2365+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2366|template |O |1 |object |The stack template on which to perform the operation. |
2367+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2368|template_url |O |1 |string |A URI to the location containing the stack template on which to perform the operation. |
2369+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2370|timeout_mins |O |1 |integer |The timeout for stack creation in minutes. |
2371+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2372
2373Response:
2374
2375+-------------------------+------------------+--------------------------------------------------------------------------+
2376|Attribute |Content |Description |
2377+=========================+==================+==========================================================================+
2378|location |String |For asynchronous resource operations. |
2379+-------------------------+------------------+--------------------------------------------------------------------------+
2380|X-Openstack-Reqeuest-Id |object |A domain object, containing: |
2381+-------------------------+------------------+--------------------------------------------------------------------------+
2382|stack |String |The ID of the region that contains the service endpoint. |
2383+-------------------------+------------------+--------------------------------------------------------------------------+
2384|id |String |The authentication method. For password authentication, specify password. |
2385+-------------------------+------------------+--------------------------------------------------------------------------+
2386|links |String |The authentication method. For password authentication, specify password. |
2387+-------------------------+------------------+--------------------------------------------------------------------------+
2388
2389Get stack
2390+++++++++++++
2391
2392https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2393
2394+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2395|Interface Definition|Description |
2396+====================+=======================================================================================================================+
2397|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2398+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2399|Operation Type |GET |
2400+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2401|Content-Type |application/json |
2402+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2403
2404Request Body:
2405
2406+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2407|Attribute |Qualifier|Cardinality|Content |Description |
2408+==================+=========+===========+==========================+=================================================================================================+
2409|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2410+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2411|stack_name |M |1 |string |The name of a stack. |
2412+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2413|stack_id |M |1 |string |The UUID of the stack. |
2414+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2415|resolve_outputs |O |1 |boolean |A boolean indicating whether the outputs section of a stack should be resolved. |
2416+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2417
2418Response:
2419
2420+-------------------------+------------------+------------------------------------------------------------------------------+
2421|Attribute |Content |Description |
2422+=========================+==================+==============================================================================+
2423|X-Openstack-Reqeuest-Id |String |A unique ID for tracking service request. |
2424+-------------------------+------------------+------------------------------------------------------------------------------+
2425|stack |Object |The stack object. |
2426+-------------------------+------------------+------------------------------------------------------------------------------+
2427|capabilities |array |List of stack capabilities for stack. |
2428+-------------------------+------------------+------------------------------------------------------------------------------+
2429|creation_time |String |The date and time when the resource was created. |
2430+-------------------------+------------------+------------------------------------------------------------------------------+
2431|deletion_time |String |The date and time when the resource was (soft-) deleted. |
2432+-------------------------+------------------+------------------------------------------------------------------------------+
2433|description |String |The description of the stack resource. |
2434+-------------------------+------------------+------------------------------------------------------------------------------+
2435|disable_rollback |boolean |Whether deletion of all stack resources when stack creation fails is enabled. |
2436+-------------------------+------------------+------------------------------------------------------------------------------+
2437|id |String |The UUID of the stack. |
2438+-------------------------+------------------+------------------------------------------------------------------------------+
2439|links |array |A list of URLs for the stack. |
2440+-------------------------+------------------+------------------------------------------------------------------------------+
2441|notification_topics |array |List of notification topics for stack. |
2442+-------------------------+------------------+------------------------------------------------------------------------------+
2443|outputs |array |A list of stack outputs. |
2444+-------------------------+------------------+------------------------------------------------------------------------------+
2445|parameters |object | A group of key-value pairs |
2446+-------------------------+------------------+------------------------------------------------------------------------------+
2447|parent |String |The stack ID of the parent stack, if this is a nested stack. |
2448+-------------------------+------------------+------------------------------------------------------------------------------+
2449|stack_name |String |A name for the stack. |
2450+-------------------------+------------------+------------------------------------------------------------------------------+
2451|stack_owner |String |The owner of the stack. |
2452+-------------------------+------------------+------------------------------------------------------------------------------+
2453|stack_status |String |The status of the stack. |
2454+-------------------------+------------------+------------------------------------------------------------------------------+
2455|stack_status_reason |String |The reason for the current status of the stack. |
2456+-------------------------+------------------+------------------------------------------------------------------------------+
2457|stack_user_project_id |String |The project UUID of the stack user. |
2458+-------------------------+------------------+------------------------------------------------------------------------------+
2459|tags |array |The stack tags. |
2460+-------------------------+------------------+------------------------------------------------------------------------------+
2461|template_description |String |The description of the stack template. |
2462+-------------------------+------------------+------------------------------------------------------------------------------+
2463|timeout_mins |integer |The timeout for stack creation in minutes. |
2464+-------------------------+------------------+------------------------------------------------------------------------------+
2465|updated_time |String |The date and time when the object was updated. |
2466+-------------------------+------------------+------------------------------------------------------------------------------+
2467
2468Delete stack
2469+++++++++++++
2470
2471https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2472
2473+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2474|Interface Definition|Description |
2475+====================+=======================================================================================================================+
2476|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2477+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2478|Operation Type |DELETE |
2479+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2480|Content-Type |application/json |
2481+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2482
2483Request Body:
2484
2485+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2486|Attribute |Qualifier|Cardinality|Content |Description |
2487+==================+=========+===========+==========================+=================================================================================================+
2488|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2489+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2490|stack_name |M |1 |string |The name of a stack. |
2491+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2492|stack_id |M |1 |string |The UUID of the stack. |
2493+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2494
2495Create server
2496+++++++++++++
2497
2498https://developer.openstack.org/api-ref/compute/#create-server
2499
2500+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2501|Interface Definition|Description |
2502+====================+=======================================================================================================================+
2503|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers |
2504+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2505|Operation Type |POST |
2506+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2507|Content-Type |application/json |
2508+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2509
2510Request Body:
2511
2512+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2513|Attribute |Qualifier|Cardinality|Content |Description |
2514+================================================+=========+===========+==========================+=================================================================================================+
2515|server |M |1 |object |A server object. |
2516+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2517|name |M |1 |string |The server name. |
2518+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2519|flavorRef |M |1 |string |The flavor reference, as an ID (including a UUID) or full URL |
2520+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2521|imageRef |M |1 |string |The UUID of the image to use for your server instance |
2522+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2523|security_groups |O |1 |array |One or more security groups. |
2524+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2525|metadata |O |1 |object |Metadata key and value pairs. |
2526+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2527|accessIPv4 |O |1 |string |IPv4 address that should be used to access this server. |
2528+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2529|accessIPv6 |O |1 |string |IPv6 address that should be used to access this server. |
2530+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2531|adminPass |O |1 |string |The administrative password of the server. |
2532+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2533|user_data |O |1 |string |Configuration information or scripts to use upon launch. |
2534+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2535|availability_zone |O |1 |string |The availability zone from which to launch the server. |
2536+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2537|networks |M |1 |object |A networks object. |
2538+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2539|networks.uuid |O |1 |string |To provision the server instance with a NIC for a network |
2540+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2541|networks.port |O |1 |string |To provision the server instance with a NIC for an already existing port |
2542+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2543|networks.fixed_ip |O |1 |string |A fixed IPv4 address for the NIC |
2544+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2545|networks.tag |O |1 |string |A device role tag that can be applied to a network interface. |
2546+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2547|personality |O |1 |array |The file path and contents, text only, to inject into the server at launch. |
2548+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2549|block_device_mapping_v2 |O |1 |array |Enables fine grained control of the block device mapping for an instance. |
2550+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2551|block_device_mapping_v2.device_name |M |1 |string |A path to the device for the volume that you want to use to boot the server. |
2552+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2553|block_device_mapping_v2.source_type |M |1 |string |The source type of the volume. |
2554+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2555|block_device_mapping_v2.destination_type |O |1 |string |Defines where the volume comes from. |
2556+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2557|block_device_mapping_v2.delete_on_termination |O |1 |string |To delete the boot volume when the server is destroyed, specify true. |
2558+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2559|block_device_mapping_v2.guest_format |M |1 |string |Specifies the guest server disk file system format, such as ephemeral or swap. |
2560+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2561|block_device_mapping_v2.boot_index |M |1 |string |Defines the order in which a hypervisor tries devices |
2562+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2563|block_device_mapping_v2.uuid |O |1 |string |This is the uuid of source resource. |
2564+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2565|block_device_mapping_v2.tag |O |1 |string |A device role tag that can be applied to a block device. |
2566+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2567|block_device_mapping_v2.disk_bus |O |1 |string |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter |
2568+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2569|config_drive |O |1 |boolean |Indicates whether a configuration drive enables metadata injection. |
2570+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2571|key_name |O |1 |string |Key pair name. |
2572+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2573|os:scheduler_hints |O |1 |object |The dictionary of data to send to the scheduler. |
2574+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2575|OS-DCF:diskConfig |O |1 |string |Controls how the API partitions the disk when you create, rebuild, or resize servers. |
2576+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2577|description |O |1 |string |A free form description of the server. |
2578+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2579|tags |O |1 |array |A list of tags. |
2580+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2581
2582Response:
2583
2584+-------------------------+------------------+------------------------------------------------------------------------------+
2585|Attribute |Content |Description |
2586+=========================+==================+==============================================================================+
2587|server |object |A server object. |
2588+-------------------------+------------------+------------------------------------------------------------------------------+
2589|id |String |The UUID of the server. |
2590+-------------------------+------------------+------------------------------------------------------------------------------+
2591|links |array |Links to the resources in question. |
2592+-------------------------+------------------+------------------------------------------------------------------------------+
2593|OS-DCF:diskConfig |String |Disk configuration. |
2594+-------------------------+------------------+------------------------------------------------------------------------------+
2595|security_groups |array |One or more security groups objects. |
2596+-------------------------+------------------+------------------------------------------------------------------------------+
2597|security_groups.name |String |The security group name. |
2598+-------------------------+------------------+------------------------------------------------------------------------------+
2599|adminPass |String |The administrative password for the server. |
2600+-------------------------+------------------+------------------------------------------------------------------------------+
2601
2602Delete server
2603+++++++++++++
2604
2605https://developer.openstack.org/api-ref/compute/#delete-server
2606
2607+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2608|Interface Definition|Description |
2609+====================+=======================================================================================================================+
2610|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id} |
2611+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2612|Operation Type |DELETE |
2613+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2614|Content-Type |application/json |
2615+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2616
2617Request Body:
2618
2619+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2620|Attribute |Qualifier|Cardinality|Content |Description |
2621+==================+=========+===========+==========================+=================================================================================================+
2622|server_id |M |1 |string |The UUID of the server. |
2623+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2624
2625Create Keypair
2626+++++++++++++++
2627
2628https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
2629
2630+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2631|Interface Definition|Description |
2632+====================+=======================================================================================================================+
2633|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs |
2634+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2635|Operation Type |POST |
2636+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2637|Content-Type |application/json |
2638+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2639
2640Request Body:
2641
2642+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2643|Attribute |Qualifier|Cardinality|Content |Description |
2644+==================+=========+===========+==========================+=================================================================================================+
2645|keypair |M |1 |Object |Keypair object |
2646+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2647|name |M |1 |string |A name for the keypair which will be used to reference it later. |
2648+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2649|public_key |O |1 |string |The public ssh key to import. If you omit this value, a keypair is generated for you. |
2650+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2651|type |O |1 |string |The type of the keypair. |
2652+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2653|user_id |O |1 |string |The user_id for a keypair. |
2654+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2655
2656Response:
2657
2658+-----------------+------------------+------------------------------------------------------------------------------+
2659|Attribute |Content |Description |
2660+=================+==================+==============================================================================+
2661|keypair |object |Keypair object |
2662+-----------------+------------------+------------------------------------------------------------------------------+
2663|name |String |A name for the keypair which will be used to reference it later. |
2664+-----------------+------------------+------------------------------------------------------------------------------+
2665|public_key |String |The keypair public key. |
2666+-----------------+------------------+------------------------------------------------------------------------------+
2667|fingerprint |String |The fingerprint for the keypair. |
2668+-----------------+------------------+------------------------------------------------------------------------------+
2669|user_id |String |The user_id for a keypair. |
2670+-----------------+------------------+------------------------------------------------------------------------------+
2671|private_key |String |If you do not provide a public key on create |
2672+-----------------+------------------+------------------------------------------------------------------------------+
2673|type |String |The type of the keypair. |
2674+-----------------+------------------+------------------------------------------------------------------------------+
2675
2676Delete Keypair
2677+++++++++++++++
2678
2679https://developer.openstack.org/api-ref/compute/#delete-keypair
2680
2681+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2682|Interface Definition|Description |
2683+====================+=======================================================================================================================+
2684|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id} |
2685+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2686|Operation Type |DELETE |
2687+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2688|Content-Type |application/json |
2689+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2690
2691Request Body:
2692
2693+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2694|Attribute |Qualifier|Cardinality|Content |Description |
2695+==================+=========+===========+==========================+=================================================================================================+
2696|keypair_name |M |1 |String |The keypair name. |
2697+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2698|user_id |O |1 |String |This allows administrative users to operate key-pairs of specified user ID. |
2699+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2700
2701Create Network
2702+++++++++++++++
2703
2704https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
2705
2706+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2707|Interface Definition|Description |
2708+====================+=======================================================================================================================+
2709|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks |
2710+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2711|Operation Type |POST |
2712+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2713|Content-Type |application/json |
2714+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2715
2716Request Body:
2717
2718+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2719|Attribute |Qualifier|Cardinality|Content |Description |
2720+============================+=========+===========+==========================+=================================================================================================+
2721|network |M |1 |Object |A network object. |
2722+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2723|admin_state_up |O |1 |boolean |The administrative state of the network, which is up (true) or down (false). |
2724+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2725|dns_domain |O |1 |string |A valid DNS domain. |
2726+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2727|mtu |O |1 |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2728+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2729|name |O |1 |string |Human-readable name of the network. |
2730+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2731|port_security_enabled |O |1 |boolean |The port security status of the network. |
2732+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2733|project_id |O |1 |string |The ID of the project that owns the resource. |
2734+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2735|provider:network_type |O |1 |string |The type of physical network that this network should be mapped to. |
2736+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2737|provider:physical_network |O |1 |string |The physical network where this network should be implemented. |
2738+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2739|provider:segmentation_id |O |1 |integer |The ID of the isolated segment on the physical network. |
2740+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2741|qos_policy_id |O |1 |string |The ID of the QoS policy. |
2742+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2743|router:external |O |1 |boolean |Indicates whether this network can provide floating IPs via a router. |
2744+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2745|segments |O |1 |array |A list of provider segment objects. |
2746+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2747|shared |O |1 |boolean |Indicates whether this network is shared across all tenants. |
2748+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2749|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2750+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2751|vlan_transparent |O |1 |boolean |Indicates the VLAN transparency mode of the network, |
2752+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2753|description |O |1 |string |A human-readable description for the resource. |
2754+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2755
2756Response:
2757
2758+-----------------------------+------------------+------------------------------------------------------------------------------+
2759|Attribute |Content |Description |
2760+=============================+==================+==============================================================================+
2761|network |object |A network object. |
2762+-----------------------------+------------------+------------------------------------------------------------------------------+
2763|admin_state_up |boolean |The administrative state of the network, which is up (true) or down (false). |
2764+-----------------------------+------------------+------------------------------------------------------------------------------+
2765|availability_zone_hints |array |The availability zone candidate for the network. |
2766+-----------------------------+------------------+------------------------------------------------------------------------------+
2767|availability_zones |array |The availability zone for the network. |
2768+-----------------------------+------------------+------------------------------------------------------------------------------+
2769|dns_domain |String |A valid DNS domain. |
2770+-----------------------------+------------------+------------------------------------------------------------------------------+
2771|id |String |The ID of the network. |
2772+-----------------------------+------------------+------------------------------------------------------------------------------+
2773|mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2774+-----------------------------+------------------+------------------------------------------------------------------------------+
2775|name |String |Human-readable name of the network. |
2776+-----------------------------+------------------+------------------------------------------------------------------------------+
2777|port_security_enabled |boolean |The port security status of the network. |
2778+-----------------------------+------------------+------------------------------------------------------------------------------+
2779|project_id |String |The ID of the project. |
2780+-----------------------------+------------------+------------------------------------------------------------------------------+
2781|provider:network_type |String |The type of physical network that this network is mapped to. |
2782+-----------------------------+------------------+------------------------------------------------------------------------------+
2783|provider:physical_network |String |The physical network where this network is implemented. |
2784+-----------------------------+------------------+------------------------------------------------------------------------------+
2785|provider:segmentation_id |integer |The ID of the isolated segment on the physical network. |
2786+-----------------------------+------------------+------------------------------------------------------------------------------+
2787|qos_policy_id |String |The ID of the QoS policy. |
2788+-----------------------------+------------------+------------------------------------------------------------------------------+
2789|revision_number |integer |The revision number of the resource. |
2790+-----------------------------+------------------+------------------------------------------------------------------------------+
2791|router:external |boolean |Indicates whether this network can provide floating IPs via a router. |
2792+-----------------------------+------------------+------------------------------------------------------------------------------+
2793|segments |array |A list of provider segment objects. |
2794+-----------------------------+------------------+------------------------------------------------------------------------------+
2795|shared |boolean |Indicates whether this network is shared across all tenants. |
2796+-----------------------------+------------------+------------------------------------------------------------------------------+
2797|status |String |The network status. Values are ACTIVE, DOWN, BUILD or ERROR. |
2798+-----------------------------+------------------+------------------------------------------------------------------------------+
2799|subnets |array |The associated subnets. |
2800+-----------------------------+------------------+------------------------------------------------------------------------------+
2801|tenant_id |String |The ID of the project. |
2802+-----------------------------+------------------+------------------------------------------------------------------------------+
2803|vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. |
2804+-----------------------------+------------------+------------------------------------------------------------------------------+
2805|description |String |A human-readable description for the resource. |
2806+-----------------------------+------------------+------------------------------------------------------------------------------+
2807
2808Delete Network
2809+++++++++++++++
2810
2811https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
2812
2813+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2814|Interface Definition|Description |
2815+====================+=======================================================================================================================+
2816|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id} |
2817+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2818|Operation Type |DELETE |
2819+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2820|Content-Type |application/json |
2821+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2822
2823Request Body:
2824
2825+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2826|Attribute |Qualifier|Cardinality|Content |Description |
2827+============================+=========+===========+==========================+==============================================================+
2828|network_id |M |1 |Object |The ID of the network. |
2829+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2830
2831Create Subnet
2832+++++++++++++++
2833
2834https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
2835
2836+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2837|Interface Definition|Description |
2838+====================+=======================================================================================================================+
2839|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets |
2840+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2841|Operation Type |POST |
2842+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2843|Content-Type |application/json |
2844+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2845
2846Request Body:
2847
2848+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2849|Attribute |Qualifier|Cardinality|Content |Description |
2850+============================+=========+===========+==========================+=================================================================================================+
2851|subnet |M |1 |string |A subnet object. |
2852+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2853|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2854+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2855|project_id |O |1 |string |The ID of the project that owns the resource. |
2856+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2857|name |O |1 |string |Human-readable name of the resource. |
2858+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2859|enable_dhcp |O |1 |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2860+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2861|network_id |M |1 |string |The ID of the network to which the subnet belongs. |
2862+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2863|dns_nameservers |O |1 |array |List of dns name servers associated with the subnet. |
2864+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2865|allocation_pools |O |1 |array |Allocation pools with start and end IP addresses for this subnet. |
2866+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2867|host_routes |O |1 |array |Additional routes for the subnet. |
2868+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2869|ip_version |M |1 |integer |The IP protocol version. Value is 4 or 6. |
2870+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2871|gateway_ip |O |1 |string |Gateway IP of this subnet. |
2872+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2873|cidr |M |1 |string |The CIDR of the subnet. |
2874+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2875|description |O |1 |string |A human-readable description for the resource. |
2876+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2877|ipv6_address_mode |O |1 |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2878+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2879|ipv6_ra_mode |O |1 |string |The IPv6 router advertisement specifies whether the networking service |
2880+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2881|segment_id |O |1 |string |The ID of a network segment the subnet is associated with. |
2882+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2883|subnetpool_id |O |1 |string |The ID of the subnet pool associated with the subnet. |
2884+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2885|use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. |
2886+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2887
2888Response:
2889
2890+-----------------------------+------------------+------------------------------------------------------------------------------+
2891|Attribute |Content |Description |
2892+=============================+==================+==============================================================================+
2893|subnet |string |A subnet object. |
2894+-----------------------------+------------------+------------------------------------------------------------------------------+
2895|id |string |The ID of the subnet. |
2896+-----------------------------+------------------+------------------------------------------------------------------------------+
2897|tenant_id |string |The ID of the project. |
2898+-----------------------------+------------------+------------------------------------------------------------------------------+
2899|project_id |string |The ID of the project. |
2900+-----------------------------+------------------+------------------------------------------------------------------------------+
2901|name |String |Human-readable name of the resource. |
2902+-----------------------------+------------------+------------------------------------------------------------------------------+
2903|enable_dhcp |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2904+-----------------------------+------------------+------------------------------------------------------------------------------+
2905|network_id |String |The ID of the network to which the subnet belongs. |
2906+-----------------------------+------------------+------------------------------------------------------------------------------+
2907|dns_nameservers |array |List of dns name servers associated with the subnet. |
2908+-----------------------------+------------------+------------------------------------------------------------------------------+
2909|allocation_pools |array |Allocation pools with start and end IP addresses for this subnet. |
2910+-----------------------------+------------------+------------------------------------------------------------------------------+
2911|host_routes |array |Additional routes for the subnet. |
2912+-----------------------------+------------------+------------------------------------------------------------------------------+
2913|ip_version |integer |The IP protocol version. Value is 4 or 6. |
2914+-----------------------------+------------------+------------------------------------------------------------------------------+
2915|gateway_ip |string |Gateway IP of this subnet. |
2916+-----------------------------+------------------+------------------------------------------------------------------------------+
2917|cidr |string |The CIDR of the subnet. |
2918+-----------------------------+------------------+------------------------------------------------------------------------------+
2919|created_at |string |Time at which the subnet has been created. |
2920+-----------------------------+------------------+------------------------------------------------------------------------------+
2921|description |string |A human-readable description for the resource. |
2922+-----------------------------+------------------+------------------------------------------------------------------------------+
2923|ipv6_address_mode |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2924+-----------------------------+------------------+------------------------------------------------------------------------------+
2925|ipv6_ra_mode |string |The IPv6 router advertisement specifies whether the networking service |
2926+-----------------------------+------------------+------------------------------------------------------------------------------+
2927|revision_number |integer |The revision number of the resource. |
2928+-----------------------------+------------------+------------------------------------------------------------------------------+
2929|service_types |string |The service types associated with the subnet. |
2930+-----------------------------+------------------+------------------------------------------------------------------------------+
2931|subnetpool_id |string |The ID of the subnet pool associated with the subnet. |
2932+-----------------------------+------------------+------------------------------------------------------------------------------+
2933|segment_id |string |The ID of a network segment the subnet is associated with. |
2934+-----------------------------+------------------+------------------------------------------------------------------------------+
2935|updated_at |string |Time at which the subnet has been updated. |
2936+-----------------------------+------------------+------------------------------------------------------------------------------+
2937
2938Delete Subnet
2939+++++++++++++++
2940
2941https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
2942
2943+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2944|Interface Definition|Description |
2945+====================+=======================================================================================================================+
2946|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id} |
2947+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2948|Operation Type |DELETE |
2949+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2950|Content-Type |application/json |
2951+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2952
2953Request Body:
2954
2955+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2956|Attribute |Qualifier|Cardinality|Content |Description |
2957+============================+=========+===========+==========================+==============================================================+
2958|subnet_id |M |1 |String |The ID of the subnet. |
2959+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2960
2961Create Port
2962+++++++++++++++
2963
2964https://developer.openstack.org/api-ref/networking/v2/#create-port
2965
2966+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2967|Interface Definition|Description |
2968+====================+=======================================================================================================================+
2969|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports |
2970+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2971|Operation Type |POST |
2972+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2973|Content-Type |application/json |
2974+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2975
2976Request Body:
2977
2978+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2979|Attribute |Qualifier|Cardinality|Content |Description |
2980+============================+=========+===========+==========================+=================================================================================================+
2981|port |M |1 |object |A port object. |
2982+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2983|admin_state_up |O |1 |boolean |The administrative state of the resource. |
2984+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2985|allowed_address_pairs |O |1 |array |A set of zero or more allowed address pairs. |
2986+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2987|binding:host_id |O |1 |string |The ID of the host where the port resides. |
2988+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2989|binding:profile |O |1 |string |A dictionary that enables the application running on the specific host |
2990+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2991|binding:vnic_type |O |1 |string |The type of vNIC which this port should be attached to. |
2992+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2993|description |O |1 |string |A human-readable description for the resource. |
2994+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2995|device_id |O |1 |string |The ID of the device that uses this port. |
2996+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2997|device_owner |O |1 |string |The entity type that uses this port. |
2998+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2999|dns_domain |O |1 |string |A valid DNS domain. |
3000+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3001|dns_name |O |1 |string |A valid DNS name. |
3002+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3003|extra_dhcp_opts |O |1 |array |A set of zero or more extra DHCP option pairs. |
3004+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3005|fixed_ips |O |1 |array |The IP addresses for the port. |
3006+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3007|mac_address |O |1 |string |The MAC address of the port. |
3008+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3009|name |O |1 |string |Human-readable name of the resource. |
3010+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3011|network_id |M |1 |string |The ID of the attached network. |
3012+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3013|port_security_enabled |O |1 |boolean |The port security status. |
3014+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3015|project_id |O |1 |string |The ID of the project that owns the resource. |
3016+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3017|security_groups |O |1 |array |The IDs of security groups applied to the port. |
3018+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3019|tenant_id |O |1 |string |The ID of the project that owns the resource. |
3020+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3021
3022Response:
3023
3024+-----------------------------+------------------+------------------------------------------------------------------------------+
3025|Attribute |Content |Description |
3026+=============================+==================+==============================================================================+
3027|port |object |A port object. |
3028+-----------------------------+------------------+------------------------------------------------------------------------------+
3029|admin_state_up |boolean |The administrative state of the resource. |
3030+-----------------------------+------------------+------------------------------------------------------------------------------+
3031|allowed_address_pairs |array |A set of zero or more allowed address pairs. |
3032+-----------------------------+------------------+------------------------------------------------------------------------------+
3033|binding:host_id |string |The ID of the host where the port resides. |
3034+-----------------------------+------------------+------------------------------------------------------------------------------+
3035|binding:profile |String |A dictionary that enables the application running on the specific host |
3036+-----------------------------+------------------+------------------------------------------------------------------------------+
3037|binding:vif_details |object |A dictionary which contains additional information on the port. |
3038+-----------------------------+------------------+------------------------------------------------------------------------------+
3039|binding:vif_type |String |The type of which mechanism is used for the port. |
3040+-----------------------------+------------------+------------------------------------------------------------------------------+
3041|binding:vnic_type |string |The type of vNIC which this port should be attached to. |
3042+-----------------------------+------------------+------------------------------------------------------------------------------+
3043|created_at |string |Time at which port has been created. |
3044+-----------------------------+------------------+------------------------------------------------------------------------------+
3045|data_plane_status |string |Status of the underlying data plane of a port. |
3046+-----------------------------+------------------+------------------------------------------------------------------------------+
3047|description |string |A human-readable description for the resource. |
3048+-----------------------------+------------------+------------------------------------------------------------------------------+
3049|device_id |string |The ID of the device that uses this port. |
3050+-----------------------------+------------------+------------------------------------------------------------------------------+
3051|device_owner |string |The entity type that uses this port. |
3052+-----------------------------+------------------+------------------------------------------------------------------------------+
3053|dns_assignment |object |Data assigned to a port by the Networking internal DNS |
3054+-----------------------------+------------------+------------------------------------------------------------------------------+
3055|dns_domain |string |A valid DNS domain. |
3056+-----------------------------+------------------+------------------------------------------------------------------------------+
3057|dns_name |string |A valid DNS name. |
3058+-----------------------------+------------------+------------------------------------------------------------------------------+
3059|extra_dhcp_opts |array |A set of zero or more extra DHCP option pairs. |
3060+-----------------------------+------------------+------------------------------------------------------------------------------+
3061|fixed_ips |array |The IP addresses for the port. |
3062+-----------------------------+------------------+------------------------------------------------------------------------------+
3063|id |string |The ID of the resource. |
3064+-----------------------------+------------------+------------------------------------------------------------------------------+
3065|mac_address |string |The MAC address of the port. |
3066+-----------------------------+------------------+------------------------------------------------------------------------------+
3067|name |string |Human-readable name of the resource. |
3068+-----------------------------+------------------+------------------------------------------------------------------------------+
3069|network_id |string |The ID of the attached network. |
3070+-----------------------------+------------------+------------------------------------------------------------------------------+
3071|port_security_enabled |boolean |The port security status. |
3072+-----------------------------+------------------+------------------------------------------------------------------------------+
3073|project_id |string |The ID of the project. |
3074+-----------------------------+------------------+------------------------------------------------------------------------------+
3075|revision_number |integer |The revision number of the resource. |
3076+-----------------------------+------------------+------------------------------------------------------------------------------+
3077|security_groups |array |The IDs of security groups applied to the port. |
3078+-----------------------------+------------------+------------------------------------------------------------------------------+
3079|status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. |
3080+-----------------------------+------------------+------------------------------------------------------------------------------+
3081|tenant_id |string |The ID of the project. |
3082+-----------------------------+------------------+------------------------------------------------------------------------------+
3083|updated_at |string |Time at which port has been updated. |
3084+-----------------------------+------------------+------------------------------------------------------------------------------+
3085
3086Delete Port
3087+++++++++++++++
3088
3089https://developer.openstack.org/api-ref/network/v2/#delete-port
3090
3091+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3092|Interface Definition|Description |
3093+====================+=======================================================================================================================+
3094|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id} |
3095+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3096|Operation Type |DELETE |
3097+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3098|Content-Type |application/json |
3099+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3100
3101Request Body:
3102
3103+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3104|Attribute |Qualifier|Cardinality|Content |Description |
3105+============================+=========+===========+==========================+==============================================================+
3106|port_id |M |1 |String |The ID of the port. |
3107+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3108
3109Create Security Group
3110++++++++++++++++++++++
3111
3112https://developer.openstack.org/api-ref/network/v2/#create-security-group
3113
3114+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3115|Interface Definition|Description |
3116+====================+=======================================================================================================================+
3117|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups |
3118+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3119|Operation Type |POST |
3120+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3121|Content-Type |application/json |
3122+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3123
3124Request Body:
3125
3126+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3127|Attribute |Qualifier|Cardinality|Content |Description |
3128+============================+=========+===========+==========================+==============================================================+
3129|security_group |M |1 |object |A security_group object. |
3130+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3131|tenant_id |M |1 |string |The ID of the project. |
3132+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3133|project_id |M |1 |string |The ID of the project. |
3134+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3135|description |O |1 |string |A human-readable description for the resource. |
3136+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3137|name |M |1 |string |Human-readable name of the resource. |
3138+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3139
3140Response:
3141
3142+-----------------------------+------------------+------------------------------------------------------------------------------+
3143|Attribute |Content |Description |
3144+=============================+==================+==============================================================================+
3145|security_group |object |A security_group object. |
3146+-----------------------------+------------------+------------------------------------------------------------------------------+
3147|id |string |The ID of the security group. |
3148+-----------------------------+------------------+------------------------------------------------------------------------------+
3149|tenant_id |string |The ID of the project. |
3150+-----------------------------+------------------+------------------------------------------------------------------------------+
3151|project_id |string |The ID of the project. |
3152+-----------------------------+------------------+------------------------------------------------------------------------------+
3153|revision_number |integer |The revision number of the resource. |
3154+-----------------------------+------------------+------------------------------------------------------------------------------+
3155|name |string |Human-readable name of the resource. |
3156+-----------------------------+------------------+------------------------------------------------------------------------------+
3157|description |string |A human-readable description for the resource. |
3158+-----------------------------+------------------+------------------------------------------------------------------------------+
3159|security_group_rules |array |A list of security_group_rule objects. |
3160+-----------------------------+------------------+------------------------------------------------------------------------------+
3161
3162Delete security group
3163++++++++++++++++++++++
3164
3165https://developer.openstack.org/api-ref/network/v2/#delete-security-group
3166
3167+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3168|Interface Definition|Description |
3169+====================+=======================================================================================================================+
3170|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id} |
3171+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3172|Operation Type |DELETE |
3173+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3174|Content-Type |application/json |
3175+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3176
3177Request Body:
3178
3179+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3180|Attribute |Qualifier|Cardinality|Content |Description |
3181+============================+=========+===========+==========================+==============================================================+
3182|security_group_id |M |1 |String |The ID of the security group. |
3183+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3184
3185Create Security Group Rule
3186++++++++++++++++++++++++++
3187
3188https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
3189
3190+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3191|Interface Definition|Description |
3192+====================+=======================================================================================================================+
3193|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules |
3194+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3195|Operation Type |POST |
3196+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3197|Content-Type |application/json |
3198+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3199
3200Request Body:
3201
3202+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3203|Attribute |Qualifier|Cardinality|Content |Description |
3204+============================+=========+===========+==========================+================================================================================================+
3205|security_group_rule |M |1 |object |A security_group_rule object. |
3206+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3207|remote_group_id |O |1 |string |The remote group UUID to associate with this security group rule. |
3208+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3209|direction |M |1 |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3210+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3211|protocol |M |1 |string |The IP protocol can be represented by a string, an integer, or null. |
3212+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3213|ethertype |O |1 |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3214+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3215|port_range_max |O |1 |integer |The maximum port number in the range that is matched by the security group rule. |
3216+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3217|security_group_id |M |1 |string |The security group ID to associate with this security group rule. |
3218+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3219|port_range_min |O |1 |integer |The minimum port number in the range that is matched by the security group rule. |
3220+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3221|remote_ip_prefix |M |1 |string |The remote IP prefix to associate with this metering rule packet. |
3222+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3223|description |O |1 |string |A human-readable description for the resource. Default is an empty string. |
3224+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3225
3226Response:
3227
3228+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3229|Attribute |Content |Description |
3230+=============================+==================+=================================================================================================+
3231|security_group_rule |object |A security_group_rule object. |
3232+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3233|remote_group_id |string |The remote group UUID to associate with this security group rule. |
3234+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3235|direction |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3236+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3237|protocol |string |The IP protocol can be represented by a string, an integer, or null. |
3238+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3239|ethertype |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3240+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3241|port_range_max |integer |The maximum port number in the range that is matched by the security group rule. |
3242+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3243|security_group_id |string |The security group ID to associate with this security group rule. |
3244+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3245|tenant_id |string |The ID of the project. |
3246+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3247|project_id |string |The ID of the project. |
3248+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3249|port_range_min |integer |The minimum port number in the range that is matched by the security group rule. |
3250+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3251|remote_ip_prefix |string |The remote IP prefix to associate with this metering rule packet. |
3252+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3253|revision_number |integer |The revision number of the resource. |
3254+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3255|id |string |The ID of the security group rule. |
3256+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3257|description |string |A human-readable description for the resource. |
3258+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3259
3260Delete security group
3261++++++++++++++++++++++
3262
3263https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
3264
3265+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3266|Interface Definition|Description |
3267+====================+=================================================================================================================================+
3268|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id} |
3269+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3270|Operation Type |DELETE |
3271+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3272|Content-Type |application/json |
3273+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3274
3275Request Body:
3276
3277+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3278|Attribute |Qualifier|Cardinality|Content |Description |
3279+============================+=========+===========+==========================+==============================================================+
3280|security_group_rule_id |M |1 |String |The ID of the security group rule. |
3281+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3282
3283Policy API
3284----------
3285
3286Create a dictionary item
3287++++++++++++++++++++++++
3288
3289+--------------------+--------------------------+
3290|Interface Definition|Description |
3291+====================+==========================+
3292|URI |/createDictionaryItem |
3293+--------------------+--------------------------+
3294|Operation Type |PUT |
3295+--------------------+--------------------------+
3296
3297Request Parameters:
3298
3299+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3300|Attribute |Qualifier|Cardinality|Content|Description |
3301+===================+=========+===========+=======+=============================================================+
3302|dictionory |M |1 |String | |
3303+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3304|dictionaryJson |M |1 |String | |
3305+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3306|dictionaryType |M |1 |String | |
3307+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3308|requestId |M |1 |String | |
3309+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3310
3311Request Headers:
3312
3313+-------------------+---------+-----------------------------------------------------------------------------------------+
3314|Header Name |Qualifier|Description |
3315+===================+=========+=========================================================================================+
3316|ClientAuth |Y |encoded client authentication details |
3317+-------------------+---------+-----------------------------------------------------------------------------------------+
3318|X-ECOMP-RequestID |N |Request ID to track the requests |
3319+-------------------+---------+-----------------------------------------------------------------------------------------+
3320|Environment |Y |execution environments |
3321+-------------------+---------+-----------------------------------------------------------------------------------------+
3322|Authorization |Y |Base64 encoded username:password |
3323+-------------------+---------+-----------------------------------------------------------------------------------------+
3324
3325HTTP Response Code:
3326
3327+------------------+---------------------+
3328|HTTP CODE |Description |
3329+==================+=====================+
3330|200 |successful |
3331+------------------+---------------------+
3332|400 |Invalid Request |
3333+------------------+---------------------+
3334|401 |Unauthorized |
3335+------------------+---------------------+
3336|500 |Error |
3337+------------------+---------------------+
3338
3339Create Policy
3340+++++++++++++
3341
3342+--------------------+--------------------------+
3343|Interface Definition|Description |
3344+====================+==========================+
3345|URI |/createPolicy |
3346+--------------------+--------------------------+
3347|Operation Type |PUT |
3348+--------------------+--------------------------+
3349
3350Request Parameters:
3351
3352+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3353|Attribute |Qualifier|Cardinality|Content|Description |
3354+===================+=========+===========+=======+=============================================================+
3355|attributes |M |1 |Object |set of attributes in key value pair |
3356+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3357|configBody |M |1 |String | |
3358+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3359|configBodyType |M |1 |String | |
3360+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3361|configName |M |1 |String | |
3362+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3363|ecompName |M |1 |String | |
3364+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3365|policyClass |M |1 |String | |
3366+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3367|policyConfigType |M |1 |String | |
3368+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3369|policyDescription |M |1 |String | |
3370+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3371|policyName |M |1 |String | |
3372+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3373|requestID |M |1 |String |request ID |
3374+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3375
3376Request Headers:
3377
3378+-------------------+---------+-----------------------------------------------------------------------------------------+
3379|Header Name |Qualifier|Description |
3380+===================+=========+=========================================================================================+
3381|ClientAuth |Y |encoded client authentication details |
3382+-------------------+---------+-----------------------------------------------------------------------------------------+
3383|X-ECOMP-RequestID |N |Request ID to track the requests |
3384+-------------------+---------+-----------------------------------------------------------------------------------------+
3385|Environment |Y |execution environments |
3386+-------------------+---------+-----------------------------------------------------------------------------------------+
3387|Authorization |Y |Base64 encoded username:password |
3388+-------------------+---------+-----------------------------------------------------------------------------------------+
3389
3390HTTP Response Code:
3391
3392+------------------+---------------------+
3393|HTTP CODE |Description |
3394+==================+=====================+
3395|200 |successful |
3396+------------------+---------------------+
3397|400 |Invalid Request |
3398+------------------+---------------------+
3399|401 |Unauthorized |
3400+------------------+---------------------+
3401|500 |Error |
3402+------------------+---------------------+
3403
3404Delete Policy
3405+++++++++++++
3406
3407+--------------------+--------------------------+
3408|Interface Definition|Description |
3409+====================+==========================+
3410|URI |/deletePolicy |
3411+--------------------+--------------------------+
3412|Operation Type |DELETE |
3413+--------------------+--------------------------+
3414
3415Request Parameters:
3416
3417+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3418|Attribute |Qualifier|Cardinality|Content|Description |
3419+===================+=========+===========+=======+=============================================================+
3420|deleteCondition |M |1 |String | |
3421+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3422|pdpGroup |M |1 |String | |
3423+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3424|policyComponent |M |1 |String | |
3425+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3426|policyName |M |1 |String | |
3427+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3428|policyType |M |1 |String | |
3429+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3430|requestID |M |1 |String |request ID |
3431+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3432
3433Request Headers:
3434
3435+-------------------+---------+-----------------------------------------------------------------------------------------+
3436|Header Name |Qualifier|Description |
3437+===================+=========+=========================================================================================+
3438|ClientAuth |Y |encoded client authentication details |
3439+-------------------+---------+-----------------------------------------------------------------------------------------+
3440|X-ECOMP-RequestID |N |Request ID to track the requests |
3441+-------------------+---------+-----------------------------------------------------------------------------------------+
3442|Environment |Y |execution environments |
3443+-------------------+---------+-----------------------------------------------------------------------------------------+
3444|Authorization |Y |Base64 encoded username:password |
3445+-------------------+---------+-----------------------------------------------------------------------------------------+
3446
3447HTTP Response Code:
3448
3449+------------------+---------------------+
3450|HTTP CODE |Description |
3451+==================+=====================+
3452|200 |successful |
3453+------------------+---------------------+
3454|400 |Invalid Request |
3455+------------------+---------------------+
3456|401 |Unauthorized |
3457+------------------+---------------------+
3458|500 |Error |
3459+------------------+---------------------+
3460
3461Get Configuration
3462+++++++++++++++++
3463
3464+--------------------+--------------------------+
3465|Interface Definition|Description |
3466+====================+==========================+
3467|URI |/getConfig |
3468+--------------------+--------------------------+
3469|Operation Type |POST |
3470+--------------------+--------------------------+
3471
3472Request Parameters:
3473
3474+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3475|Attribute |Qualifier|Cardinality|Content|Description |
3476+===================+=========+===========+=======+=============================================================+
3477|configAttributes |M |1 |String | |
3478+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3479|configName |M |1 |String | |
3480+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3481|ecompName |M |1 |String | |
3482+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3483|policyName |M |1 |String | |
3484+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3485|unique |M |1 |Boolean| |
3486+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3487|requestID |M |1 |String |request ID |
3488+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3489
3490Request Headers:
3491
3492+-------------------+---------+-----------------------------------------------------------------------------------------+
3493|Header Name |Qualifier|Description |
3494+===================+=========+=========================================================================================+
3495|ClientAuth |Y |encoded client authentication details |
3496+-------------------+---------+-----------------------------------------------------------------------------------------+
3497|X-ECOMP-RequestID |N |Request ID to track the requests |
3498+-------------------+---------+-----------------------------------------------------------------------------------------+
3499|Environment |Y |execution environments |
3500+-------------------+---------+-----------------------------------------------------------------------------------------+
3501|Authorization |Y |Base64 encoded username:password |
3502+-------------------+---------+-----------------------------------------------------------------------------------------+
3503
3504HTTP Response Code:
3505
3506+------------------+---------------------+
3507|HTTP CODE |Description |
3508+==================+=====================+
3509|200 |successful |
3510+------------------+---------------------+
3511|400 |Invalid Request |
3512+------------------+---------------------+
3513|401 |Unauthorized |
3514+------------------+---------------------+
3515|500 |Error |
3516+------------------+---------------------+
3517
3518Get Decision
3519++++++++++++
3520
3521+--------------------+--------------------------+
3522|Interface Definition|Description |
3523+====================+==========================+
3524|URI |/getDecision |
3525+--------------------+--------------------------+
3526|Operation Type |POST |
3527+--------------------+--------------------------+
3528
3529Request Parameters:
3530
3531+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3532|Attribute |Qualifier|Cardinality|Content|Description |
3533+===================+=========+===========+=======+=============================================================+
3534|decisionAttributes |M |1 |Object | |
3535+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3536|ecompComponentName |M |1 |String | |
3537+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3538|requestID |M |1 |String |request ID |
3539+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3540
3541Request Headers:
3542
3543+-------------------+---------+-----------------------------------------------------------------------------------------+
3544|Header Name |Qualifier|Description |
3545+===================+=========+=========================================================================================+
3546|ClientAuth |Y |encoded client authentication details |
3547+-------------------+---------+-----------------------------------------------------------------------------------------+
3548|X-ECOMP-RequestID |N |Request ID to track the requests |
3549+-------------------+---------+-----------------------------------------------------------------------------------------+
3550|Environment |Y |execution environments |
3551+-------------------+---------+-----------------------------------------------------------------------------------------+
3552|Authorization |Y |Base64 encoded username:password |
3553+-------------------+---------+-----------------------------------------------------------------------------------------+
3554
3555HTTP Response Code:
3556
3557+------------------+---------------------+
3558|HTTP CODE |Description |
3559+==================+=====================+
3560|200 |successful |
3561+------------------+---------------------+
3562|400 |Invalid Request |
3563+------------------+---------------------+
3564|401 |Unauthorized |
3565+------------------+---------------------+
3566|500 |Error |
3567+------------------+---------------------+
3568
3569Response Parameters:
3570
3571+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3572|Attribute |Qualifier|Cardinality|Content|Description |
3573+===================+=========+===========+=======+=============================================================+
3574|decision |N |1 |String | |
3575+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3576|details |N |1 |String | |
3577+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3578
3579Get Dictionary Items
3580++++++++++++++++++++
3581
3582+--------------------+--------------------------+
3583|Interface Definition|Description |
3584+====================+==========================+
3585|URI |/getDictionaryItems |
3586+--------------------+--------------------------+
3587|Operation Type |POST |
3588+--------------------+--------------------------+
3589
3590Request Parameters:
3591
3592+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3593|Attribute |Qualifier|Cardinality|Content|Description |
3594+===================+=========+===========+=======+=============================================================+
3595|dictionary |N |1 |String | |
3596+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3597|dictionaryJson |N |1 |String | |
3598+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3599|dictionaryType |N |1 |String | |
3600+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3601|requestID |M |1 |String |request ID |
3602+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3603
3604Request Headers:
3605
3606+-------------------+---------+-----------------------------------------------------------------------------------------+
3607|Header Name |Qualifier|Description |
3608+===================+=========+=========================================================================================+
3609|ClientAuth |Y |encoded client authentication details |
3610+-------------------+---------+-----------------------------------------------------------------------------------------+
3611|X-ECOMP-RequestID |N |Request ID to track the requests |
3612+-------------------+---------+-----------------------------------------------------------------------------------------+
3613|Environment |Y |execution environments |
3614+-------------------+---------+-----------------------------------------------------------------------------------------+
3615|Authorization |Y |Base64 encoded username:password |
3616+-------------------+---------+-----------------------------------------------------------------------------------------+
3617
3618HTTP Response Code:
3619
3620+------------------+---------------------+
3621|HTTP CODE |Description |
3622+==================+=====================+
3623|200 |successful |
3624+------------------+---------------------+
3625|400 |Invalid Request |
3626+------------------+---------------------+
3627|401 |Unauthorized |
3628+------------------+---------------------+
3629|500 |Error |
3630+------------------+---------------------+
3631
3632Response Parameters:
3633
3634+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3635|Attribute |Qualifier|Cardinality|Content|Description |
3636+===================+=========+===========+=======+=============================================================+
3637|dictionaryData |N |1 |Object | |
3638+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3639|dictionaryJson |N |1 |Object | |
3640+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3641|responseCode |N |1 |Integer| |
3642+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3643|responseMessage |N |1 |Object | |
3644+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3645
3646Get Metrics
3647+++++++++++
3648
3649+--------------------+--------------------------+
3650|Interface Definition|Description |
3651+====================+==========================+
3652|URI |/getMetrics |
3653+--------------------+--------------------------+
3654|Operation Type |GET |
3655+--------------------+--------------------------+
3656
3657Request Headers:
3658
3659+-------------------+---------+-----------------------------------------------------------------------------------------+
3660|Header Name |Qualifier|Description |
3661+===================+=========+=========================================================================================+
3662|ClientAuth |Y |encoded client authentication details |
3663+-------------------+---------+-----------------------------------------------------------------------------------------+
3664|X-ECOMP-RequestID |N |Request ID to track the requests |
3665+-------------------+---------+-----------------------------------------------------------------------------------------+
3666|Environment |Y |execution environments |
3667+-------------------+---------+-----------------------------------------------------------------------------------------+
3668|Authorization |Y |Base64 encoded username:password |
3669+-------------------+---------+-----------------------------------------------------------------------------------------+
3670
3671HTTP Response Code:
3672
3673+------------------+---------------------+
3674|HTTP CODE |Description |
3675+==================+=====================+
3676|200 |successful |
3677+------------------+---------------------+
3678|400 |Invalid Request |
3679+------------------+---------------------+
3680|401 |Unauthorized |
3681+------------------+---------------------+
3682|500 |Error |
3683+------------------+---------------------+
3684
3685Response Parameters:
3686
3687+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3688|Attribute |Qualifier|Cardinality|Content|Description |
3689+===================+=========+===========+=======+=============================================================+
3690|metricsTotal |N |1 |Integer| |
3691+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3692|papMetrics |N |1 |Integer| |
3693+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3694|pdpMetrics |N |1 |Integer| |
3695+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3696|responseCode |N |1 |Object | |
3697+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3698|responseMessage |N |1 |String | |
3699+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3700
3701Get Notification
3702++++++++++++++++
3703
3704+--------------------+--------------------------+
3705|Interface Definition|Description |
3706+====================+==========================+
3707|URI |/getNotification |
3708+--------------------+--------------------------+
3709|Operation Type |POST |
3710+--------------------+--------------------------+
3711
3712Request Headers:
3713
3714+-------------------+---------+-----------------------------------------------------------------------------------------+
3715|Header Name |Qualifier|Description |
3716+===================+=========+=========================================================================================+
3717|ClientAuth |Y |encoded client authentication details |
3718+-------------------+---------+-----------------------------------------------------------------------------------------+
3719|X-ECOMP-RequestID |N |Request ID to track the requests |
3720+-------------------+---------+-----------------------------------------------------------------------------------------+
3721|Environment |Y |execution environments |
3722+-------------------+---------+-----------------------------------------------------------------------------------------+
3723|Authorization |Y |Base64 encoded username:password |
3724+-------------------+---------+-----------------------------------------------------------------------------------------+
3725
3726HTTP Response Code:
3727
3728+------------------+---------------------+
3729|HTTP CODE |Description |
3730+==================+=====================+
3731|200 |successful |
3732+------------------+---------------------+
3733|400 |Invalid Request |
3734+------------------+---------------------+
3735|401 |Unauthorized |
3736+------------------+---------------------+
3737|500 |Error |
3738+------------------+---------------------+
3739
3740Response Parameters:
3741
3742+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3743|Attribute |Qualifier|Cardinality|Content|Description |
3744+===================+=========+===========+=======+=============================================================+
3745|metricsTotal |N |1 |Integer| |
3746+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3747|papMetrics |N |1 |Integer| |
3748+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3749|pdpMetrics |N |1 |Integer| |
3750+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3751|responseCode |N |1 |Object | |
3752+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3753|responseMessage |N |1 |String | |
3754+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3755
3756List Configuration
3757++++++++++++++++++
3758
3759+--------------------+--------------------------+
3760|Interface Definition|Description |
3761+====================+==========================+
3762|URI |/listConfiguration |
3763+--------------------+--------------------------+
3764|Operation Type |POST |
3765+--------------------+--------------------------+
3766
3767Request Headers:
3768
3769+-------------------+---------+-----------------------------------------------------------------------------------------+
3770|Header Name |Qualifier|Description |
3771+===================+=========+=========================================================================================+
3772|ClientAuth |Y |encoded client authentication details |
3773+-------------------+---------+-----------------------------------------------------------------------------------------+
3774|X-ECOMP-RequestID |N |Request ID to track the requests |
3775+-------------------+---------+-----------------------------------------------------------------------------------------+
3776|Environment |Y |execution environments |
3777+-------------------+---------+-----------------------------------------------------------------------------------------+
3778|Authorization |Y |Base64 encoded username:password |
3779+-------------------+---------+-----------------------------------------------------------------------------------------+
3780
3781Request Parameters:
3782
3783+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3784|Attribute |Qualifier|Cardinality|Content|Description |
3785+===================+=========+===========+=======+=============================================================+
3786|configAttributes |N |1 |Object | |
3787+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3788|configName |N |1 |String | |
3789+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3790|ecompName |N |1 |String | |
3791+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3792|policyName |N |1 |String | |
3793+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3794|requestID |N |1 |String | |
3795+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3796|unique |N |1 |Boolean| |
3797+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3798
3799HTTP Response Code:
3800
3801+------------------+---------------------+
3802|HTTP CODE |Description |
3803+==================+=====================+
3804|200 |successful |
3805+------------------+---------------------+
3806|400 |Invalid Request |
3807+------------------+---------------------+
3808|401 |Unauthorized |
3809+------------------+---------------------+
3810|500 |Error |
3811+------------------+---------------------+
3812
3813Import policy
3814+++++++++++++
3815
3816+--------------------+--------------------------+
3817|Interface Definition|Description |
3818+====================+==========================+
3819|URI |/policyEngineImport |
3820+--------------------+--------------------------+
3821|Operation Type |POST |
3822+--------------------+--------------------------+
3823
3824Request Headers:
3825
3826+-------------------+---------+-----------------------------------------------------------------------------------------+
3827|Header Name |Qualifier|Description |
3828+===================+=========+=========================================================================================+
3829|ClientAuth |Y |encoded client authentication details |
3830+-------------------+---------+-----------------------------------------------------------------------------------------+
3831|X-ECOMP-RequestID |N |Request ID to track the requests |
3832+-------------------+---------+-----------------------------------------------------------------------------------------+
3833|Environment |Y |execution environments |
3834+-------------------+---------+-----------------------------------------------------------------------------------------+
3835|Authorization |Y |Base64 encoded username:password |
3836+-------------------+---------+-----------------------------------------------------------------------------------------+
3837
3838Request Parameters:
3839
3840+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3841|Attribute |Qualifier|Cardinality|Content|Description |
3842+===================+=========+===========+=======+=============================================================+
3843|importParameterJson|Y |1 |String | |
3844+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3845|file |Y |1 |File | |
3846+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3847
3848HTTP Response Code:
3849
3850+------------------+---------------------+
3851|HTTP CODE |Description |
3852+==================+=====================+
3853|200 |successful |
3854+------------------+---------------------+
3855|400 |Invalid Request |
3856+------------------+---------------------+
3857|401 |Unauthorized |
3858+------------------+---------------------+
3859|500 |Error |
3860+------------------+---------------------+
3861
3862Push Policy
3863+++++++++++
3864
3865+--------------------+--------------------------+
3866|Interface Definition|Description |
3867+====================+==========================+
3868|URI |/pushPolicy |
3869+--------------------+--------------------------+
3870|Operation Type |PUT |
3871+--------------------+--------------------------+
3872
3873Request Headers:
3874
3875+-------------------+---------+-----------------------------------------------------------------------------------------+
3876|Header Name |Qualifier|Description |
3877+===================+=========+=========================================================================================+
3878|ClientAuth |Y |encoded client authentication details |
3879+-------------------+---------+-----------------------------------------------------------------------------------------+
3880|X-ECOMP-RequestID |N |Request ID to track the requests |
3881+-------------------+---------+-----------------------------------------------------------------------------------------+
3882|Environment |Y |execution environments |
3883+-------------------+---------+-----------------------------------------------------------------------------------------+
3884|Authorization |Y |Base64 encoded username:password |
3885+-------------------+---------+-----------------------------------------------------------------------------------------+
3886
3887Request Parameters:
3888
3889+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3890|Attribute |Qualifier|Cardinality|Content|Description |
3891+===================+=========+===========+=======+=============================================================+
3892|pdpGroup |N |1 |String | |
3893+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3894|policyName |N |1 |String | |
3895+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3896|policyType |N |1 |String | |
3897+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3898
3899HTTP Response Code:
3900
3901+------------------+---------------------+
3902|HTTP CODE |Description |
3903+==================+=====================+
3904|200 |successful |
3905+------------------+---------------------+
3906|400 |Invalid Request |
3907+------------------+---------------------+
3908|401 |Unauthorized |
3909+------------------+---------------------+
3910|500 |Error |
3911+------------------+---------------------+
3912
3913Send Event
3914++++++++++
3915
3916+--------------------+--------------------------+
3917|Interface Definition|Description |
3918+====================+==========================+
3919|URI |/sendEvent |
3920+--------------------+--------------------------+
3921|Operation Type |POST |
3922+--------------------+--------------------------+
3923
3924Request Headers:
3925
3926+-------------------+---------+-----------------------------------------------------------------------------------------+
3927|Header Name |Qualifier|Description |
3928+===================+=========+=========================================================================================+
3929|ClientAuth |Y |encoded client authentication details |
3930+-------------------+---------+-----------------------------------------------------------------------------------------+
3931|X-ECOMP-RequestID |N |Request ID to track the requests |
3932+-------------------+---------+-----------------------------------------------------------------------------------------+
3933|Environment |Y |execution environments |
3934+-------------------+---------+-----------------------------------------------------------------------------------------+
3935|Authorization |Y |Base64 encoded username:password |
3936+-------------------+---------+-----------------------------------------------------------------------------------------+
3937
3938Request Parameters:
3939
3940+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3941|Attribute |Qualifier|Cardinality|Content|Description |
3942+===================+=========+===========+=======+=============================================================+
3943|eventAttributes |N |1 |Object | |
3944+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3945|requestID |N |1 |String | |
3946+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3947
3948HTTP Response Code:
3949
3950+------------------+---------------------+
3951|HTTP CODE |Description |
3952+==================+=====================+
3953|200 |successful |
3954+------------------+---------------------+
3955|400 |Invalid Request |
3956+------------------+---------------------+
3957|401 |Unauthorized |
3958+------------------+---------------------+
3959|500 |Error |
3960+------------------+---------------------+
3961
3962Send Heartbeat
3963++++++++++++++
3964
3965+--------------------+--------------------------+
3966|Interface Definition|Description |
3967+====================+==========================+
3968|URI |/sendEvent |
3969+--------------------+--------------------------+
3970|Operation Type |POST |
3971+--------------------+--------------------------+
3972
3973Request Headers:
3974
3975+-------------------+---------+-----------------------------------------------------------------------------------------+
3976|Header Name |Qualifier|Description |
3977+===================+=========+=========================================================================================+
3978|ClientAuth |Y |encoded client authentication details |
3979+-------------------+---------+-----------------------------------------------------------------------------------------+
3980|X-ECOMP-RequestID |N |Request ID to track the requests |
3981+-------------------+---------+-----------------------------------------------------------------------------------------+
3982|Environment |Y |execution environments |
3983+-------------------+---------+-----------------------------------------------------------------------------------------+
3984|Authorization |Y |Base64 encoded username:password |
3985+-------------------+---------+-----------------------------------------------------------------------------------------+
3986
3987Request Parameters:
3988
3989+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3990|Attribute |Qualifier|Cardinality|Content|Description |
3991+===================+=========+===========+=======+=============================================================+
3992|notificationTopic |Y |1 |String | |
3993+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3994
3995HTTP Response Code:
3996
3997+------------------+---------------------+
3998|HTTP CODE |Description |
3999+==================+=====================+
4000|200 |successful |
4001+------------------+---------------------+
4002|400 |Invalid Request |
4003+------------------+---------------------+
4004|401 |Unauthorized |
4005+------------------+---------------------+
4006|500 |Error |
4007+------------------+---------------------+
4008
4009Stop Notification
4010+++++++++++++++++
4011
4012+--------------------+--------------------------+
4013|Interface Definition|Description |
4014+====================+==========================+
4015|URI |/stopNotification |
4016+--------------------+--------------------------+
4017|Operation Type |POST |
4018+--------------------+--------------------------+
4019
4020Request Headers:
4021
4022+-------------------+---------+-----------------------------------------------------------------------------------------+
4023|Header Name |Qualifier|Description |
4024+===================+=========+=========================================================================================+
4025|ClientAuth |Y |encoded client authentication details |
4026+-------------------+---------+-----------------------------------------------------------------------------------------+
4027|X-ECOMP-RequestID |N |Request ID to track the requests |
4028+-------------------+---------+-----------------------------------------------------------------------------------------+
4029|Environment |Y |execution environments |
4030+-------------------+---------+-----------------------------------------------------------------------------------------+
4031|Authorization |Y |Base64 encoded username:password |
4032+-------------------+---------+-----------------------------------------------------------------------------------------+
4033
4034Request Parameters:
4035
4036+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4037|Attribute |Qualifier|Cardinality|Content|Description |
4038+===================+=========+===========+=======+=============================================================+
4039|notificationTopic |Y |1 |String | |
4040+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4041
4042HTTP Response Code:
4043
4044+------------------+---------------------+
4045|HTTP CODE |Description |
4046+==================+=====================+
4047|200 |successful |
4048+------------------+---------------------+
4049|400 |Invalid Request |
4050+------------------+---------------------+
4051|401 |Unauthorized |
4052+------------------+---------------------+
4053|500 |Error |
4054+------------------+---------------------+
4055
4056Update Dictionary
4057+++++++++++++++++
4058
4059+--------------------+--------------------------+
4060|Interface Definition|Description |
4061+====================+==========================+
4062|URI |/updateDictionaryItem |
4063+--------------------+--------------------------+
4064|Operation Type |PUT |
4065+--------------------+--------------------------+
4066
4067Request Headers:
4068
4069+-------------------+---------+-----------------------------------------------------------------------------------------+
4070|Header Name |Qualifier|Description |
4071+===================+=========+=========================================================================================+
4072|ClientAuth |Y |encoded client authentication details |
4073+-------------------+---------+-----------------------------------------------------------------------------------------+
4074|X-ECOMP-RequestID |N |Request ID to track the requests |
4075+-------------------+---------+-----------------------------------------------------------------------------------------+
4076|Environment |Y |execution environments |
4077+-------------------+---------+-----------------------------------------------------------------------------------------+
4078|Authorization |Y |Base64 encoded username:password |
4079+-------------------+---------+-----------------------------------------------------------------------------------------+
4080
4081Request Parameters:
4082
4083+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4084|Attribute |Qualifier|Cardinality|Content|Description |
4085+===================+=========+===========+=======+=============================================================+
4086|dictionary |N |1 |String | |
4087+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4088|dictionaryJson |N |1 |String | |
4089+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4090|dictionaryType |N |1 |String | |
4091+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4092|requestID |N |1 |String | |
4093+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4094
4095HTTP Response Code:
4096
4097+------------------+---------------------+
4098|HTTP CODE |Description |
4099+==================+=====================+
4100|200 |successful |
4101+------------------+---------------------+
4102|400 |Invalid Request |
4103+------------------+---------------------+
4104|401 |Unauthorized |
4105+------------------+---------------------+
4106|500 |Error |
4107+------------------+---------------------+
4108
4109Update Policy
4110+++++++++++++
4111
4112+--------------------+--------------------------+
4113|Interface Definition|Description |
4114+====================+==========================+
4115|URI |/updatePolicy |
4116+--------------------+--------------------------+
4117|Operation Type |PUT |
4118+--------------------+--------------------------+
4119
4120Request Headers:
4121
4122+-------------------+---------+-----------------------------------------------------------------------------------------+
4123|Header Name |Qualifier|Description |
4124+===================+=========+=========================================================================================+
4125|ClientAuth |Y |encoded client authentication details |
4126+-------------------+---------+-----------------------------------------------------------------------------------------+
4127|X-ECOMP-RequestID |N |Request ID to track the requests |
4128+-------------------+---------+-----------------------------------------------------------------------------------------+
4129|Environment |Y |execution environments |
4130+-------------------+---------+-----------------------------------------------------------------------------------------+
4131|Authorization |Y |Base64 encoded username:password |
4132+-------------------+---------+-----------------------------------------------------------------------------------------+
4133
4134Request Parameters:
4135
4136+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4137|Attribute |Qualifier|Cardinality|Content|Description |
4138+===================+=========+===========+=======+=============================================================+
4139|attributes |N |1 |Object | |
4140+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4141|configBody |N |1 |String | |
4142+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4143|configBodyType |N |1 |String | |
4144+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4145|configName |N |1 |String | |
4146+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4147|ecompName |N |1 |String | |
4148+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4149|policyClass |N |1 |String | |
4150+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4151|policyConfigType |N |1 |String | |
4152+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4153|policyDescription |N |1 |String | |
4154+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4155|policyName |N |1 |String | |
4156+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4157|requestID |N |1 |String | |
4158+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4159
4160HTTP Response Code:
4161
4162+------------------+---------------------+
4163|HTTP CODE |Description |
4164+==================+=====================+
4165|200 |successful |
4166+------------------+---------------------+
4167|400 |Invalid Request |
4168+------------------+---------------------+
4169|401 |Unauthorized |
4170+------------------+---------------------+
4171|500 |Error |
4172+------------------+---------------------+