Gitiles
Code Review Sign In
gerrit.nordix.org / onap / so / 7cd72c70f6206cc9d718f7b32f2642e08472109e / . / docs / SO_R1_Interface.rst
blob: 61bdcc81b047f8bc07118080526f1024e1fbfda7 [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
seshukmd2027a62018-04-10 17:33:31 +0530[diff] [blame]414Delete VF Module
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]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
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]483Create VNF
484+++++++++++++++
485
486+--------------------+--------------------------------------------------------------+
487|Interface Definition|Description |
488+====================+==============================================================+
489|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs |
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|ModelInvariantId |String |The Model Invariant Id. |
528+-------------------------+------------------+-------------------------------------------------+
529|ModelNameVersionId |String |The modelname Version Id |
530+-------------------------+------------------+-------------------------------------------------+
531|ModelName |String |Name of the Model |
532+-------------------------+------------------+-------------------------------------------------+
533|ModelVersion |String |Version of the model |
534+-------------------------+------------------+-------------------------------------------------+
535|ModelCustomization Name |String |The Model Customization name |
536+-------------------------+------------------+-------------------------------------------------+
537
538CloudConfiguration Object
539
540+-------------------------+------------------+-------------------------------------------------+
541|Attribute |Content |Description |
542+=========================+==================+=================================================+
543|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
544+-------------------------+------------------+-------------------------------------------------+
545|tenantId |String |Name of the Subscriber |
546+-------------------------+------------------+-------------------------------------------------+
547
548RequestInfo Object
549
550+-------------------------+------------------+-------------------------------------------------+
551|Attribute |Content |Description |
552+=========================+==================+=================================================+
553|InstanceName |String |The instance Name |
554+-------------------------+------------------+-------------------------------------------------+
555|ProductFamilyId |String |The product family Id. |
556+-------------------------+------------------+-------------------------------------------------+
557|Source |String |source of the request |
558+-------------------------+------------------+-------------------------------------------------+
559|SuppressRollback |Boolean |SuppressRollback |
560+-------------------------+------------------+-------------------------------------------------+
561
562relatedInstance List
563
564+-------------------------+------------------+-------------------------------------------------+
565|Attribute |Content |Description |
566+=========================+==================+=================================================+
567|relatedInstance |Object |relatedInstance Object |
568+-------------------------+------------------+-------------------------------------------------+
569
570relatedInstance List
571
572+-------------------------+------------------+-------------------------------------------------+
573|Attribute |Content |Description |
574+=========================+==================+=================================================+
575|instanceId |String |instanceId |
576+-------------------------+------------------+-------------------------------------------------+
577|modelInfo |Object |Content of modelInfo object. |
578+-------------------------+------------------+-------------------------------------------------+
579
580RequestParameters Object
581
582+-------------------------+------------------+-------------------------------------------------+
583|Attribute |Content |Description |
584+=========================+==================+=================================================+
585|UserParams |Array |The product family Id. |
586+-------------------------+------------------+-------------------------------------------------+
587
588UserParams Object
589
590+-------------------------+------------------+-------------------------------------------------+
591|Attribute |Content |Description |
592+=========================+==================+=================================================+
593|name |String |Tag name of attribute |
594+-------------------------+------------------+-------------------------------------------------+
595|value |String |Value of the tag |
596+-------------------------+------------------+-------------------------------------------------+
597
598Delete VNF
599+++++++++++++++
600
601+--------------------+------------------------------------------------------------------------------+
602|Interface Definition|Description |
603+====================+==============================================================================+
604|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId} |
605+--------------------+------------------------------------------------------------------------------+
606|Operation Type |DELETE |
607+--------------------+------------------------------------------------------------------------------+
608|Content-Type |application/json |
609+--------------------+------------------------------------------------------------------------------+
610
611Request Body:
612
613+----------------+---------+-----------+--------------------------+-------------------------------------------+
614|Attribute |Qualifier|Cardinality|Content |Description |
615+================+=========+===========+==========================+===========================================+
616|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
617+----------------+---------+-----------+--------------------------+-------------------------------------------+
618
619RequestDetails Object
620
621+---------------------+-------------------------+-------------------------------------------------+
622|Attribute |Content |Description |
623+=====================+=========================+=================================================+
624|modelInfo |modelInfo Object |Content of modelInfo object. |
625+---------------------+-------------------------+-------------------------------------------------+
626|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
627+---------------------+-------------------------+-------------------------------------------------+
628|requestInfo |requestInfo Object |Content of requestInfo object. |
629+---------------------+-------------------------+-------------------------------------------------+
630|requestParameters |requestParameters Object |Content of requestParameters object. |
631+---------------------+-------------------------+-------------------------------------------------+
632
633ModelInfo Object
634
635+-------------------------+------------------+-------------------------------------------------+
636|Attribute |Content |Description |
637+=========================+==================+=================================================+
638|ModelType |String |Type of model |
639+-------------------------+------------------+-------------------------------------------------+
640|ModelName |String |Name of the Model |
641+-------------------------+------------------+-------------------------------------------------+
642
643CloudConfiguration Object
644
645+-------------------------+------------------+-------------------------------------------------+
646|Attribute |Content |Description |
647+=========================+==================+=================================================+
648|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
649+-------------------------+------------------+-------------------------------------------------+
650|tenantId |String |Name of the Subscriber |
651+-------------------------+------------------+-------------------------------------------------+
652
653RequestInfo Object
654
655+-------------------------+------------------+-------------------------------------------------+
656|Attribute |Content |Description |
657+=========================+==================+=================================================+
658|Source |String |source of the request |
659+-------------------------+------------------+-------------------------------------------------+
660
661RequestParameters Object
662
663+-------------------------+------------------+-------------------------------------------------+
664|Attribute |Content |Description |
665+=========================+==================+=================================================+
666|UserParams |Array |The product family Id. |
667+-------------------------+------------------+-------------------------------------------------+
668
669UserParams Object
670
671+-------------------------+------------------+-------------------------------------------------+
672|Attribute |Content |Description |
673+=========================+==================+=================================================+
674|name |String |Tag name of attribute |
675+-------------------------+------------------+-------------------------------------------------+
676|value |String |Value of the tag |
677+-------------------------+------------------+-------------------------------------------------+
678
679GET Orchestration Request
680++++++++++++++++++++++++++
681
682+--------------------+--------------------------------------------------------------+
683|Interface Definition|Description |
684+====================+==============================================================+
685|URI |{serverRoot}/orchestrationRequests/v2/{request-id} |
686+--------------------+--------------------------------------------------------------+
687|Operation Type |GET |
688+--------------------+--------------------------------------------------------------+
689|Content-Type |application/json |
690+--------------------+--------------------------------------------------------------+
691
692Response Body:
693
694+----------------+---------+-----------+--------------------------+-------------------------------------------+
695|Attribute |Qualifier|Cardinality|Content |Description |
696+================+=========+===========+==========================+===========================================+
697|request |M |1 |request Object |Content of request object. |
698+----------------+---------+-----------+--------------------------+-------------------------------------------+
699
700Request Object
701
702+-------------------+---------+-----------+--------------------------+-------------------------------------------+
703|Attribute |Qualifier|Cardinality|Content |Description |
704+===================+=========+===========+==========================+===========================================+
705|requestId |M |1 |String |Request Id |
706+-------------------+---------+-----------+--------------------------+-------------------------------------------+
707|startTime |M |1 |request Object |Start time. |
708+-------------------+---------+-----------+--------------------------+-------------------------------------------+
709|serviceInstanceId |M |1 |request Object |Service Instance id. |
710+-------------------+---------+-----------+--------------------------+-------------------------------------------+
711|requestScope |M |1 |request Object |Scope of the request. |
712+-------------------+---------+-----------+--------------------------+-------------------------------------------+
713|requestType |M |1 |request Object |Type of the request. |
714+-------------------+---------+-----------+--------------------------+-------------------------------------------+
715|requestDetails |M |1 |requestDetails Object |Type of the request. |
716+-------------------+---------+-----------+--------------------------+-------------------------------------------+
717|requestStatus |M |1 |requestStatus Object |Type of the request. |
718+-------------------+---------+-----------+--------------------------+-------------------------------------------+
719
720RequestDetails Object
721
722+-------------------+-------------------------+-------------------------------------------------+
723|Attribute |Content |Description |
724+===================+=========================+=================================================+
725|modelInfo |modelInfo Object |Content of modelInfo object. |
726+-------------------+-------------------------+-------------------------------------------------+
727|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
728+-------------------+-------------------------+-------------------------------------------------+
729|requestInfo |requestInfo Object |Content of requestInfo object. |
730+-------------------+-------------------------+-------------------------------------------------+
731|requestParameters |requestParameters Object |Content of requestParameters object. |
732+-------------------+-------------------------+-------------------------------------------------+
733
734ModelInfo Object
735
736+-------------------------+------------------+-------------------------------------------------+
737|Attribute |Content |Description |
738+=========================+==================+=================================================+
739|ModelType |String |Type of model |
740+-------------------------+------------------+-------------------------------------------------+
741|ModelInvariantId |String |The Model Invariant Id. |
742+-------------------------+------------------+-------------------------------------------------+
743|ModelNameVersionId |String |The modelname Version Id |
744+-------------------------+------------------+-------------------------------------------------+
745|ModelName |String |Name of the Model |
746+-------------------------+------------------+-------------------------------------------------+
747|ModelVersion |String |Version of the model |
748+-------------------------+------------------+-------------------------------------------------+
749
750SubscriberInfo Object
751
752+-------------------------+------------------+-------------------------------------------------+
753|Attribute |Content |Description |
754+=========================+==================+=================================================+
755|GlobalSubscriberId |String |Global customer Id (in A&AI) |
756+-------------------------+------------------+-------------------------------------------------+
757|SubscriberName |String |Name of the Subscriber |
758+-------------------------+------------------+-------------------------------------------------+
759
760RequestInfo Object
761
762+-------------------------+------------------+-------------------------------------------------+
763|Attribute |Content |Description |
764+=========================+==================+=================================================+
765|InstanceName |String |The instance Name |
766+-------------------------+------------------+-------------------------------------------------+
767|Source |String |source of the request |
768+-------------------------+------------------+-------------------------------------------------+
769|SuppressRollback |Boolean |SuppressRollback |
770+-------------------------+------------------+-------------------------------------------------+
771
772RequestParameters Object
773
774+-------------------------+------------------+-------------------------------------------------+
775|Attribute |Content |Description |
776+=========================+==================+=================================================+
777|SubscriptionServiceType |String |The service type of the Subscription |
778+-------------------------+------------------+-------------------------------------------------+
779
780RequestStatus Object
781
782+-------------------------+------------------+-------------------------------------------------+
783|Attribute |Content |Description |
784+=========================+==================+=================================================+
785|timestamp |String |Time |
786+-------------------------+------------------+-------------------------------------------------+
787|requestState |String |state of the request |
788+-------------------------+------------------+-------------------------------------------------+
789|statusMessage |String |statusMessage |
790+-------------------------+------------------+-------------------------------------------------+
791|percentProgress |String |percentage of progress |
792+-------------------------+------------------+-------------------------------------------------+
793
794GET Orchestration Requests
795++++++++++++++++++++++++++
796
797+--------------------+--------------------------------------------------------------+
798|Interface Definition|Description |
799+====================+==============================================================+
800|URI |{serverRoot}/orchestrationRequests/v2 |
801+--------------------+--------------------------------------------------------------+
802|Operation Type |GET |
803+--------------------+--------------------------------------------------------------+
804|Content-Type |application/json |
805+--------------------+--------------------------------------------------------------+
806
807Response Body:
808
809+----------------+---------+-----------+--------------------------+-------------------------------------------+
810|Attribute |Qualifier|Cardinality|Content |Description |
811+================+=========+===========+==========================+===========================================+
812|requestList |M |1 |Array |Content of request List. |
813+----------------+---------+-----------+--------------------------+-------------------------------------------+
814
815RequestList :
816
817+----------------+---------+-----------+--------------------------+-------------------------------------------+
818|Attribute |Qualifier|Cardinality|Content |Description |
819+================+=========+===========+==========================+===========================================+
820|request |M |1 |request Object |Content of request object. |
821+----------------+---------+-----------+--------------------------+-------------------------------------------+
822
823Request Object
824
825+-------------------+---------+-----------+--------------------------+-------------------------------------------+
826|Attribute |Qualifier|Cardinality|Content |Description |
827+===================+=========+===========+==========================+===========================================+
828|requestId |M |1 |String |Request Id |
829+-------------------+---------+-----------+--------------------------+-------------------------------------------+
830|startTime |M |1 |request Object |Start time. |
831+-------------------+---------+-----------+--------------------------+-------------------------------------------+
832|serviceInstanceId |M |1 |request Object |Service Instance id. |
833+-------------------+---------+-----------+--------------------------+-------------------------------------------+
834|requestScope |M |1 |request Object |Scope of the request. |
835+-------------------+---------+-----------+--------------------------+-------------------------------------------+
836|requestType |M |1 |request Object |Type of the request. |
837+-------------------+---------+-----------+--------------------------+-------------------------------------------+
838|requestDetails |M |1 |requestDetails Object |Type of the request. |
839+-------------------+---------+-----------+--------------------------+-------------------------------------------+
840|requestStatus |M |1 |requestStatus Object |Type of the request. |
841+-------------------+---------+-----------+--------------------------+-------------------------------------------+
842
843RequestDetails Object
844
845+-------------------+-------------------------+-------------------------------------------------+
846|Attribute |Content |Description |
847+===================+=========================+=================================================+
848|modelInfo |modelInfo Object |Content of modelInfo object. |
849+-------------------+-------------------------+-------------------------------------------------+
850|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
851+-------------------+-------------------------+-------------------------------------------------+
852|requestInfo |requestInfo Object |Content of requestInfo object. |
853+-------------------+-------------------------+-------------------------------------------------+
854|requestParameters |requestParameters Object |Content of requestParameters object. |
855+-------------------+-------------------------+-------------------------------------------------+
856
857ModelInfo Object
858
859+-------------------------+------------------+-------------------------------------------------+
860|Attribute |Content |Description |
861+=========================+==================+=================================================+
862|ModelType |String |Type of model |
863+-------------------------+------------------+-------------------------------------------------+
864|ModelInvariantId |String |The Model Invariant Id. |
865+-------------------------+------------------+-------------------------------------------------+
866|ModelNameVersionId |String |The modelname Version Id |
867+-------------------------+------------------+-------------------------------------------------+
868|ModelName |String |Name of the Model |
869+-------------------------+------------------+-------------------------------------------------+
870|ModelVersion |String |Version of the model |
871+-------------------------+------------------+-------------------------------------------------+
872
873SubscriberInfo Object
874
875+-------------------------+------------------+-------------------------------------------------+
876|Attribute |Content |Description |
877+=========================+==================+=================================================+
878|GlobalSubscriberId |String |Global customer Id (in A&AI) |
879+-------------------------+------------------+-------------------------------------------------+
880|SubscriberName |String |Name of the Subscriber |
881+-------------------------+------------------+-------------------------------------------------+
882
883RequestInfo Object
884
885+-------------------------+------------------+-------------------------------------------------+
886|Attribute |Content |Description |
887+=========================+==================+=================================================+
888|InstanceName |String |The instance Name |
889+-------------------------+------------------+-------------------------------------------------+
890|Source |String |source of the request |
891+-------------------------+------------------+-------------------------------------------------+
892|SuppressRollback |Boolean |SuppressRollback |
893+-------------------------+------------------+-------------------------------------------------+
894
895RequestParameters Object
896
897+-------------------------+------------------+-------------------------------------------------+
898|Attribute |Content |Description |
899+=========================+==================+=================================================+
900|SubscriptionServiceType |String |The service type of the Subscription |
901+-------------------------+------------------+-------------------------------------------------+
902
903RequestStatus Object
904
905+-------------------------+------------------+-------------------------------------------------+
906|Attribute |Content |Description |
907+=========================+==================+=================================================+
908|timestamp |String |Time |
909+-------------------------+------------------+-------------------------------------------------+
910|requestState |String |state of the request |
911+-------------------------+------------------+-------------------------------------------------+
912|statusMessage |String |statusMessage |
913+-------------------------+------------------+-------------------------------------------------+
914|percentProgress |String |percentage of progress |
915+-------------------------+------------------+-------------------------------------------------+
916
917SDC API
918--------
919
920Get List of Existing Catalog Assets
921+++++++++++++++++++++++++++++++++++
922
923+--------------------+--------------------------+
924|Interface Definition|Description |
925+====================+==========================+
926|URI |sdc/v1/catalog/{assetType}|
927+--------------------+--------------------------+
928|Operation Type |GET |
929+--------------------+--------------------------+
930
931Request Parameters:
932
933+-------------------+---------+-----------+-------+-------------------------------------------------------------+
934|Attribute |Qualifier|Cardinality|Content|Description |
935+===================+=========+===========+=======+=============================================================+
936|assetType |M |1 |String |The requested asset type.valid values are resources/services.|
937+-------------------+---------+-----------+-------+-------------------------------------------------------------+
938|service-type |M |1 |String |Service Type |
939+-------------------+---------+-----------+-------+-------------------------------------------------------------+
940|service-instance-id|M |1 |String |Service Instance ID |
941+-------------------+---------+-----------+-------+-------------------------------------------------------------+
942
943Request Headers:
944
945+-------------------+---------+-----------------------------------------------------------------------------------------+
946|Header Name |Qualifier|Description |
947+===================+=========+=========================================================================================+
948|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
949+-------------------+---------+-----------------------------------------------------------------------------------------+
950|X-ECOMP-InstanceID |Y |Instance ID |
951+-------------------+---------+-----------------------------------------------------------------------------------------+
952|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
953+-------------------+---------+-----------------------------------------------------------------------------------------+
954|Authorization |Y |Base64 encoded username:password |
955+-------------------+---------+-----------------------------------------------------------------------------------------+
956
957Response:
958
959+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
960|Attribute |Qualifier|Cardinality|Content|Description |
961+==================+=========+===========+=======+======================================================================================+
962|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
963+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
964|invariantUUID |M |1 |String |UUID generated by SDC per each asset. |
965+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
966|name |M |1 |String |The name of the asset |
967+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
968|version |M |1 |String |The asset version in SDC catalog. |
969+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
970|toscaModelURL |M |1 |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
971+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
972|category |M |1 |String |Category of the asset. |
973+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
974|subcategory |M |1 |String |Sub-category of the asset |
975+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
976|resourceType |M |1 |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF. |
977+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
978|lifecycleState |M |1 |String |The lifecycle state of the asset |
979+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
980|lastUpdaterUserId |M |1 |String |UserID of the SDC designer who was the last to update the asset for this major version|
981+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
982
983Get Specific Asset Detailed Metadata
984++++++++++++++++++++++++++++++++++++
985
986+--------------------+-------------------------------------------+
987|Interface Definition|Description |
988+====================+===========================================+
989|URI |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
990+--------------------+-------------------------------------------+
991|Operation Type |GET |
992+--------------------+-------------------------------------------+
993
994Request Parameters:
995
996+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
997|Attribute |Qualifier|Cardinality|Content|Description |
998+===================+=========+===========+=======+=====================================================================================+
999|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1000+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1001|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
1002+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1003
1004Request Headers:
1005
1006+-------------------+---------+-----------------------------------------------------------------------------------------+
1007|Header Name |Qualifier|Description |
1008+===================+=========+=========================================================================================+
1009|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1010+-------------------+---------+-----------------------------------------------------------------------------------------+
1011|X-ECOMP-InstanceID |Y |Instance ID |
1012+-------------------+---------+-----------------------------------------------------------------------------------------+
1013|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1014+-------------------+---------+-----------------------------------------------------------------------------------------+
1015|Authorization |Y |Base64 encoded username:password |
1016+-------------------+---------+-----------------------------------------------------------------------------------------+
1017
1018Response:
1019
1020+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1021|Attribute |Qualifier|Content|Description |
1022+====================+=========+=======+======================================================================================+
1023|uuid |M |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1024+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1025|invariantUUID |M |String |UUID generated by SDC per each asset. |
1026+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1027|name |M |String |The name of the asset |
1028+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1029|version |M |String |The asset version in SDC catalog. |
1030+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1031|toscaModelURL |M |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
1032+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1033|description |M |String |Short description of the resource |
1034+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1035|lastUpdaterUserId |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1036+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1037|lastUpdaterFullName |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1038+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1039|category |M |String |Category of the asset |
1040+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1041|subCategory |M |String |Sub-category of the asset. |
1042+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1043|toscaResourceName |M |String |The full name of the asset |
1044+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1045|resourceType |M |String |The type of resource. |
1046+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1047|lifecycleState |M |String |The lifecycle state of the asset |
1048+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1049|resources |N |Object |Category of the asset |
1050+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1051|artifacts |M |Object |Category of the asset |
1052+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1053
1054Resource Object:
1055
1056+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1057|Attribute |Qualifier|Content|Description | |
1058+=====================+=========+=======+===================================================================================================================+
1059|resourceInstanceName |M |String |Logical Resource Instance Name.Unique Identifier of the instance of the specific resource in the service context.|
1060+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1061|resourceName |M |String |Resource Name |
1062+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1063|resourceInvariantUUID|M |String |The invariant UUID of the resource |
1064+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1065|resourceVersion |M |String |Resource Version |
1066+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1067|resoucreType |M |String |Resource Type |
1068+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1069|resourceUUID |M |String |Global UUID of the resource that specific artifact belongs to |
1070+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1071|artifacts |M |Object |Array of resource instance deployment artifacts. |
1072+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1073
1074Artifact Metadata Object:
1075
1076+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1077|Attribute |Qualifier|Content |Description |
1078+=====================+=========+========+===================================================================================================================+
1079|artifactName |M |String |Artifact File name |
1080+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1081|artifactLabel |M |String |Identifier of the artifact within the VF / Service. |
1082+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1083|artifactType |M |String |Artifact Type |
1084+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1085|artifactGroupType |M |String |Whether the artifact is informational or deployment. |
1086+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1087|artifactURL |M |String |Relative artifact’s URL. |
1088+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1089|artifactDescription |M |String |Artifact Description |
1090+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1091|artifactTimeout |N |Integer |Artifact Description |
1092+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1093|artifactChecksum |M |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1094+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1095|artifactUUID |M |String |Global UUID generated by SDC each time when artifact payload is updated. |
1096+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1097|artifactVersion |M |String |Service Version |
1098+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1099|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1100+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1101
1102Download (CSAR of) Specific Asset
1103+++++++++++++++++++++++++++++++++
1104
1105+--------------------+-----------------------------------------------------------+
1106|Interface Definition|Description |
1107+====================+===========================================================+
1108|URI |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
1109+--------------------+-----------------------------------------------------------+
1110|Operation Type |GET |
1111+--------------------+-----------------------------------------------------------+
1112
1113Request Parameters:
1114
1115+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1116|Attribute |Qualifier|Cardinality|Content|Description |
1117+===================+=========+===========+=======+=====================================================================================+
1118|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1119+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1120|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1121+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1122|artifactUUID |M |1 |String |The artifactUUID of the asset as published in the metadata |
1123+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1124
1125Response:
1126
1127+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1128|Header name |Qualifier|Description |
1129+====================+=========+==========================================================================================================================+
1130|Content-Type |M |Specifies the downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
1131+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1132|Content-Length |M |Streamed artifact payload size |
1133+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1134|Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . |
1135+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1136
1137Upload Artifact
1138+++++++++++++++
1139
1140+--------------------+-----------------------------------------------------------------------------------------------+
1141|Interface Definition|Description |
1142+====================+===============================================================================================+
1143|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
1144+--------------------+-----------------------------------------------------------------------------------------------+
1145|Operation Type |POST |
1146+--------------------+-----------------------------------------------------------------------------------------------+
1147
1148Request Parameters:
1149
1150+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1151|Attribute |Qualifier|Cardinality|Content|Description |
1152+==============================+=========+===========+=======+=====================================================================================+
1153|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1154+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1155|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1156+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1157|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1158+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1159
1160Request Body
1161++++++++++++
1162
1163+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1164|Attribute |Qualifier|Cardinality|Content|Description |
1165+==============================+=========+===========+=======+=====================================================================================+
1166|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1167+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1168|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1169+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1170|artifactName |M |1 |String |The name of the artifact |
1171+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1172|artifactType |M |1 |String |The type of the artifact |
1173+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1174|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1175+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1176|description |M |1 |String |Description of the artifact |
1177+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1178
1179Request Headers:
1180
1181+-------------------+---------+-----------------------------------------------------------------------------------------+
1182|Header Name |Qualifier|Description |
1183+===================+=========+=========================================================================================+
1184|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1185+-------------------+---------+-----------------------------------------------------------------------------------------+
1186|X-ECOMP-InstanceID |Y |Instance ID |
1187+-------------------+---------+-----------------------------------------------------------------------------------------+
1188|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1189+-------------------+---------+-----------------------------------------------------------------------------------------+
1190|Authorization |Y |Base64 encoded username:password |
1191+-------------------+---------+-----------------------------------------------------------------------------------------+
1192|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1193+-------------------+---------+-----------------------------------------------------------------------------------------+
1194|Content-Type |Y |Valid value is : application/json |
1195+-------------------+---------+-----------------------------------------------------------------------------------------+
1196|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1197+-------------------+---------+-----------------------------------------------------------------------------------------+
1198
1199Response:
1200
1201+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1202|Attribute |Qualifier|Content|Description |
1203+====================+=========+=======+===================================================================================================+
1204|artifactName |M |String |Artifact File name |
1205+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1206|artifactType |M |String |Artifact Type |
1207+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1208|artifactURL |M |String |Relative artifact’s URL. |
1209+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1210|artifactDescription |M |String |Artifact Description. |
1211+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1212|artifactTimeout |N |String |Will be populated only if its value is not 0. |
1213+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1214|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1215+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1216|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1217+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1218|artifactVersion |Y |String |Service Version . |
1219+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1220|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1221+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1222
1223Update Artifact
1224+++++++++++++++
1225
1226+--------------------+--------------------------------------------------------------------------------------------------------------+
1227|Interface Definition|Description |
1228+====================+==============================================================================================================+
1229|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1230+--------------------+--------------------------------------------------------------------------------------------------------------+
1231|Operation Type |POST |
1232+--------------------+--------------------------------------------------------------------------------------------------------------+
1233
1234Request Parameters:
1235
1236+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1237|Attribute |Qualifier|Cardinality|Content|Description |
1238+==============================+=========+===========+=======+=====================================================================================+
1239|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1240+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1241|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1242+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1243|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1244+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1245|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1246+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1247
1248Request Headers:
1249
1250+-------------------+---------+-----------------------------------------------------------------------------------------+
1251|Header Name |Qualifier|Description |
1252+===================+=========+=========================================================================================+
1253|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1254+-------------------+---------+-----------------------------------------------------------------------------------------+
1255|X-ECOMP-InstanceID |Y |Instance ID |
1256+-------------------+---------+-----------------------------------------------------------------------------------------+
1257|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1258+-------------------+---------+-----------------------------------------------------------------------------------------+
1259|Authorization |Y |Base64 encoded username:password |
1260+-------------------+---------+-----------------------------------------------------------------------------------------+
1261|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1262+-------------------+---------+-----------------------------------------------------------------------------------------+
1263|Content-Type |Y |Valid value is : application/json |
1264+-------------------+---------+-----------------------------------------------------------------------------------------+
1265|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1266+-------------------+---------+-----------------------------------------------------------------------------------------+
1267
1268Request Body:
1269
1270+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1271|Attribute |Qualifier|Cardinality|Content|Description |
1272+==============================+=========+===========+=======+=====================================================================================+
1273|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1274+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1275|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1276+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1277|artifactName |M |1 |String |The name of the artifact |
1278+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1279|artifactType |M |1 |String |The type of the artifact |
1280+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1281|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1282+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1283|description |M |1 |String |Description of the artifact |
1284+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1285
1286Response:
1287
1288+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1289|Attribute |Qualifier|Content|Description |
1290+====================+=========+=======+===================================================================================================+
1291|artifactName |M |String |Artifact File name |
1292+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1293|artifactType |M |String |Artifact Type |
1294+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1295|artifactURL |M |String |Relative artifact’s URL. |
1296+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1297|artifactDescription |M |String |Artifact Description. |
1298+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1299|artifactTimeout |N |String |Will be populated only if its value is not 0. |
1300+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1301|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1302+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1303|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1304+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1305|artifactVersion |Y |String |Service Version . |
1306+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1307|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1308+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1309
1310Delete Artifact
1311+++++++++++++++
1312
1313+--------------------+--------------------------------------------------------------------------------------------------------------+
1314|Interface Definition|Description |
1315+====================+==============================================================================================================+
1316|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1317+--------------------+--------------------------------------------------------------------------------------------------------------+
1318|Operation Type |DELETE |
1319+--------------------+--------------------------------------------------------------------------------------------------------------+
1320
1321Request Parameters:
1322
1323+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1324|Attribute |Qualifier|Cardinality|Content|Description |
1325+==============================+=========+===========+=======+=====================================================================================+
1326|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1327+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1328|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1329+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1330|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1331+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1332|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1333+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1334
1335Request Headers:
1336
1337+-------------------+---------+-----------------------------------------------------------------------------------------+
1338|Header Name |Qualifier|Description |
1339+===================+=========+=========================================================================================+
1340|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1341+-------------------+---------+-----------------------------------------------------------------------------------------+
1342|X-ECOMP-InstanceID |Y |Instance ID |
1343+-------------------+---------+-----------------------------------------------------------------------------------------+
1344|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1345+-------------------+---------+-----------------------------------------------------------------------------------------+
1346|Authorization |Y |Base64 encoded username:password |
1347+-------------------+---------+-----------------------------------------------------------------------------------------+
1348|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1349+-------------------+---------+-----------------------------------------------------------------------------------------+
1350
1351Response:
1352
1353+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1354|Attribute |Qualifier|Content|Description |
1355+====================+=========+=======+===================================================================================================+
1356|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1357+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1358
1359Update Lifecycle
1360++++++++++++++++
1361
1362+--------------------+--------------------------------------------------------------------------------------------------------------+
1363|Interface Definition|Description |
1364+====================+==============================================================================================================+
1365|URI |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation} |
1366+--------------------+--------------------------------------------------------------------------------------------------------------+
1367|Operation Type |POST |
1368+--------------------+--------------------------------------------------------------------------------------------------------------+
1369
1370Request Parameters:
1371
1372+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1373|Attribute |Qualifier|Cardinality|Content|Description |
1374+==============================+=========+===========+=======+=====================================================================================================+
1375|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1376+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1377|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1378+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1379|lifecycleOperation |M |1 |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout / Certify |
1380+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1381
1382Request Headers:
1383
1384+-------------------+---------+-----------------------------------------------------------------------------------------+
1385|Header Name |Qualifier|Description |
1386+===================+=========+=========================================================================================+
1387|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1388+-------------------+---------+-----------------------------------------------------------------------------------------+
1389|X-ECOMP-InstanceID |Y |Instance ID |
1390+-------------------+---------+-----------------------------------------------------------------------------------------+
1391|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1392+-------------------+---------+-----------------------------------------------------------------------------------------+
1393|Authorization |Y |Base64 encoded username:password |
1394+-------------------+---------+-----------------------------------------------------------------------------------------+
1395|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1396+-------------------+---------+-----------------------------------------------------------------------------------------+
1397
1398Request Parameters:
1399
1400+-------------------+---------+-----------------------------------------------------------------------------------------+
1401|Attribute |Qualifier|Description |
1402+===================+=========+=========================================================================================+
1403|userRemarks |N |Short description (free text) about the asset version being changed |
1404+-------------------+---------+-----------------------------------------------------------------------------------------+
1405
1406Response:
1407
1408+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1409|Attribute |Qualifier|Content|Description |
1410+====================+=========+=======+===================================================================================================+
1411|uuid |Y |String |UUID generated by SDC per each major version of the asset |
1412+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1413|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1414+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1415|name |Y |String |The name of the asset. |
1416+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1417|version |Y |String |The asset version in SDC catalog |
1418+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1419|category |Y |String |Category of the asset. |
1420+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1421|subcategory |Y |String |Sub-category of the asset. |
1422+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1423|resourceType |Y |String |The type of resource. |
1424+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1425|lifecycleState |Y |String |The lifecycle state of the asset. |
1426+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1427|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1428+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1429
1430Create Resource
1431+++++++++++++++
1432
1433+--------------------+--------------------------------------------------------------------------------------------------------------+
1434|Interface Definition|Description |
1435+====================+==============================================================================================================+
1436|URI |/sdc/v1/catalog/resources |
1437+--------------------+--------------------------------------------------------------------------------------------------------------+
1438|Operation Type |POST |
1439+--------------------+--------------------------------------------------------------------------------------------------------------+
1440
1441Request Headers:
1442
1443+-------------------+---------+-----------------------------------------------------------------------------------------+
1444|Header Name |Qualifier|Description |
1445+===================+=========+=========================================================================================+
1446|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1447+-------------------+---------+-----------------------------------------------------------------------------------------+
1448|X-ECOMP-InstanceID |Y |Instance ID |
1449+-------------------+---------+-----------------------------------------------------------------------------------------+
1450|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1451+-------------------+---------+-----------------------------------------------------------------------------------------+
1452|Authorization |Y |Base64 encoded username:password |
1453+-------------------+---------+-----------------------------------------------------------------------------------------+
1454|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1455+-------------------+---------+-----------------------------------------------------------------------------------------+
1456|Content-Type |Y |Valid value is : application/json |
1457+-------------------+---------+-----------------------------------------------------------------------------------------+
1458
1459Request Parameters:
1460
1461+-------------------+---------+-----------------------------------------------------------------------------------------+
1462|Attribute |Qualifier|Description |
1463+===================+=========+=========================================================================================+
1464|name |Y |The name of the resource |
1465+-------------------+---------+-----------------------------------------------------------------------------------------+
1466|description |Y |Short description of the resource |
1467+-------------------+---------+-----------------------------------------------------------------------------------------+
1468|resourceType |Y |“VFCMT” / “VF” / “PNF” |
1469+-------------------+---------+-----------------------------------------------------------------------------------------+
1470|category |Y |VFCMT category is “Template”. |
1471+-------------------+---------+-----------------------------------------------------------------------------------------+
1472|subcategory |Y |VFCMT subcategory is “Monitoring Template”. |
1473+-------------------+---------+-----------------------------------------------------------------------------------------+
1474|vendorName |Y |Vendor Name |
1475+-------------------+---------+-----------------------------------------------------------------------------------------+
1476|vendorRelease |Y |Vendor Release |
1477+-------------------+---------+-----------------------------------------------------------------------------------------+
1478|tags |Y |The tags are used for search options. |
1479+-------------------+---------+-----------------------------------------------------------------------------------------+
1480|icon |Y |The icon should be pre-defined in SDC. |
1481+-------------------+---------+-----------------------------------------------------------------------------------------+
1482|contactId |Y |The user ID of user responsible for this VFCMT. |
1483+-------------------+---------+-----------------------------------------------------------------------------------------+
1484
1485Response:
1486
1487+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1488|Attribute |Qualifier|Content|Description |
1489+====================+=========+=======+===================================================================================================+
1490|uuid |Y |String |UUID generated by SDC per each major version of the asset |
1491+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1492|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1493+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1494|name |Y |String |The name of the asset. |
1495+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1496|version |Y |String |The asset version in SDC catalog |
1497+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1498|category |Y |String |Category of the asset. |
1499+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1500|subcategory |Y |String |Sub-category of the asset. |
1501+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1502|resourceType |Y |String |The type of resource. |
1503+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1504|lifecycleState |Y |String |The lifecycle state of the asset. |
1505+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1506|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1507+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1508
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1509UUI API
1510----------------
1511Create E2E service instance
1512++++++++++++++++++++++++++++
1513
1514+--------------------+-------------------------------------+
1515|Interface Definition|Description |
1516+====================+=====================================+
1517|URI |{serverRoot}/e2eServiceInstances/v3 |
1518+--------------------+-------------------------------------+
1519|Operation Type |POST |
1520+--------------------+-------------------------------------+
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]1521|Content-Type |application/json |
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1522+--------------------+-------------------------------------+
1523
1524Request Body:
1525
1526+---------+---------+-----------+--------------------------+-----------------------------+
1527|Attribute|Qualifier|Cardinality|Content |Description |
1528+=========+=========+===========+==========================+=============================+
1529|service |M |1 |Service Object |Content of service object. |
1530+---------+---------+-----------+--------------------------+-----------------------------+
1531
1532Service Object
1533
1534+----------------+------------------+-------------------------------------------------+
1535|Attribute |Content |Description |
1536+================+==================+=================================================+
1537|name |String |Service instance name. |
1538+----------------+------------------+-------------------------------------------------+
1539|description |String |Service instance description |
1540+----------------+------------------+-------------------------------------------------+
1541|serviceDef ID |String |The service invariantUUID. It is defined in SDC. |
1542+----------------+------------------+-------------------------------------------------+
1543|templateId |String |The service Template UUID. It is defined in SDC. |
1544+----------------+------------------+-------------------------------------------------+
1545|parameters |Parameter Object |Parameter Object |
1546+----------------+------------------+-------------------------------------------------+
1547
1548Parameter Object
1549
1550+----------------------+------------------+-----------------------------------------------------+
1551|Attribute |Content |Description |
1552+======================+==================+=====================================================+
1553|globalSubscriberId |String |The subscriber id. It is defined in AAI |
1554+----------------------+------------------+-----------------------------------------------------+
1555|subscriberName |String |The subscriber name. It is defined in AAI |
1556+----------------------+------------------+-----------------------------------------------------+
1557|serviceType |String |The service type. It is defined in AAI |
1558+----------------------+------------------+-----------------------------------------------------+
1559|templateName |String |The service Template name |
1560+----------------------+------------------+-----------------------------------------------------+
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]1561|resources |Object |This field manages parameters of resources |
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1562+----------------------+------------------+-----------------------------------------------------+
1563|resourceName |String |The resource name |
1564+----------------------+------------------+-----------------------------------------------------+
1565|resouceDefId |String |The resource invariantUUID. It is defined in SDC. |
1566+----------------------+------------------+-----------------------------------------------------+
1567|resourceId |String |The resource UUID. It is defined in SDC. |
1568+----------------------+------------------+-----------------------------------------------------+
1569|nsParameters |String |Parameters for current resource object. |
1570+----------------------+------------------+-----------------------------------------------------+
1571|locationConstraints |String |The DC location info for each VNF of current service |
1572+----------------------+------------------+-----------------------------------------------------+
1573|vnfProfileId |String |VNFD id |
1574+----------------------+------------------+-----------------------------------------------------+
1575|additionalParamForNs |String |The parameter for current resource |
1576+----------------------+------------------+-----------------------------------------------------+
1577
1578
1579Response:
1580
1581+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1582|Attribute |Qualifier|Cardinality|Content|Description |
1583+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1584|serviceId |M |1 |String |Service instance ID. |
1585+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1586|operationId |M |1 |String |Service Operation ID. |
1587+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1588
1589Delete E2E service instance
1590++++++++++++++++++++++++++++
1591
1592+--------------------+-----------------------------------------------+
1593|Interface Definition|Description |
1594+====================+===============================================+
1595|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
1596+--------------------+-----------------------------------------------+
1597|Operation Type |DELETE |
1598+--------------------+-----------------------------------------------+
1599
1600Request Parameters:
1601
1602+-------------------+---------+-----------+-------+----------------------------------------+
1603|Attribute |Qualifier|Cardinality|Content|Description |
1604+===================+=========+===========+=======+========================================+
1605|globalSubscriberId |M |1 |String |The subscriber id. It is defined in AAI |
1606+-------------------+---------+-----------+-------+----------------------------------------+
1607|serviceType |M |1 |String |The service type. It is defined in AAI |
1608+-------------------+---------+-----------+-------+----------------------------------------+
1609
1610Response:
1611
1612+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1613|Attribute |Qualifier|Cardinality|Content|Description |
1614+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1615|operationId |M |1 |String |The operation id. |
1616+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1617
1618Query E2E service operation result
1619++++++++++++++++++++++++++
1620
1621+--------------------+------------------------------------------------------------------------+
1622|Interface Definition|Description |
1623+====================+========================================================================+
1624|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
1625+--------------------+------------------------------------------------------------------------+
1626|Operation Type |GET |
1627+--------------------+------------------------------------------------------------------------+
1628
1629Request Parameters:
1630
1631+--------------+---------+-----------+-------+--------------+
1632|Attribute |Qualifier|Cardinality|Content|Description |
1633+==============+=========+===========+=======+==============+
1634|serviceId |M |1 |Service instance ID. |
1635+--------------+---------+-----------+-------+--------------+
1636|operationId |M |1 |Service Operation ID. |
1637+--------------+---------+-----------+-------+--------------+
1638
1639Response:
1640
1641+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1642|Attribute |Qualifier|Cardinality|Content|Description |
1643+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1644|operation |M |1 |String |Operation object identify. |
1645+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1646|operationId |M |1 |String |Operation ID. |
1647+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1648|operation |M |1 |String |Operation type, create|delete. |
1649+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1650|result |M |1 |String |Operation result: finished, error, processing. |
1651+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1652|reason |M |1 |String |If failing, need to write fail reason. |
1653+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1654|userId |M |1 |String |Operation user ID. |
1655+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1656|operationContent |M |1 |String |The status detail of current operation which is being executing. |
1657+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1658|progress |M |1 |String |Current operation progress. |
1659+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1660|operateAt |M |1 |String |Time that it starts to execute operation. |
1661+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1662|finishedAt |M |1 |String |Time that it finished executing operation. |
1663+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1664
seshukmfffbc992017-12-18 14:36:48 +0530[diff] [blame]1665Inventory APIs
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame]1666----------------
1667
1668create or update an existing service-instance
1669+++++++++++++++++++++++++++++++++++++++++++++
1670
1671+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1672|Interface Definition|Description |
1673+====================+====================================================================================================================================================================+
1674|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1675+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1676|Operation Type |PUT |
1677+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1678
1679Request Parameters:
1680
1681+-------------------+---------+-----------+-------+-----------------------+
1682|Attribute |Qualifier|Cardinality|Content|Description |
1683+===================+=========+===========+=======+=======================+
1684|global-customer-id |M |1 |String |Global Customer ID |
1685+-------------------+---------+-----------+-------+-----------------------+
1686|service-type |M |1 |String |Service Type |
1687+-------------------+---------+-----------+-------+-----------------------+
1688|service-instance-id|M |1 |String |Service Instance ID |
1689+-------------------+---------+-----------+-------+-----------------------+
1690
1691Response:
1692
1693+---------+---------+-----------+-------+-------------------+
1694|Attribute|Qualifier|Cardinality|Content|Description |
1695+---------+---------+-----------+-------+-------------------+
1696|HTTP code|M |1 |Integer|HTTP response code |
1697+---------+---------+-----------+-------+-------------------+
1698
1699delete an existing service-instance
1700+++++++++++++++++++++++++++++++++++
1701
1702+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1703|Interface Definition|Description |
1704+====================+====================================================================================================================================================================+
1705|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1706+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1707|Operation Type |DELETE |
1708+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1709
1710Request Parameters:
1711
1712+-------------------+---------+-----------+-------+-----------------------+
1713|Attribute |Qualifier|Cardinality|Content|Description |
1714+===================+=========+===========+=======+=======================+
1715|global-customer-id |M |1 |String |Global Customer ID |
1716+-------------------+---------+-----------+-------+-----------------------+
1717|service-type |M |1 |String |Service Type |
1718+-------------------+---------+-----------+-------+-----------------------+
1719|service-instance-id|M |1 |String |Service Instance ID |
1720+-------------------+---------+-----------+-------+-----------------------+
1721
1722Response:
1723
1724+---------+---------+-----------+-------+-------------------+
1725|Attribute|Qualifier|Cardinality|Content|Description |
1726+---------+---------+-----------+-------+-------------------+
1727|HTTP code|M |1 |Integer|HTTP response code |
1728+---------+---------+-----------+-------+-------------------+
1729
1730get service-instances
1731+++++++++++++++++++++
1732
1733+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1734|Interface Definition|Description |
1735+====================+=============================================================================================================================+
1736|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
1737+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1738|Operation Type |GET |
1739+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1740
1741Request Parameters:
1742
1743+-------------------+---------+-----------+-------+-----------------------+
1744|Attribute |Qualifier|Cardinality|Content|Description |
1745+===================+=========+===========+=======+=======================+
1746|global-customer-id |M |1 |String |Global Customer ID |
1747+-------------------+---------+-----------+-------+-----------------------+
1748|service-type |M |1 |String |Service Type |
1749+-------------------+---------+-----------+-------+-----------------------+
1750
1751Response:
1752
1753+-----------------+---------+-----------+----------------+-------------------+
1754|Attribute |Qualifier|Cardinality|Content |Description |
1755+-----------------+---------+-----------+----------------+-------------------+
1756|service-instances|M |1 |ServiceInstances|Service Instances |
1757+-----------------+---------+-----------+----------------+-------------------+
1758
1759get service-instance
1760++++++++++++++++++++
1761
1762+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1763|Interface Definition|Description |
1764+====================+====================================================================================================================================================================+
1765|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1766+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1767|Operation Type |GET |
1768+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1769
1770Request Parameters:
1771
1772+-------------------+---------+-----------+-------+-----------------------+
1773|Attribute |Qualifier|Cardinality|Content|Description |
1774+===================+=========+===========+=======+=======================+
1775|global-customer-id |M |1 |String |Global Customer ID |
1776+-------------------+---------+-----------+-------+-----------------------+
1777|service-type |M |1 |String |Service Type |
1778+-------------------+---------+-----------+-------+-----------------------+
1779|service-instance-id|M |1 |String |Service instance ID |
1780+-------------------+---------+-----------+-------+-----------------------+
1781
1782Response:
1783
1784+-----------------+---------+-----------+----------------+-------------------+
1785|Attribute |Qualifier|Cardinality|Content |Description |
1786+-----------------+---------+-----------+----------------+-------------------+
1787|service-instance |M |1 |ServiceInstance |Service Instance |
1788+-----------------+---------+-----------+----------------+-------------------+
1789
1790see node definition for valid relationships
1791+++++++++++++++++++++++++++++++++++++++++++
1792
1793+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1794|Interface Definition|Description |
1795+====================+===================================================================================================================================================================================================+
1796|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
1797+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1798|Operation Type |PUT |
1799+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1800
1801Request Parameters:
1802
1803+-------------------+---------+-----------+-------+-----------------------+
1804|Attribute |Qualifier|Cardinality|Content|Description |
1805+===================+=========+===========+=======+=======================+
1806|global-customer-id |M |1 |String |Global Customer ID |
1807+-------------------+---------+-----------+-------+-----------------------+
1808|service-type |M |1 |String |Service Type |
1809+-------------------+---------+-----------+-------+-----------------------+
1810|service-instance-id|M |1 |String |Service instance ID |
1811+-------------------+---------+-----------+-------+-----------------------+
1812
1813Response:
1814
1815+---------+---------+-----------+-------+-------------------+
1816|Attribute|Qualifier|Cardinality|Content|Description |
1817+---------+---------+-----------+-------+-------------------+
1818|HTTP code|M |1 |Integer|HTTP response code |
1819+---------+---------+-----------+-------+-------------------+
1820
1821delete an existing relationship
1822+++++++++++++++++++++++++++++++
1823
1824+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1825|Interface Definition|Description |
1826+====================+===================================================================================================================================================================================================+
1827|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
1828+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1829|Operation Type |DELETE |
1830+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1831
1832Request Parameters:
1833
1834+-------------------+---------+-----------+-------+-----------------------+
1835|Attribute |Qualifier|Cardinality|Content|Description |
1836+===================+=========+===========+=======+=======================+
1837|global-customer-id |M |1 |String |Global Customer ID |
1838+-------------------+---------+-----------+-------+-----------------------+
1839|service-type |M |1 |String |Service Type |
1840+-------------------+---------+-----------+-------+-----------------------+
1841|service-instance-id|M |1 |String |Service instance ID |
1842+-------------------+---------+-----------+-------+-----------------------+
1843
1844Response:
1845
1846+---------+---------+-----------+-------+-------------------+
1847|Attribute|Qualifier|Cardinality|Content|Description |
1848+---------+---------+-----------+-------+-------------------+
1849|HTTP code|M |1 |Integer|HTTP response code |
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]1850+---------+---------+-----------+-------+-------------------+
1851
1852
1853VFC APIs
1854---------
1855
1856Create NS
1857+++++++++++
1858
1859+--------------------+-------------------+
1860|Interface Definition|Description |
1861+====================+===================+
1862|URI |/ns |
1863+--------------------+-------------------+
1864|Operation Type |POST |
1865+--------------------+-------------------+
1866|Content-Type |application/json |
1867+--------------------+-------------------+
1868
1869Request Parameters:
1870
1871+-------------------+---------+-----------+-------+-----------------------+
1872|Attribute |Qualifier|Cardinality|Content|Description |
1873+===================+=========+===========+=======+=======================+
1874|context |M |1 |Object |Context |
1875+-------------------+---------+-----------+-------+-----------------------+
1876|csarId |M |1 |String |csarId |
1877+-------------------+---------+-----------+-------+-----------------------+
1878|nsName |M |1 |String |Name of the NS |
1879+-------------------+---------+-----------+-------+-----------------------+
1880|description |M |1 |String |description |
1881+-------------------+---------+-----------+-------+-----------------------+
1882
1883Response:
1884
1885+-----------------+---------+-----------+----------------+-------------------+
1886|Attribute |Qualifier|Cardinality|Content |Description |
1887+-----------------+---------+-----------+----------------+-------------------+
1888|nsInstanceId |M |1 |String |nsInstanceId |
1889+-----------------+---------+-----------+----------------+-------------------+
1890
1891Get NS
1892+++++++
1893
1894+--------------------+-------------------+
1895|Interface Definition|Description |
1896+====================+===================+
1897|URI |/ns |
1898+--------------------+-------------------+
1899|Operation Type |GET |
1900+--------------------+-------------------+
1901|Content-Type |application/json |
1902+--------------------+-------------------+
1903
1904Response:
1905
1906+-----------------+---------+-----------+----------------+-------------------+
1907|Attribute |Qualifier|Cardinality|Content |Description |
1908+-----------------+---------+-----------+----------------+-------------------+
1909|nsInstanceId |M |1 |String |nsInstanceId |
1910+-----------------+---------+-----------+----------------+-------------------+
1911|nsName |M |1 |String |The name of ns |
1912+-----------------+---------+-----------+----------------+-------------------+
1913|description |M |1 |String |description |
1914+-----------------+---------+-----------+----------------+-------------------+
1915|nsdId |M |1 |String |ID of ns |
1916+-----------------+---------+-----------+----------------+-------------------+
1917|vnfInfo |M |1 |Array |Vnf information |
1918+-----------------+---------+-----------+----------------+-------------------+
1919|vlInfo |M |1 |Array |vl information |
1920+-----------------+---------+-----------+----------------+-------------------+
1921|vnffgInfo |M |1 |Array |vnffg information |
1922+-----------------+---------+-----------+----------------+-------------------+
1923|nsState |M |1 |String |state of ns |
1924+-----------------+---------+-----------+----------------+-------------------+
1925
1926vnfInfo Object:
1927
1928+-----------------+---------+-----------+----------------+-------------------+
1929|Attribute |Qualifier|Cardinality|Content |Description |
1930+-----------------+---------+-----------+----------------+-------------------+
1931|vnfInstanceId |M |1 |String |vnfInstanceId |
1932+-----------------+---------+-----------+----------------+-------------------+
1933|vnfInstanceName |M |1 |String |vnfInstanceName |
1934+-----------------+---------+-----------+----------------+-------------------+
1935|vnfdId |M |1 |String |vnfdId |
1936+-----------------+---------+-----------+----------------+-------------------+
1937
1938vlInfo Object:
1939
1940+----------------------+---------+-----------+----------------+-------------------+
1941|Attribute |Qualifier|Cardinality|Content |Description |
1942+----------------------+---------+-----------+----------------+-------------------+
1943|vlInstanceId |M |1 |String |vlInstanceId |
1944+----------------------+---------+-----------+----------------+-------------------+
1945|vlInstanceName |M |1 |String |vlInstanceName |
1946+----------------------+---------+-----------+----------------+-------------------+
1947|vldId |M |1 |String |vldId |
1948+----------------------+---------+-----------+----------------+-------------------+
1949|relatedCpInstanceId |M |1 |Array |relatedCpInstanceId|
1950+----------------------+---------+-----------+----------------+-------------------+
1951
1952relatedCpInstanceId Array:
1953
1954+----------------------+---------+-----------+----------------+-------------------+
1955|Attribute |Qualifier|Cardinality|Content |Description |
1956+----------------------+---------+-----------+----------------+-------------------+
1957|cpInstanceId |M |1 |String |cpInstanceId |
1958+----------------------+---------+-----------+----------------+-------------------+
1959|cpInstanceName |M |1 |String |cpInstanceName |
1960+----------------------+---------+-----------+----------------+-------------------+
1961|cpdId |M |1 |String |cpdId |
1962+----------------------+---------+-----------+----------------+-------------------+
1963
1964vnffgInfo Array:
1965
1966+----------------------+---------+-----------+----------------+-------------------+
1967|Attribute |Qualifier|Cardinality|Content |Description |
1968+----------------------+---------+-----------+----------------+-------------------+
1969|vnffgInstanceId |M |1 |String |vnffgInstanceId |
1970+----------------------+---------+-----------+----------------+-------------------+
1971|vnfId |M |1 |String |vnfId |
1972+----------------------+---------+-----------+----------------+-------------------+
1973|pnfId |M |1 |String |pnfId |
1974+----------------------+---------+-----------+----------------+-------------------+
1975|virtualLinkId |M |1 |Array |virtualLinkId |
1976+----------------------+---------+-----------+----------------+-------------------+
1977|cpId |M |1 |Array |cpId |
1978+----------------------+---------+-----------+----------------+-------------------+
1979|nfp |M |1 |Array |nfp |
1980+----------------------+---------+-----------+----------------+-------------------+
1981
1982Instantiate NS
1983+++++++++++++++
1984
1985+--------------------+-------------------------------------+
1986|Interface Definition|Description |
1987+====================+=====================================+
1988|URI |/ns/{nsInstanceId}/Instantiate |
1989+--------------------+-------------------------------------+
1990|Operation Type |POST |
1991+--------------------+-------------------------------------+
1992|Content-Type |application/json |
1993+--------------------+-------------------------------------+
1994
1995Request Parameters:
1996
1997+----------------------+---------+-----------+-------+-----------------------+
1998|Attribute |Qualifier|Cardinality|Content|Description |
1999+======================+=========+===========+=======+=======================+
2000|LocationConstraints |M |1 |Array |LocationConstraints |
2001+----------------------+---------+-----------+-------+-----------------------+
2002|additionalParamForNs |M |1 |String |additionalParamForNs |
2003+----------------------+---------+-----------+-------+-----------------------+
2004|nsInstanceId |M |1 |String |nsInstanceId |
2005+----------------------+---------+-----------+-------+-----------------------+
2006
2007LocationConstraints Array:
2008
2009+----------------------+---------+-----------+-------+-----------------------+
2010|Attribute |Qualifier|Cardinality|Content|Description |
2011+======================+=========+===========+=======+=======================+
2012|vnfProfileId |M |1 |String |vnfProfileId |
2013+----------------------+---------+-----------+-------+-----------------------+
2014|vimid |M |1 |String |vimid |
2015+----------------------+---------+-----------+-------+-----------------------+
2016
2017Response:
2018
2019+--------------+---------+-----------+-------+-----------------------+
2020|Attribute |Qualifier|Cardinality|Content|Description |
2021+==============+=========+===========+=======+=======================+
2022|jobId |M |1 |String |jobId |
2023+--------------+---------+-----------+-------+-----------------------+
2024
2025Terminate NS
2026+++++++++++++++
2027
2028+--------------------+-------------------------------------+
2029|Interface Definition|Description |
2030+====================+=====================================+
2031|URI |/ns/{ns_instance_id}/terminate |
2032+--------------------+-------------------------------------+
2033|Operation Type |POST |
2034+--------------------+-------------------------------------+
2035|Content-Type |application/json |
2036+--------------------+-------------------------------------+
2037
2038Request Parameters:
2039
2040+----------------------------+---------+-----------+-------+-----------------------------+
2041|Attribute |Qualifier|Cardinality|Content|Description |
2042+============================+=========+===========+=======+=============================+
2043|terminationType |M |1 |String |terminationType |
2044+----------------------------+---------+-----------+-------+-----------------------------+
2045|gracefulTerminationTimeout |M |1 |String |gracefulTerminationTimeout |
2046+----------------------------+---------+-----------+-------+-----------------------------+
2047|nsInstanceId |M |1 |String |nsInstanceId |
2048+----------------------------+---------+-----------+-------+-----------------------------+
2049
2050Response:
2051
2052+--------------+---------+-----------+-------+-----------------------+
2053|Attribute |Qualifier|Cardinality|Content|Description |
2054+==============+=========+===========+=======+=======================+
2055|jobId |M |1 |String |jobId |
2056+--------------+---------+-----------+-------+-----------------------+
2057
2058Delete NS
2059+++++++++++++++
2060
2061+--------------------+-------------------------------------+
2062|Interface Definition|Description |
2063+====================+=====================================+
2064|URI |/ns/{ns_instance_id} |
2065+--------------------+-------------------------------------+
2066|Operation Type |DELETE |
2067+--------------------+-------------------------------------+
2068
2069Request Parameters:
2070
2071+----------------------------+---------+-----------+-------+-----------------------------+
2072|Attribute |Qualifier|Cardinality|Content|Description |
2073+============================+=========+===========+=======+=============================+
2074|nsInstanceId |M |1 |String |nsInstanceId |
2075+----------------------------+---------+-----------+-------+-----------------------------+
2076
2077MultiVIM API
2078----------------
2079Get token
2080++++++++++
2081
2082https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
2083
2084+--------------------+-----------------------------------------------------------------------------------------------+
2085|Interface Definition|Description |
2086+====================+===============================================================================================+
2087|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens |
2088+--------------------+-----------------------------------------------------------------------------------------------+
2089|Operation Type |POST |
2090+--------------------+-----------------------------------------------------------------------------------------------+
2091|Content-Type |application/json |
2092+--------------------+-----------------------------------------------------------------------------------------------+
2093
2094Request Body:
2095
2096+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2097|Attribute |Qualifier|Cardinality|Content |Description |
2098+================+=========+===========+==========================+================================================================================================================================================+
2099|nocatalog |O |1 |string |The authentication response excludes the service catalog. By default, the response includes the service catalog. |
2100+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2101|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.|
2102+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2103|auth |M |1 |object |An auth object. |
2104+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2105|user |M |1 |object |A user object. |
2106+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2107|scope |O |1 |string |The authorization scope, including either a project or a domain |
2108+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2109|password |M |1 |object |The password object, contains the authentication information. |
2110+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2111|id |O |1 |string |The ID of the user. Required if you do not specify the user name. |
2112+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2113|identity |M |1 |object |An identity object. |
2114+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2115|methods |M |1 |array |The authentication method. For password authentication, specify password. |
2116+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2117
2118Response:
2119
2120+-------------------------+------------------+--------------------------------------------------------------------------+
2121|Attribute |Content |Description |
2122+=========================+==================+==========================================================================+
2123|X-Subject-Token |String |The authentication token. |
2124+-------------------------+------------------+--------------------------------------------------------------------------+
2125|domain |object |A domain object, containing: |
2126+-------------------------+------------------+--------------------------------------------------------------------------+
2127|region_id |String |The ID of the region that contains the service endpoint. |
2128+-------------------------+------------------+--------------------------------------------------------------------------+
2129|methods |array |The authentication method. For password authentication, specify password. |
2130+-------------------------+------------------+--------------------------------------------------------------------------+
2131|roles |array |A list of role objects, each containing: |
2132+-------------------------+------------------+--------------------------------------------------------------------------+
2133|url |String |The endpoint URL. |
2134+-------------------------+------------------+--------------------------------------------------------------------------+
2135|region |String |The geographic location of the service endpoint. |
2136+-------------------------+------------------+--------------------------------------------------------------------------+
2137|token |object |A token object. |
2138+-------------------------+------------------+--------------------------------------------------------------------------+
2139|expires_at |String |The date and time when the token expires. |
2140+-------------------------+------------------+--------------------------------------------------------------------------+
2141|project |object |A project object, containing: |
2142+-------------------------+------------------+--------------------------------------------------------------------------+
2143|issued_at |String |The date and time when the token was issued. |
2144+-------------------------+------------------+--------------------------------------------------------------------------+
2145|catalog |array |A catalog object. |
2146+-------------------------+------------------+--------------------------------------------------------------------------+
2147|extras |object |A set of metadata key and value pairs, if any. |
2148+-------------------------+------------------+--------------------------------------------------------------------------+
2149|user |object |A user object. |
2150+-------------------------+------------------+--------------------------------------------------------------------------+
2151|audit_ids |array |A list of one or two audit IDs. |
2152+-------------------------+------------------+--------------------------------------------------------------------------+
2153|interface |String |The interface type, which describes the visibility of the endpoint. |
2154+-------------------------+------------------+--------------------------------------------------------------------------+
2155|endpoints |array |A list of endpoint objects. |
2156+-------------------------+------------------+--------------------------------------------------------------------------+
2157|type |String |The endpoint type. |
2158+-------------------------+------------------+--------------------------------------------------------------------------+
2159|id |String |The ID of the user. Required if you do not specify the user name. |
2160+-------------------------+------------------+--------------------------------------------------------------------------+
2161|name |String |The user name. |
2162+-------------------------+------------------+--------------------------------------------------------------------------+
2163
2164Create stack
2165+++++++++++++
2166
2167https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
2168
2169+--------------------+-----------------------------------------------------------------------------------------------+
2170|Interface Definition|Description |
2171+====================+===============================================================================================+
2172|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks |
2173+--------------------+-----------------------------------------------------------------------------------------------+
2174|Operation Type |POST |
2175+--------------------+-----------------------------------------------------------------------------------------------+
2176|Content-Type |application/json |
2177+--------------------+-----------------------------------------------------------------------------------------------+
2178
2179Request Body:
2180
2181+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2182|Attribute |Qualifier|Cardinality|Content |Description |
2183+==================+=========+===========+==========================+=================================================================================================+
2184|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2185+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2186|disable_rollback |O |1 |boolean |Enables or disables deletion of all stack resources when stack creation fails. |
2187+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2188|environment |O |1 |object |A JSON environment for the stack. |
2189+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2190|files |O |1 |object |Supplies the contents of files referenced in the template or the environment. |
2191+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2192|parameters |O |1 |object |Supplies arguments for parameters defined in the stack template. |
2193+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2194|stack_name |M |1 |string |A name for the stack. |
2195+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2196|tags |O |1 |string |One or more simple string tags to associate with the stack. |
2197+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2198|template |O |1 |object |The stack template on which to perform the operation. |
2199+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2200|template_url |O |1 |string |A URI to the location containing the stack template on which to perform the operation. |
2201+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2202|timeout_mins |O |1 |integer |The timeout for stack creation in minutes. |
2203+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2204
2205Response:
2206
2207+-------------------------+------------------+--------------------------------------------------------------------------+
2208|Attribute |Content |Description |
2209+=========================+==================+==========================================================================+
2210|location |String |For asynchronous resource operations. |
2211+-------------------------+------------------+--------------------------------------------------------------------------+
2212|X-Openstack-Reqeuest-Id |object |A domain object, containing: |
2213+-------------------------+------------------+--------------------------------------------------------------------------+
2214|stack |String |The ID of the region that contains the service endpoint. |
2215+-------------------------+------------------+--------------------------------------------------------------------------+
2216|id |String |The authentication method. For password authentication, specify password. |
2217+-------------------------+------------------+--------------------------------------------------------------------------+
2218|links |String |The authentication method. For password authentication, specify password. |
2219+-------------------------+------------------+--------------------------------------------------------------------------+
2220
2221Get stack
2222+++++++++++++
2223
2224https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2225
2226+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2227|Interface Definition|Description |
2228+====================+=======================================================================================================================+
2229|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2230+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2231|Operation Type |GET |
2232+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2233|Content-Type |application/json |
2234+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2235
2236Request Body:
2237
2238+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2239|Attribute |Qualifier|Cardinality|Content |Description |
2240+==================+=========+===========+==========================+=================================================================================================+
2241|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2242+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2243|stack_name |M |1 |string |The name of a stack. |
2244+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2245|stack_id |M |1 |string |The UUID of the stack. |
2246+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2247|resolve_outputs |O |1 |boolean |A boolean indicating whether the outputs section of a stack should be resolved. |
2248+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2249
2250Response:
2251
2252+-------------------------+------------------+------------------------------------------------------------------------------+
2253|Attribute |Content |Description |
2254+=========================+==================+==============================================================================+
2255|X-Openstack-Reqeuest-Id |String |A unique ID for tracking service request. |
2256+-------------------------+------------------+------------------------------------------------------------------------------+
2257|stack |Object |The stack object. |
2258+-------------------------+------------------+------------------------------------------------------------------------------+
2259|capabilities |array |List of stack capabilities for stack. |
2260+-------------------------+------------------+------------------------------------------------------------------------------+
2261|creation_time |String |The date and time when the resource was created. |
2262+-------------------------+------------------+------------------------------------------------------------------------------+
2263|deletion_time |String |The date and time when the resource was (soft-) deleted. |
2264+-------------------------+------------------+------------------------------------------------------------------------------+
2265|description |String |The description of the stack resource. |
2266+-------------------------+------------------+------------------------------------------------------------------------------+
2267|disable_rollback |boolean |Whether deletion of all stack resources when stack creation fails is enabled. |
2268+-------------------------+------------------+------------------------------------------------------------------------------+
2269|id |String |The UUID of the stack. |
2270+-------------------------+------------------+------------------------------------------------------------------------------+
2271|links |array |A list of URLs for the stack. |
2272+-------------------------+------------------+------------------------------------------------------------------------------+
2273|notification_topics |array |List of notification topics for stack. |
2274+-------------------------+------------------+------------------------------------------------------------------------------+
2275|outputs |array |A list of stack outputs. |
2276+-------------------------+------------------+------------------------------------------------------------------------------+
2277|parameters |object | A group of key-value pairs |
2278+-------------------------+------------------+------------------------------------------------------------------------------+
2279|parent |String |The stack ID of the parent stack, if this is a nested stack. |
2280+-------------------------+------------------+------------------------------------------------------------------------------+
2281|stack_name |String |A name for the stack. |
2282+-------------------------+------------------+------------------------------------------------------------------------------+
2283|stack_owner |String |The owner of the stack. |
2284+-------------------------+------------------+------------------------------------------------------------------------------+
2285|stack_status |String |The status of the stack. |
2286+-------------------------+------------------+------------------------------------------------------------------------------+
2287|stack_status_reason |String |The reason for the current status of the stack. |
2288+-------------------------+------------------+------------------------------------------------------------------------------+
2289|stack_user_project_id |String |The project UUID of the stack user. |
2290+-------------------------+------------------+------------------------------------------------------------------------------+
2291|tags |array |The stack tags. |
2292+-------------------------+------------------+------------------------------------------------------------------------------+
2293|template_description |String |The description of the stack template. |
2294+-------------------------+------------------+------------------------------------------------------------------------------+
2295|timeout_mins |integer |The timeout for stack creation in minutes. |
2296+-------------------------+------------------+------------------------------------------------------------------------------+
2297|updated_time |String |The date and time when the object was updated. |
2298+-------------------------+------------------+------------------------------------------------------------------------------+
2299
2300Delete stack
2301+++++++++++++
2302
2303https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2304
2305+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2306|Interface Definition|Description |
2307+====================+=======================================================================================================================+
2308|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2309+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2310|Operation Type |DELETE |
2311+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2312|Content-Type |application/json |
2313+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2314
2315Request Body:
2316
2317+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2318|Attribute |Qualifier|Cardinality|Content |Description |
2319+==================+=========+===========+==========================+=================================================================================================+
2320|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2321+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2322|stack_name |M |1 |string |The name of a stack. |
2323+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2324|stack_id |M |1 |string |The UUID of the stack. |
2325+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2326
2327Create server
2328+++++++++++++
2329
2330https://developer.openstack.org/api-ref/compute/#create-server
2331
2332+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2333|Interface Definition|Description |
2334+====================+=======================================================================================================================+
2335|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers |
2336+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2337|Operation Type |POST |
2338+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2339|Content-Type |application/json |
2340+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2341
2342Request Body:
2343
2344+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2345|Attribute |Qualifier|Cardinality|Content |Description |
2346+================================================+=========+===========+==========================+=================================================================================================+
2347|server |M |1 |object |A server object. |
2348+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2349|name |M |1 |string |The server name. |
2350+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2351|flavorRef |M |1 |string |The flavor reference, as an ID (including a UUID) or full URL |
2352+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2353|imageRef |M |1 |string |The UUID of the image to use for your server instance |
2354+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2355|security_groups |O |1 |array |One or more security groups. |
2356+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2357|metadata |O |1 |object |Metadata key and value pairs. |
2358+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2359|accessIPv4 |O |1 |string |IPv4 address that should be used to access this server. |
2360+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2361|accessIPv6 |O |1 |string |IPv6 address that should be used to access this server. |
2362+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2363|adminPass |O |1 |string |The administrative password of the server. |
2364+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2365|user_data |O |1 |string |Configuration information or scripts to use upon launch. |
2366+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2367|availability_zone |O |1 |string |The availability zone from which to launch the server. |
2368+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2369|networks |M |1 |object |A networks object. |
2370+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2371|networks.uuid |O |1 |string |To provision the server instance with a NIC for a network |
2372+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2373|networks.port |O |1 |string |To provision the server instance with a NIC for an already existing port |
2374+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2375|networks.fixed_ip |O |1 |string |A fixed IPv4 address for the NIC |
2376+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2377|networks.tag |O |1 |string |A device role tag that can be applied to a network interface. |
2378+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2379|personality |O |1 |array |The file path and contents, text only, to inject into the server at launch. |
2380+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2381|block_device_mapping_v2 |O |1 |array |Enables fine grained control of the block device mapping for an instance. |
2382+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2383|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. |
2384+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2385|block_device_mapping_v2.source_type |M |1 |string |The source type of the volume. |
2386+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2387|block_device_mapping_v2.destination_type |O |1 |string |Defines where the volume comes from. |
2388+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2389|block_device_mapping_v2.delete_on_termination |O |1 |string |To delete the boot volume when the server is destroyed, specify true. |
2390+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2391|block_device_mapping_v2.guest_format |M |1 |string |Specifies the guest server disk file system format, such as ephemeral or swap. |
2392+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2393|block_device_mapping_v2.boot_index |M |1 |string |Defines the order in which a hypervisor tries devices |
2394+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2395|block_device_mapping_v2.uuid |O |1 |string |This is the uuid of source resource. |
2396+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2397|block_device_mapping_v2.tag |O |1 |string |A device role tag that can be applied to a block device. |
2398+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2399|block_device_mapping_v2.disk_bus |O |1 |string |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter |
2400+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2401|config_drive |O |1 |boolean |Indicates whether a configuration drive enables metadata injection. |
2402+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2403|key_name |O |1 |string |Key pair name. |
2404+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2405|os:scheduler_hints |O |1 |object |The dictionary of data to send to the scheduler. |
2406+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2407|OS-DCF:diskConfig |O |1 |string |Controls how the API partitions the disk when you create, rebuild, or resize servers. |
2408+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2409|description |O |1 |string |A free form description of the server. |
2410+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2411|tags |O |1 |array |A list of tags. |
2412+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2413
2414Response:
2415
2416+-------------------------+------------------+------------------------------------------------------------------------------+
2417|Attribute |Content |Description |
2418+=========================+==================+==============================================================================+
2419|server |object |A server object. |
2420+-------------------------+------------------+------------------------------------------------------------------------------+
2421|id |String |The UUID of the server. |
2422+-------------------------+------------------+------------------------------------------------------------------------------+
2423|links |array |Links to the resources in question. |
2424+-------------------------+------------------+------------------------------------------------------------------------------+
2425|OS-DCF:diskConfig |String |Disk configuration. |
2426+-------------------------+------------------+------------------------------------------------------------------------------+
2427|security_groups |array |One or more security groups objects. |
2428+-------------------------+------------------+------------------------------------------------------------------------------+
2429|security_groups.name |String |The security group name. |
2430+-------------------------+------------------+------------------------------------------------------------------------------+
2431|adminPass |String |The administrative password for the server. |
2432+-------------------------+------------------+------------------------------------------------------------------------------+
2433
2434Delete server
2435+++++++++++++
2436
2437https://developer.openstack.org/api-ref/compute/#delete-server
2438
2439+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2440|Interface Definition|Description |
2441+====================+=======================================================================================================================+
2442|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id} |
2443+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2444|Operation Type |DELETE |
2445+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2446|Content-Type |application/json |
2447+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2448
2449Request Body:
2450
2451+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2452|Attribute |Qualifier|Cardinality|Content |Description |
2453+==================+=========+===========+==========================+=================================================================================================+
2454|server_id |M |1 |string |The UUID of the server. |
2455+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2456
2457Create Keypair
2458+++++++++++++++
2459
2460https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
2461
2462+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2463|Interface Definition|Description |
2464+====================+=======================================================================================================================+
2465|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs |
2466+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2467|Operation Type |POST |
2468+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2469|Content-Type |application/json |
2470+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2471
2472Request Body:
2473
2474+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2475|Attribute |Qualifier|Cardinality|Content |Description |
2476+==================+=========+===========+==========================+=================================================================================================+
2477|keypair |M |1 |Object |Keypair object |
2478+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2479|name |M |1 |string |A name for the keypair which will be used to reference it later. |
2480+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2481|public_key |O |1 |string |The public ssh key to import. If you omit this value, a keypair is generated for you. |
2482+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2483|type |O |1 |string |The type of the keypair. |
2484+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2485|user_id |O |1 |string |The user_id for a keypair. |
2486+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2487
2488Response:
2489
2490+-----------------+------------------+------------------------------------------------------------------------------+
2491|Attribute |Content |Description |
2492+=================+==================+==============================================================================+
2493|keypair |object |Keypair object |
2494+-----------------+------------------+------------------------------------------------------------------------------+
2495|name |String |A name for the keypair which will be used to reference it later. |
2496+-----------------+------------------+------------------------------------------------------------------------------+
2497|public_key |String |The keypair public key. |
2498+-----------------+------------------+------------------------------------------------------------------------------+
2499|fingerprint |String |The fingerprint for the keypair. |
2500+-----------------+------------------+------------------------------------------------------------------------------+
2501|user_id |String |The user_id for a keypair. |
2502+-----------------+------------------+------------------------------------------------------------------------------+
2503|private_key |String |If you do not provide a public key on create |
2504+-----------------+------------------+------------------------------------------------------------------------------+
2505|type |String |The type of the keypair. |
2506+-----------------+------------------+------------------------------------------------------------------------------+
2507
2508Delete Keypair
2509+++++++++++++++
2510
2511https://developer.openstack.org/api-ref/compute/#delete-keypair
2512
2513+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2514|Interface Definition|Description |
2515+====================+=======================================================================================================================+
2516|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id} |
2517+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2518|Operation Type |DELETE |
2519+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2520|Content-Type |application/json |
2521+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2522
2523Request Body:
2524
2525+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2526|Attribute |Qualifier|Cardinality|Content |Description |
2527+==================+=========+===========+==========================+=================================================================================================+
2528|keypair_name |M |1 |String |The keypair name. |
2529+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2530|user_id |O |1 |String |This allows administrative users to operate key-pairs of specified user ID. |
2531+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2532
2533Create Network
2534+++++++++++++++
2535
2536https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
2537
2538+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2539|Interface Definition|Description |
2540+====================+=======================================================================================================================+
2541|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks |
2542+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2543|Operation Type |POST |
2544+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2545|Content-Type |application/json |
2546+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2547
2548Request Body:
2549
2550+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2551|Attribute |Qualifier|Cardinality|Content |Description |
2552+============================+=========+===========+==========================+=================================================================================================+
2553|network |M |1 |Object |A network object. |
2554+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2555|admin_state_up |O |1 |boolean |The administrative state of the network, which is up (true) or down (false). |
2556+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2557|dns_domain |O |1 |string |A valid DNS domain. |
2558+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2559|mtu |O |1 |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2560+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2561|name |O |1 |string |Human-readable name of the network. |
2562+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2563|port_security_enabled |O |1 |boolean |The port security status of the network. |
2564+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2565|project_id |O |1 |string |The ID of the project that owns the resource. |
2566+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2567|provider:network_type |O |1 |string |The type of physical network that this network should be mapped to. |
2568+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2569|provider:physical_network |O |1 |string |The physical network where this network should be implemented. |
2570+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2571|provider:segmentation_id |O |1 |integer |The ID of the isolated segment on the physical network. |
2572+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2573|qos_policy_id |O |1 |string |The ID of the QoS policy. |
2574+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2575|router:external |O |1 |boolean |Indicates whether this network can provide floating IPs via a router. |
2576+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2577|segments |O |1 |array |A list of provider segment objects. |
2578+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2579|shared |O |1 |boolean |Indicates whether this network is shared across all tenants. |
2580+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2581|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2582+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2583|vlan_transparent |O |1 |boolean |Indicates the VLAN transparency mode of the network, |
2584+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2585|description |O |1 |string |A human-readable description for the resource. |
2586+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2587
2588Response:
2589
2590+-----------------------------+------------------+------------------------------------------------------------------------------+
2591|Attribute |Content |Description |
2592+=============================+==================+==============================================================================+
2593|network |object |A network object. |
2594+-----------------------------+------------------+------------------------------------------------------------------------------+
2595|admin_state_up |boolean |The administrative state of the network, which is up (true) or down (false). |
2596+-----------------------------+------------------+------------------------------------------------------------------------------+
2597|availability_zone_hints |array |The availability zone candidate for the network. |
2598+-----------------------------+------------------+------------------------------------------------------------------------------+
2599|availability_zones |array |The availability zone for the network. |
2600+-----------------------------+------------------+------------------------------------------------------------------------------+
2601|dns_domain |String |A valid DNS domain. |
2602+-----------------------------+------------------+------------------------------------------------------------------------------+
2603|id |String |The ID of the network. |
2604+-----------------------------+------------------+------------------------------------------------------------------------------+
2605|mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2606+-----------------------------+------------------+------------------------------------------------------------------------------+
2607|name |String |Human-readable name of the network. |
2608+-----------------------------+------------------+------------------------------------------------------------------------------+
2609|port_security_enabled |boolean |The port security status of the network. |
2610+-----------------------------+------------------+------------------------------------------------------------------------------+
2611|project_id |String |The ID of the project. |
2612+-----------------------------+------------------+------------------------------------------------------------------------------+
2613|provider:network_type |String |The type of physical network that this network is mapped to. |
2614+-----------------------------+------------------+------------------------------------------------------------------------------+
2615|provider:physical_network |String |The physical network where this network is implemented. |
2616+-----------------------------+------------------+------------------------------------------------------------------------------+
2617|provider:segmentation_id |integer |The ID of the isolated segment on the physical network. |
2618+-----------------------------+------------------+------------------------------------------------------------------------------+
2619|qos_policy_id |String |The ID of the QoS policy. |
2620+-----------------------------+------------------+------------------------------------------------------------------------------+
2621|revision_number |integer |The revision number of the resource. |
2622+-----------------------------+------------------+------------------------------------------------------------------------------+
2623|router:external |boolean |Indicates whether this network can provide floating IPs via a router. |
2624+-----------------------------+------------------+------------------------------------------------------------------------------+
2625|segments |array |A list of provider segment objects. |
2626+-----------------------------+------------------+------------------------------------------------------------------------------+
2627|shared |boolean |Indicates whether this network is shared across all tenants. |
2628+-----------------------------+------------------+------------------------------------------------------------------------------+
2629|status |String |The network status. Values are ACTIVE, DOWN, BUILD or ERROR. |
2630+-----------------------------+------------------+------------------------------------------------------------------------------+
2631|subnets |array |The associated subnets. |
2632+-----------------------------+------------------+------------------------------------------------------------------------------+
2633|tenant_id |String |The ID of the project. |
2634+-----------------------------+------------------+------------------------------------------------------------------------------+
2635|vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. |
2636+-----------------------------+------------------+------------------------------------------------------------------------------+
2637|description |String |A human-readable description for the resource. |
2638+-----------------------------+------------------+------------------------------------------------------------------------------+
2639
2640Delete Network
2641+++++++++++++++
2642
2643https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
2644
2645+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2646|Interface Definition|Description |
2647+====================+=======================================================================================================================+
2648|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id} |
2649+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2650|Operation Type |DELETE |
2651+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2652|Content-Type |application/json |
2653+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2654
2655Request Body:
2656
2657+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2658|Attribute |Qualifier|Cardinality|Content |Description |
2659+============================+=========+===========+==========================+==============================================================+
2660|network_id |M |1 |Object |The ID of the network. |
2661+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2662
2663Create Subnet
2664+++++++++++++++
2665
2666https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
2667
2668+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2669|Interface Definition|Description |
2670+====================+=======================================================================================================================+
2671|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets |
2672+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2673|Operation Type |POST |
2674+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2675|Content-Type |application/json |
2676+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2677
2678Request Body:
2679
2680+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2681|Attribute |Qualifier|Cardinality|Content |Description |
2682+============================+=========+===========+==========================+=================================================================================================+
2683|subnet |M |1 |string |A subnet object. |
2684+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2685|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2686+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2687|project_id |O |1 |string |The ID of the project that owns the resource. |
2688+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2689|name |O |1 |string |Human-readable name of the resource. |
2690+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2691|enable_dhcp |O |1 |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2692+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2693|network_id |M |1 |string |The ID of the network to which the subnet belongs. |
2694+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2695|dns_nameservers |O |1 |array |List of dns name servers associated with the subnet. |
2696+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2697|allocation_pools |O |1 |array |Allocation pools with start and end IP addresses for this subnet. |
2698+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2699|host_routes |O |1 |array |Additional routes for the subnet. |
2700+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2701|ip_version |M |1 |integer |The IP protocol version. Value is 4 or 6. |
2702+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2703|gateway_ip |O |1 |string |Gateway IP of this subnet. |
2704+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2705|cidr |M |1 |string |The CIDR of the subnet. |
2706+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2707|description |O |1 |string |A human-readable description for the resource. |
2708+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2709|ipv6_address_mode |O |1 |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2710+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2711|ipv6_ra_mode |O |1 |string |The IPv6 router advertisement specifies whether the networking service |
2712+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2713|segment_id |O |1 |string |The ID of a network segment the subnet is associated with. |
2714+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2715|subnetpool_id |O |1 |string |The ID of the subnet pool associated with the subnet. |
2716+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2717|use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. |
2718+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2719
2720Response:
2721
2722+-----------------------------+------------------+------------------------------------------------------------------------------+
2723|Attribute |Content |Description |
2724+=============================+==================+==============================================================================+
2725|subnet |string |A subnet object. |
2726+-----------------------------+------------------+------------------------------------------------------------------------------+
2727|id |string |The ID of the subnet. |
2728+-----------------------------+------------------+------------------------------------------------------------------------------+
2729|tenant_id |string |The ID of the project. |
2730+-----------------------------+------------------+------------------------------------------------------------------------------+
2731|project_id |string |The ID of the project. |
2732+-----------------------------+------------------+------------------------------------------------------------------------------+
2733|name |String |Human-readable name of the resource. |
2734+-----------------------------+------------------+------------------------------------------------------------------------------+
2735|enable_dhcp |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2736+-----------------------------+------------------+------------------------------------------------------------------------------+
2737|network_id |String |The ID of the network to which the subnet belongs. |
2738+-----------------------------+------------------+------------------------------------------------------------------------------+
2739|dns_nameservers |array |List of dns name servers associated with the subnet. |
2740+-----------------------------+------------------+------------------------------------------------------------------------------+
2741|allocation_pools |array |Allocation pools with start and end IP addresses for this subnet. |
2742+-----------------------------+------------------+------------------------------------------------------------------------------+
2743|host_routes |array |Additional routes for the subnet. |
2744+-----------------------------+------------------+------------------------------------------------------------------------------+
2745|ip_version |integer |The IP protocol version. Value is 4 or 6. |
2746+-----------------------------+------------------+------------------------------------------------------------------------------+
2747|gateway_ip |string |Gateway IP of this subnet. |
2748+-----------------------------+------------------+------------------------------------------------------------------------------+
2749|cidr |string |The CIDR of the subnet. |
2750+-----------------------------+------------------+------------------------------------------------------------------------------+
2751|created_at |string |Time at which the subnet has been created. |
2752+-----------------------------+------------------+------------------------------------------------------------------------------+
2753|description |string |A human-readable description for the resource. |
2754+-----------------------------+------------------+------------------------------------------------------------------------------+
2755|ipv6_address_mode |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2756+-----------------------------+------------------+------------------------------------------------------------------------------+
2757|ipv6_ra_mode |string |The IPv6 router advertisement specifies whether the networking service |
2758+-----------------------------+------------------+------------------------------------------------------------------------------+
2759|revision_number |integer |The revision number of the resource. |
2760+-----------------------------+------------------+------------------------------------------------------------------------------+
2761|service_types |string |The service types associated with the subnet. |
2762+-----------------------------+------------------+------------------------------------------------------------------------------+
2763|subnetpool_id |string |The ID of the subnet pool associated with the subnet. |
2764+-----------------------------+------------------+------------------------------------------------------------------------------+
2765|segment_id |string |The ID of a network segment the subnet is associated with. |
2766+-----------------------------+------------------+------------------------------------------------------------------------------+
2767|updated_at |string |Time at which the subnet has been updated. |
2768+-----------------------------+------------------+------------------------------------------------------------------------------+
2769
2770Delete Subnet
2771+++++++++++++++
2772
2773https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
2774
2775+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2776|Interface Definition|Description |
2777+====================+=======================================================================================================================+
2778|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id} |
2779+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2780|Operation Type |DELETE |
2781+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2782|Content-Type |application/json |
2783+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2784
2785Request Body:
2786
2787+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2788|Attribute |Qualifier|Cardinality|Content |Description |
2789+============================+=========+===========+==========================+==============================================================+
2790|subnet_id |M |1 |String |The ID of the subnet. |
2791+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2792
2793Create Port
2794+++++++++++++++
2795
2796https://developer.openstack.org/api-ref/networking/v2/#create-port
2797
2798+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2799|Interface Definition|Description |
2800+====================+=======================================================================================================================+
2801|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports |
2802+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2803|Operation Type |POST |
2804+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2805|Content-Type |application/json |
2806+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2807
2808Request Body:
2809
2810+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2811|Attribute |Qualifier|Cardinality|Content |Description |
2812+============================+=========+===========+==========================+=================================================================================================+
2813|port |M |1 |object |A port object. |
2814+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2815|admin_state_up |O |1 |boolean |The administrative state of the resource. |
2816+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2817|allowed_address_pairs |O |1 |array |A set of zero or more allowed address pairs. |
2818+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2819|binding:host_id |O |1 |string |The ID of the host where the port resides. |
2820+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2821|binding:profile |O |1 |string |A dictionary that enables the application running on the specific host |
2822+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2823|binding:vnic_type |O |1 |string |The type of vNIC which this port should be attached to. |
2824+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2825|description |O |1 |string |A human-readable description for the resource. |
2826+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2827|device_id |O |1 |string |The ID of the device that uses this port. |
2828+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2829|device_owner |O |1 |string |The entity type that uses this port. |
2830+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2831|dns_domain |O |1 |string |A valid DNS domain. |
2832+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2833|dns_name |O |1 |string |A valid DNS name. |
2834+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2835|extra_dhcp_opts |O |1 |array |A set of zero or more extra DHCP option pairs. |
2836+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2837|fixed_ips |O |1 |array |The IP addresses for the port. |
2838+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2839|mac_address |O |1 |string |The MAC address of the port. |
2840+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2841|name |O |1 |string |Human-readable name of the resource. |
2842+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2843|network_id |M |1 |string |The ID of the attached network. |
2844+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2845|port_security_enabled |O |1 |boolean |The port security status. |
2846+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2847|project_id |O |1 |string |The ID of the project that owns the resource. |
2848+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2849|security_groups |O |1 |array |The IDs of security groups applied to the port. |
2850+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2851|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2852+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2853
2854Response:
2855
2856+-----------------------------+------------------+------------------------------------------------------------------------------+
2857|Attribute |Content |Description |
2858+=============================+==================+==============================================================================+
2859|port |object |A port object. |
2860+-----------------------------+------------------+------------------------------------------------------------------------------+
2861|admin_state_up |boolean |The administrative state of the resource. |
2862+-----------------------------+------------------+------------------------------------------------------------------------------+
2863|allowed_address_pairs |array |A set of zero or more allowed address pairs. |
2864+-----------------------------+------------------+------------------------------------------------------------------------------+
2865|binding:host_id |string |The ID of the host where the port resides. |
2866+-----------------------------+------------------+------------------------------------------------------------------------------+
2867|binding:profile |String |A dictionary that enables the application running on the specific host |
2868+-----------------------------+------------------+------------------------------------------------------------------------------+
2869|binding:vif_details |object |A dictionary which contains additional information on the port. |
2870+-----------------------------+------------------+------------------------------------------------------------------------------+
2871|binding:vif_type |String |The type of which mechanism is used for the port. |
2872+-----------------------------+------------------+------------------------------------------------------------------------------+
2873|binding:vnic_type |string |The type of vNIC which this port should be attached to. |
2874+-----------------------------+------------------+------------------------------------------------------------------------------+
2875|created_at |string |Time at which port has been created. |
2876+-----------------------------+------------------+------------------------------------------------------------------------------+
2877|data_plane_status |string |Status of the underlying data plane of a port. |
2878+-----------------------------+------------------+------------------------------------------------------------------------------+
2879|description |string |A human-readable description for the resource. |
2880+-----------------------------+------------------+------------------------------------------------------------------------------+
2881|device_id |string |The ID of the device that uses this port. |
2882+-----------------------------+------------------+------------------------------------------------------------------------------+
2883|device_owner |string |The entity type that uses this port. |
2884+-----------------------------+------------------+------------------------------------------------------------------------------+
2885|dns_assignment |object |Data assigned to a port by the Networking internal DNS |
2886+-----------------------------+------------------+------------------------------------------------------------------------------+
2887|dns_domain |string |A valid DNS domain. |
2888+-----------------------------+------------------+------------------------------------------------------------------------------+
2889|dns_name |string |A valid DNS name. |
2890+-----------------------------+------------------+------------------------------------------------------------------------------+
2891|extra_dhcp_opts |array |A set of zero or more extra DHCP option pairs. |
2892+-----------------------------+------------------+------------------------------------------------------------------------------+
2893|fixed_ips |array |The IP addresses for the port. |
2894+-----------------------------+------------------+------------------------------------------------------------------------------+
2895|id |string |The ID of the resource. |
2896+-----------------------------+------------------+------------------------------------------------------------------------------+
2897|mac_address |string |The MAC address of the port. |
2898+-----------------------------+------------------+------------------------------------------------------------------------------+
2899|name |string |Human-readable name of the resource. |
2900+-----------------------------+------------------+------------------------------------------------------------------------------+
2901|network_id |string |The ID of the attached network. |
2902+-----------------------------+------------------+------------------------------------------------------------------------------+
2903|port_security_enabled |boolean |The port security status. |
2904+-----------------------------+------------------+------------------------------------------------------------------------------+
2905|project_id |string |The ID of the project. |
2906+-----------------------------+------------------+------------------------------------------------------------------------------+
2907|revision_number |integer |The revision number of the resource. |
2908+-----------------------------+------------------+------------------------------------------------------------------------------+
2909|security_groups |array |The IDs of security groups applied to the port. |
2910+-----------------------------+------------------+------------------------------------------------------------------------------+
2911|status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. |
2912+-----------------------------+------------------+------------------------------------------------------------------------------+
2913|tenant_id |string |The ID of the project. |
2914+-----------------------------+------------------+------------------------------------------------------------------------------+
2915|updated_at |string |Time at which port has been updated. |
2916+-----------------------------+------------------+------------------------------------------------------------------------------+
2917
2918Delete Port
2919+++++++++++++++
2920
2921https://developer.openstack.org/api-ref/network/v2/#delete-port
2922
2923+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2924|Interface Definition|Description |
2925+====================+=======================================================================================================================+
2926|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id} |
2927+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2928|Operation Type |DELETE |
2929+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2930|Content-Type |application/json |
2931+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2932
2933Request Body:
2934
2935+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2936|Attribute |Qualifier|Cardinality|Content |Description |
2937+============================+=========+===========+==========================+==============================================================+
2938|port_id |M |1 |String |The ID of the port. |
2939+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2940
2941Create Security Group
2942++++++++++++++++++++++
2943
2944https://developer.openstack.org/api-ref/network/v2/#create-security-group
2945
2946+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2947|Interface Definition|Description |
2948+====================+=======================================================================================================================+
2949|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups |
2950+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2951|Operation Type |POST |
2952+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2953|Content-Type |application/json |
2954+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2955
2956Request Body:
2957
2958+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2959|Attribute |Qualifier|Cardinality|Content |Description |
2960+============================+=========+===========+==========================+==============================================================+
2961|security_group |M |1 |object |A security_group object. |
2962+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2963|tenant_id |M |1 |string |The ID of the project. |
2964+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2965|project_id |M |1 |string |The ID of the project. |
2966+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2967|description |O |1 |string |A human-readable description for the resource. |
2968+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2969|name |M |1 |string |Human-readable name of the resource. |
2970+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2971
2972Response:
2973
2974+-----------------------------+------------------+------------------------------------------------------------------------------+
2975|Attribute |Content |Description |
2976+=============================+==================+==============================================================================+
2977|security_group |object |A security_group object. |
2978+-----------------------------+------------------+------------------------------------------------------------------------------+
2979|id |string |The ID of the security group. |
2980+-----------------------------+------------------+------------------------------------------------------------------------------+
2981|tenant_id |string |The ID of the project. |
2982+-----------------------------+------------------+------------------------------------------------------------------------------+
2983|project_id |string |The ID of the project. |
2984+-----------------------------+------------------+------------------------------------------------------------------------------+
2985|revision_number |integer |The revision number of the resource. |
2986+-----------------------------+------------------+------------------------------------------------------------------------------+
2987|name |string |Human-readable name of the resource. |
2988+-----------------------------+------------------+------------------------------------------------------------------------------+
2989|description |string |A human-readable description for the resource. |
2990+-----------------------------+------------------+------------------------------------------------------------------------------+
2991|security_group_rules |array |A list of security_group_rule objects. |
2992+-----------------------------+------------------+------------------------------------------------------------------------------+
2993
2994Delete security group
2995++++++++++++++++++++++
2996
2997https://developer.openstack.org/api-ref/network/v2/#delete-security-group
2998
2999+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3000|Interface Definition|Description |
3001+====================+=======================================================================================================================+
3002|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id} |
3003+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3004|Operation Type |DELETE |
3005+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3006|Content-Type |application/json |
3007+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3008
3009Request Body:
3010
3011+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3012|Attribute |Qualifier|Cardinality|Content |Description |
3013+============================+=========+===========+==========================+==============================================================+
3014|security_group_id |M |1 |String |The ID of the security group. |
3015+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3016
3017Create Security Group Rule
3018++++++++++++++++++++++++++
3019
3020https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
3021
3022+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3023|Interface Definition|Description |
3024+====================+=======================================================================================================================+
3025|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules |
3026+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3027|Operation Type |POST |
3028+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3029|Content-Type |application/json |
3030+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3031
3032Request Body:
3033
3034+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3035|Attribute |Qualifier|Cardinality|Content |Description |
3036+============================+=========+===========+==========================+================================================================================================+
3037|security_group_rule |M |1 |object |A security_group_rule object. |
3038+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3039|remote_group_id |O |1 |string |The remote group UUID to associate with this security group rule. |
3040+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3041|direction |M |1 |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3042+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3043|protocol |M |1 |string |The IP protocol can be represented by a string, an integer, or null. |
3044+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3045|ethertype |O |1 |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3046+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3047|port_range_max |O |1 |integer |The maximum port number in the range that is matched by the security group rule. |
3048+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3049|security_group_id |M |1 |string |The security group ID to associate with this security group rule. |
3050+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3051|port_range_min |O |1 |integer |The minimum port number in the range that is matched by the security group rule. |
3052+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3053|remote_ip_prefix |M |1 |string |The remote IP prefix to associate with this metering rule packet. |
3054+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3055|description |O |1 |string |A human-readable description for the resource. Default is an empty string. |
3056+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3057
3058Response:
3059
3060+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3061|Attribute |Content |Description |
3062+=============================+==================+=================================================================================================+
3063|security_group_rule |object |A security_group_rule object. |
3064+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3065|remote_group_id |string |The remote group UUID to associate with this security group rule. |
3066+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3067|direction |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3068+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3069|protocol |string |The IP protocol can be represented by a string, an integer, or null. |
3070+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3071|ethertype |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3072+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3073|port_range_max |integer |The maximum port number in the range that is matched by the security group rule. |
3074+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3075|security_group_id |string |The security group ID to associate with this security group rule. |
3076+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3077|tenant_id |string |The ID of the project. |
3078+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3079|project_id |string |The ID of the project. |
3080+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3081|port_range_min |integer |The minimum port number in the range that is matched by the security group rule. |
3082+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3083|remote_ip_prefix |string |The remote IP prefix to associate with this metering rule packet. |
3084+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3085|revision_number |integer |The revision number of the resource. |
3086+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3087|id |string |The ID of the security group rule. |
3088+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3089|description |string |A human-readable description for the resource. |
3090+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3091
3092Delete security group
3093++++++++++++++++++++++
3094
3095https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
3096
3097+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3098|Interface Definition|Description |
3099+====================+=================================================================================================================================+
3100|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id} |
3101+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3102|Operation Type |DELETE |
3103+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3104|Content-Type |application/json |
3105+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3106
3107Request Body:
3108
3109+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3110|Attribute |Qualifier|Cardinality|Content |Description |
3111+============================+=========+===========+==========================+==============================================================+
3112|security_group_rule_id |M |1 |String |The ID of the security group rule. |
3113+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3114
3115Policy API
3116----------
3117
3118Create a dictionary item
3119++++++++++++++++++++++++
3120
3121+--------------------+--------------------------+
3122|Interface Definition|Description |
3123+====================+==========================+
3124|URI |/createDictionaryItem |
3125+--------------------+--------------------------+
3126|Operation Type |PUT |
3127+--------------------+--------------------------+
3128
3129Request Parameters:
3130
3131+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3132|Attribute |Qualifier|Cardinality|Content|Description |
3133+===================+=========+===========+=======+=============================================================+
3134|dictionory |M |1 |String | |
3135+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3136|dictionaryJson |M |1 |String | |
3137+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3138|dictionaryType |M |1 |String | |
3139+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3140|requestId |M |1 |String | |
3141+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3142
3143Request Headers:
3144
3145+-------------------+---------+-----------------------------------------------------------------------------------------+
3146|Header Name |Qualifier|Description |
3147+===================+=========+=========================================================================================+
3148|ClientAuth |Y |encoded client authentication details |
3149+-------------------+---------+-----------------------------------------------------------------------------------------+
3150|X-ECOMP-RequestID |N |Request ID to track the requests |
3151+-------------------+---------+-----------------------------------------------------------------------------------------+
3152|Environment |Y |execution environments |
3153+-------------------+---------+-----------------------------------------------------------------------------------------+
3154|Authorization |Y |Base64 encoded username:password |
3155+-------------------+---------+-----------------------------------------------------------------------------------------+
3156
3157HTTP Response Code:
3158
3159+------------------+---------------------+
3160|HTTP CODE |Description |
3161+==================+=====================+
3162|200 |successful |
3163+------------------+---------------------+
3164|400 |Invalid Request |
3165+------------------+---------------------+
3166|401 |Unauthorized |
3167+------------------+---------------------+
3168|500 |Error |
3169+------------------+---------------------+
3170
3171Create Policy
3172+++++++++++++
3173
3174+--------------------+--------------------------+
3175|Interface Definition|Description |
3176+====================+==========================+
3177|URI |/createPolicy |
3178+--------------------+--------------------------+
3179|Operation Type |PUT |
3180+--------------------+--------------------------+
3181
3182Request Parameters:
3183
3184+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3185|Attribute |Qualifier|Cardinality|Content|Description |
3186+===================+=========+===========+=======+=============================================================+
3187|attributes |M |1 |Object |set of attributes in key value pair |
3188+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3189|configBody |M |1 |String | |
3190+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3191|configBodyType |M |1 |String | |
3192+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3193|configName |M |1 |String | |
3194+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3195|ecompName |M |1 |String | |
3196+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3197|policyClass |M |1 |String | |
3198+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3199|policyConfigType |M |1 |String | |
3200+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3201|policyDescription |M |1 |String | |
3202+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3203|policyName |M |1 |String | |
3204+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3205|requestID |M |1 |String |request ID |
3206+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3207
3208Request Headers:
3209
3210+-------------------+---------+-----------------------------------------------------------------------------------------+
3211|Header Name |Qualifier|Description |
3212+===================+=========+=========================================================================================+
3213|ClientAuth |Y |encoded client authentication details |
3214+-------------------+---------+-----------------------------------------------------------------------------------------+
3215|X-ECOMP-RequestID |N |Request ID to track the requests |
3216+-------------------+---------+-----------------------------------------------------------------------------------------+
3217|Environment |Y |execution environments |
3218+-------------------+---------+-----------------------------------------------------------------------------------------+
3219|Authorization |Y |Base64 encoded username:password |
3220+-------------------+---------+-----------------------------------------------------------------------------------------+
3221
3222HTTP Response Code:
3223
3224+------------------+---------------------+
3225|HTTP CODE |Description |
3226+==================+=====================+
3227|200 |successful |
3228+------------------+---------------------+
3229|400 |Invalid Request |
3230+------------------+---------------------+
3231|401 |Unauthorized |
3232+------------------+---------------------+
3233|500 |Error |
3234+------------------+---------------------+
3235
3236Delete Policy
3237+++++++++++++
3238
3239+--------------------+--------------------------+
3240|Interface Definition|Description |
3241+====================+==========================+
3242|URI |/deletePolicy |
3243+--------------------+--------------------------+
3244|Operation Type |DELETE |
3245+--------------------+--------------------------+
3246
3247Request Parameters:
3248
3249+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3250|Attribute |Qualifier|Cardinality|Content|Description |
3251+===================+=========+===========+=======+=============================================================+
3252|deleteCondition |M |1 |String | |
3253+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3254|pdpGroup |M |1 |String | |
3255+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3256|policyComponent |M |1 |String | |
3257+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3258|policyName |M |1 |String | |
3259+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3260|policyType |M |1 |String | |
3261+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3262|requestID |M |1 |String |request ID |
3263+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3264
3265Request Headers:
3266
3267+-------------------+---------+-----------------------------------------------------------------------------------------+
3268|Header Name |Qualifier|Description |
3269+===================+=========+=========================================================================================+
3270|ClientAuth |Y |encoded client authentication details |
3271+-------------------+---------+-----------------------------------------------------------------------------------------+
3272|X-ECOMP-RequestID |N |Request ID to track the requests |
3273+-------------------+---------+-----------------------------------------------------------------------------------------+
3274|Environment |Y |execution environments |
3275+-------------------+---------+-----------------------------------------------------------------------------------------+
3276|Authorization |Y |Base64 encoded username:password |
3277+-------------------+---------+-----------------------------------------------------------------------------------------+
3278
3279HTTP Response Code:
3280
3281+------------------+---------------------+
3282|HTTP CODE |Description |
3283+==================+=====================+
3284|200 |successful |
3285+------------------+---------------------+
3286|400 |Invalid Request |
3287+------------------+---------------------+
3288|401 |Unauthorized |
3289+------------------+---------------------+
3290|500 |Error |
3291+------------------+---------------------+
3292
3293Get Configuration
3294+++++++++++++++++
3295
3296+--------------------+--------------------------+
3297|Interface Definition|Description |
3298+====================+==========================+
3299|URI |/getConfig |
3300+--------------------+--------------------------+
3301|Operation Type |POST |
3302+--------------------+--------------------------+
3303
3304Request Parameters:
3305
3306+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3307|Attribute |Qualifier|Cardinality|Content|Description |
3308+===================+=========+===========+=======+=============================================================+
3309|configAttributes |M |1 |String | |
3310+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3311|configName |M |1 |String | |
3312+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3313|ecompName |M |1 |String | |
3314+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3315|policyName |M |1 |String | |
3316+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3317|unique |M |1 |Boolean| |
3318+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3319|requestID |M |1 |String |request ID |
3320+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3321
3322Request Headers:
3323
3324+-------------------+---------+-----------------------------------------------------------------------------------------+
3325|Header Name |Qualifier|Description |
3326+===================+=========+=========================================================================================+
3327|ClientAuth |Y |encoded client authentication details |
3328+-------------------+---------+-----------------------------------------------------------------------------------------+
3329|X-ECOMP-RequestID |N |Request ID to track the requests |
3330+-------------------+---------+-----------------------------------------------------------------------------------------+
3331|Environment |Y |execution environments |
3332+-------------------+---------+-----------------------------------------------------------------------------------------+
3333|Authorization |Y |Base64 encoded username:password |
3334+-------------------+---------+-----------------------------------------------------------------------------------------+
3335
3336HTTP Response Code:
3337
3338+------------------+---------------------+
3339|HTTP CODE |Description |
3340+==================+=====================+
3341|200 |successful |
3342+------------------+---------------------+
3343|400 |Invalid Request |
3344+------------------+---------------------+
3345|401 |Unauthorized |
3346+------------------+---------------------+
3347|500 |Error |
3348+------------------+---------------------+
3349
3350Get Decision
3351++++++++++++
3352
3353+--------------------+--------------------------+
3354|Interface Definition|Description |
3355+====================+==========================+
3356|URI |/getDecision |
3357+--------------------+--------------------------+
3358|Operation Type |POST |
3359+--------------------+--------------------------+
3360
3361Request Parameters:
3362
3363+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3364|Attribute |Qualifier|Cardinality|Content|Description |
3365+===================+=========+===========+=======+=============================================================+
3366|decisionAttributes |M |1 |Object | |
3367+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3368|ecompComponentName |M |1 |String | |
3369+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3370|requestID |M |1 |String |request ID |
3371+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3372
3373Request Headers:
3374
3375+-------------------+---------+-----------------------------------------------------------------------------------------+
3376|Header Name |Qualifier|Description |
3377+===================+=========+=========================================================================================+
3378|ClientAuth |Y |encoded client authentication details |
3379+-------------------+---------+-----------------------------------------------------------------------------------------+
3380|X-ECOMP-RequestID |N |Request ID to track the requests |
3381+-------------------+---------+-----------------------------------------------------------------------------------------+
3382|Environment |Y |execution environments |
3383+-------------------+---------+-----------------------------------------------------------------------------------------+
3384|Authorization |Y |Base64 encoded username:password |
3385+-------------------+---------+-----------------------------------------------------------------------------------------+
3386
3387HTTP Response Code:
3388
3389+------------------+---------------------+
3390|HTTP CODE |Description |
3391+==================+=====================+
3392|200 |successful |
3393+------------------+---------------------+
3394|400 |Invalid Request |
3395+------------------+---------------------+
3396|401 |Unauthorized |
3397+------------------+---------------------+
3398|500 |Error |
3399+------------------+---------------------+
3400
3401Response Parameters:
3402
3403+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3404|Attribute |Qualifier|Cardinality|Content|Description |
3405+===================+=========+===========+=======+=============================================================+
3406|decision |N |1 |String | |
3407+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3408|details |N |1 |String | |
3409+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3410
3411Get Dictionary Items
3412++++++++++++++++++++
3413
3414+--------------------+--------------------------+
3415|Interface Definition|Description |
3416+====================+==========================+
3417|URI |/getDictionaryItems |
3418+--------------------+--------------------------+
3419|Operation Type |POST |
3420+--------------------+--------------------------+
3421
3422Request Parameters:
3423
3424+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3425|Attribute |Qualifier|Cardinality|Content|Description |
3426+===================+=========+===========+=======+=============================================================+
3427|dictionary |N |1 |String | |
3428+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3429|dictionaryJson |N |1 |String | |
3430+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3431|dictionaryType |N |1 |String | |
3432+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3433|requestID |M |1 |String |request ID |
3434+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3435
3436Request Headers:
3437
3438+-------------------+---------+-----------------------------------------------------------------------------------------+
3439|Header Name |Qualifier|Description |
3440+===================+=========+=========================================================================================+
3441|ClientAuth |Y |encoded client authentication details |
3442+-------------------+---------+-----------------------------------------------------------------------------------------+
3443|X-ECOMP-RequestID |N |Request ID to track the requests |
3444+-------------------+---------+-----------------------------------------------------------------------------------------+
3445|Environment |Y |execution environments |
3446+-------------------+---------+-----------------------------------------------------------------------------------------+
3447|Authorization |Y |Base64 encoded username:password |
3448+-------------------+---------+-----------------------------------------------------------------------------------------+
3449
3450HTTP Response Code:
3451
3452+------------------+---------------------+
3453|HTTP CODE |Description |
3454+==================+=====================+
3455|200 |successful |
3456+------------------+---------------------+
3457|400 |Invalid Request |
3458+------------------+---------------------+
3459|401 |Unauthorized |
3460+------------------+---------------------+
3461|500 |Error |
3462+------------------+---------------------+
3463
3464Response Parameters:
3465
3466+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3467|Attribute |Qualifier|Cardinality|Content|Description |
3468+===================+=========+===========+=======+=============================================================+
3469|dictionaryData |N |1 |Object | |
3470+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3471|dictionaryJson |N |1 |Object | |
3472+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3473|responseCode |N |1 |Integer| |
3474+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3475|responseMessage |N |1 |Object | |
3476+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3477
3478Get Metrics
3479+++++++++++
3480
3481+--------------------+--------------------------+
3482|Interface Definition|Description |
3483+====================+==========================+
3484|URI |/getMetrics |
3485+--------------------+--------------------------+
3486|Operation Type |GET |
3487+--------------------+--------------------------+
3488
3489Request Headers:
3490
3491+-------------------+---------+-----------------------------------------------------------------------------------------+
3492|Header Name |Qualifier|Description |
3493+===================+=========+=========================================================================================+
3494|ClientAuth |Y |encoded client authentication details |
3495+-------------------+---------+-----------------------------------------------------------------------------------------+
3496|X-ECOMP-RequestID |N |Request ID to track the requests |
3497+-------------------+---------+-----------------------------------------------------------------------------------------+
3498|Environment |Y |execution environments |
3499+-------------------+---------+-----------------------------------------------------------------------------------------+
3500|Authorization |Y |Base64 encoded username:password |
3501+-------------------+---------+-----------------------------------------------------------------------------------------+
3502
3503HTTP Response Code:
3504
3505+------------------+---------------------+
3506|HTTP CODE |Description |
3507+==================+=====================+
3508|200 |successful |
3509+------------------+---------------------+
3510|400 |Invalid Request |
3511+------------------+---------------------+
3512|401 |Unauthorized |
3513+------------------+---------------------+
3514|500 |Error |
3515+------------------+---------------------+
3516
3517Response Parameters:
3518
3519+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3520|Attribute |Qualifier|Cardinality|Content|Description |
3521+===================+=========+===========+=======+=============================================================+
3522|metricsTotal |N |1 |Integer| |
3523+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3524|papMetrics |N |1 |Integer| |
3525+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3526|pdpMetrics |N |1 |Integer| |
3527+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3528|responseCode |N |1 |Object | |
3529+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3530|responseMessage |N |1 |String | |
3531+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3532
3533Get Notification
3534++++++++++++++++
3535
3536+--------------------+--------------------------+
3537|Interface Definition|Description |
3538+====================+==========================+
3539|URI |/getNotification |
3540+--------------------+--------------------------+
3541|Operation Type |POST |
3542+--------------------+--------------------------+
3543
3544Request Headers:
3545
3546+-------------------+---------+-----------------------------------------------------------------------------------------+
3547|Header Name |Qualifier|Description |
3548+===================+=========+=========================================================================================+
3549|ClientAuth |Y |encoded client authentication details |
3550+-------------------+---------+-----------------------------------------------------------------------------------------+
3551|X-ECOMP-RequestID |N |Request ID to track the requests |
3552+-------------------+---------+-----------------------------------------------------------------------------------------+
3553|Environment |Y |execution environments |
3554+-------------------+---------+-----------------------------------------------------------------------------------------+
3555|Authorization |Y |Base64 encoded username:password |
3556+-------------------+---------+-----------------------------------------------------------------------------------------+
3557
3558HTTP Response Code:
3559
3560+------------------+---------------------+
3561|HTTP CODE |Description |
3562+==================+=====================+
3563|200 |successful |
3564+------------------+---------------------+
3565|400 |Invalid Request |
3566+------------------+---------------------+
3567|401 |Unauthorized |
3568+------------------+---------------------+
3569|500 |Error |
3570+------------------+---------------------+
3571
3572Response Parameters:
3573
3574+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3575|Attribute |Qualifier|Cardinality|Content|Description |
3576+===================+=========+===========+=======+=============================================================+
3577|metricsTotal |N |1 |Integer| |
3578+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3579|papMetrics |N |1 |Integer| |
3580+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3581|pdpMetrics |N |1 |Integer| |
3582+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3583|responseCode |N |1 |Object | |
3584+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3585|responseMessage |N |1 |String | |
3586+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3587
3588List Configuration
3589++++++++++++++++++
3590
3591+--------------------+--------------------------+
3592|Interface Definition|Description |
3593+====================+==========================+
3594|URI |/listConfiguration |
3595+--------------------+--------------------------+
3596|Operation Type |POST |
3597+--------------------+--------------------------+
3598
3599Request Headers:
3600
3601+-------------------+---------+-----------------------------------------------------------------------------------------+
3602|Header Name |Qualifier|Description |
3603+===================+=========+=========================================================================================+
3604|ClientAuth |Y |encoded client authentication details |
3605+-------------------+---------+-----------------------------------------------------------------------------------------+
3606|X-ECOMP-RequestID |N |Request ID to track the requests |
3607+-------------------+---------+-----------------------------------------------------------------------------------------+
3608|Environment |Y |execution environments |
3609+-------------------+---------+-----------------------------------------------------------------------------------------+
3610|Authorization |Y |Base64 encoded username:password |
3611+-------------------+---------+-----------------------------------------------------------------------------------------+
3612
3613Request Parameters:
3614
3615+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3616|Attribute |Qualifier|Cardinality|Content|Description |
3617+===================+=========+===========+=======+=============================================================+
3618|configAttributes |N |1 |Object | |
3619+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3620|configName |N |1 |String | |
3621+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3622|ecompName |N |1 |String | |
3623+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3624|policyName |N |1 |String | |
3625+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3626|requestID |N |1 |String | |
3627+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3628|unique |N |1 |Boolean| |
3629+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3630
3631HTTP Response Code:
3632
3633+------------------+---------------------+
3634|HTTP CODE |Description |
3635+==================+=====================+
3636|200 |successful |
3637+------------------+---------------------+
3638|400 |Invalid Request |
3639+------------------+---------------------+
3640|401 |Unauthorized |
3641+------------------+---------------------+
3642|500 |Error |
3643+------------------+---------------------+
3644
3645Import policy
3646+++++++++++++
3647
3648+--------------------+--------------------------+
3649|Interface Definition|Description |
3650+====================+==========================+
3651|URI |/policyEngineImport |
3652+--------------------+--------------------------+
3653|Operation Type |POST |
3654+--------------------+--------------------------+
3655
3656Request Headers:
3657
3658+-------------------+---------+-----------------------------------------------------------------------------------------+
3659|Header Name |Qualifier|Description |
3660+===================+=========+=========================================================================================+
3661|ClientAuth |Y |encoded client authentication details |
3662+-------------------+---------+-----------------------------------------------------------------------------------------+
3663|X-ECOMP-RequestID |N |Request ID to track the requests |
3664+-------------------+---------+-----------------------------------------------------------------------------------------+
3665|Environment |Y |execution environments |
3666+-------------------+---------+-----------------------------------------------------------------------------------------+
3667|Authorization |Y |Base64 encoded username:password |
3668+-------------------+---------+-----------------------------------------------------------------------------------------+
3669
3670Request Parameters:
3671
3672+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3673|Attribute |Qualifier|Cardinality|Content|Description |
3674+===================+=========+===========+=======+=============================================================+
3675|importParameterJson|Y |1 |String | |
3676+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3677|file |Y |1 |File | |
3678+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3679
3680HTTP Response Code:
3681
3682+------------------+---------------------+
3683|HTTP CODE |Description |
3684+==================+=====================+
3685|200 |successful |
3686+------------------+---------------------+
3687|400 |Invalid Request |
3688+------------------+---------------------+
3689|401 |Unauthorized |
3690+------------------+---------------------+
3691|500 |Error |
3692+------------------+---------------------+
3693
3694Push Policy
3695+++++++++++
3696
3697+--------------------+--------------------------+
3698|Interface Definition|Description |
3699+====================+==========================+
3700|URI |/pushPolicy |
3701+--------------------+--------------------------+
3702|Operation Type |PUT |
3703+--------------------+--------------------------+
3704
3705Request Headers:
3706
3707+-------------------+---------+-----------------------------------------------------------------------------------------+
3708|Header Name |Qualifier|Description |
3709+===================+=========+=========================================================================================+
3710|ClientAuth |Y |encoded client authentication details |
3711+-------------------+---------+-----------------------------------------------------------------------------------------+
3712|X-ECOMP-RequestID |N |Request ID to track the requests |
3713+-------------------+---------+-----------------------------------------------------------------------------------------+
3714|Environment |Y |execution environments |
3715+-------------------+---------+-----------------------------------------------------------------------------------------+
3716|Authorization |Y |Base64 encoded username:password |
3717+-------------------+---------+-----------------------------------------------------------------------------------------+
3718
3719Request Parameters:
3720
3721+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3722|Attribute |Qualifier|Cardinality|Content|Description |
3723+===================+=========+===========+=======+=============================================================+
3724|pdpGroup |N |1 |String | |
3725+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3726|policyName |N |1 |String | |
3727+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3728|policyType |N |1 |String | |
3729+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3730
3731HTTP Response Code:
3732
3733+------------------+---------------------+
3734|HTTP CODE |Description |
3735+==================+=====================+
3736|200 |successful |
3737+------------------+---------------------+
3738|400 |Invalid Request |
3739+------------------+---------------------+
3740|401 |Unauthorized |
3741+------------------+---------------------+
3742|500 |Error |
3743+------------------+---------------------+
3744
3745Send Event
3746++++++++++
3747
3748+--------------------+--------------------------+
3749|Interface Definition|Description |
3750+====================+==========================+
3751|URI |/sendEvent |
3752+--------------------+--------------------------+
3753|Operation Type |POST |
3754+--------------------+--------------------------+
3755
3756Request Headers:
3757
3758+-------------------+---------+-----------------------------------------------------------------------------------------+
3759|Header Name |Qualifier|Description |
3760+===================+=========+=========================================================================================+
3761|ClientAuth |Y |encoded client authentication details |
3762+-------------------+---------+-----------------------------------------------------------------------------------------+
3763|X-ECOMP-RequestID |N |Request ID to track the requests |
3764+-------------------+---------+-----------------------------------------------------------------------------------------+
3765|Environment |Y |execution environments |
3766+-------------------+---------+-----------------------------------------------------------------------------------------+
3767|Authorization |Y |Base64 encoded username:password |
3768+-------------------+---------+-----------------------------------------------------------------------------------------+
3769
3770Request Parameters:
3771
3772+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3773|Attribute |Qualifier|Cardinality|Content|Description |
3774+===================+=========+===========+=======+=============================================================+
3775|eventAttributes |N |1 |Object | |
3776+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3777|requestID |N |1 |String | |
3778+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3779
3780HTTP Response Code:
3781
3782+------------------+---------------------+
3783|HTTP CODE |Description |
3784+==================+=====================+
3785|200 |successful |
3786+------------------+---------------------+
3787|400 |Invalid Request |
3788+------------------+---------------------+
3789|401 |Unauthorized |
3790+------------------+---------------------+
3791|500 |Error |
3792+------------------+---------------------+
3793
3794Send Heartbeat
3795++++++++++++++
3796
3797+--------------------+--------------------------+
3798|Interface Definition|Description |
3799+====================+==========================+
3800|URI |/sendEvent |
3801+--------------------+--------------------------+
3802|Operation Type |POST |
3803+--------------------+--------------------------+
3804
3805Request Headers:
3806
3807+-------------------+---------+-----------------------------------------------------------------------------------------+
3808|Header Name |Qualifier|Description |
3809+===================+=========+=========================================================================================+
3810|ClientAuth |Y |encoded client authentication details |
3811+-------------------+---------+-----------------------------------------------------------------------------------------+
3812|X-ECOMP-RequestID |N |Request ID to track the requests |
3813+-------------------+---------+-----------------------------------------------------------------------------------------+
3814|Environment |Y |execution environments |
3815+-------------------+---------+-----------------------------------------------------------------------------------------+
3816|Authorization |Y |Base64 encoded username:password |
3817+-------------------+---------+-----------------------------------------------------------------------------------------+
3818
3819Request Parameters:
3820
3821+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3822|Attribute |Qualifier|Cardinality|Content|Description |
3823+===================+=========+===========+=======+=============================================================+
3824|notificationTopic |Y |1 |String | |
3825+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3826
3827HTTP Response Code:
3828
3829+------------------+---------------------+
3830|HTTP CODE |Description |
3831+==================+=====================+
3832|200 |successful |
3833+------------------+---------------------+
3834|400 |Invalid Request |
3835+------------------+---------------------+
3836|401 |Unauthorized |
3837+------------------+---------------------+
3838|500 |Error |
3839+------------------+---------------------+
3840
3841Stop Notification
3842+++++++++++++++++
3843
3844+--------------------+--------------------------+
3845|Interface Definition|Description |
3846+====================+==========================+
3847|URI |/stopNotification |
3848+--------------------+--------------------------+
3849|Operation Type |POST |
3850+--------------------+--------------------------+
3851
3852Request Headers:
3853
3854+-------------------+---------+-----------------------------------------------------------------------------------------+
3855|Header Name |Qualifier|Description |
3856+===================+=========+=========================================================================================+
3857|ClientAuth |Y |encoded client authentication details |
3858+-------------------+---------+-----------------------------------------------------------------------------------------+
3859|X-ECOMP-RequestID |N |Request ID to track the requests |
3860+-------------------+---------+-----------------------------------------------------------------------------------------+
3861|Environment |Y |execution environments |
3862+-------------------+---------+-----------------------------------------------------------------------------------------+
3863|Authorization |Y |Base64 encoded username:password |
3864+-------------------+---------+-----------------------------------------------------------------------------------------+
3865
3866Request Parameters:
3867
3868+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3869|Attribute |Qualifier|Cardinality|Content|Description |
3870+===================+=========+===========+=======+=============================================================+
3871|notificationTopic |Y |1 |String | |
3872+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3873
3874HTTP Response Code:
3875
3876+------------------+---------------------+
3877|HTTP CODE |Description |
3878+==================+=====================+
3879|200 |successful |
3880+------------------+---------------------+
3881|400 |Invalid Request |
3882+------------------+---------------------+
3883|401 |Unauthorized |
3884+------------------+---------------------+
3885|500 |Error |
3886+------------------+---------------------+
3887
3888Update Dictionary
3889+++++++++++++++++
3890
3891+--------------------+--------------------------+
3892|Interface Definition|Description |
3893+====================+==========================+
3894|URI |/updateDictionaryItem |
3895+--------------------+--------------------------+
3896|Operation Type |PUT |
3897+--------------------+--------------------------+
3898
3899Request Headers:
3900
3901+-------------------+---------+-----------------------------------------------------------------------------------------+
3902|Header Name |Qualifier|Description |
3903+===================+=========+=========================================================================================+
3904|ClientAuth |Y |encoded client authentication details |
3905+-------------------+---------+-----------------------------------------------------------------------------------------+
3906|X-ECOMP-RequestID |N |Request ID to track the requests |
3907+-------------------+---------+-----------------------------------------------------------------------------------------+
3908|Environment |Y |execution environments |
3909+-------------------+---------+-----------------------------------------------------------------------------------------+
3910|Authorization |Y |Base64 encoded username:password |
3911+-------------------+---------+-----------------------------------------------------------------------------------------+
3912
3913Request Parameters:
3914
3915+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3916|Attribute |Qualifier|Cardinality|Content|Description |
3917+===================+=========+===========+=======+=============================================================+
3918|dictionary |N |1 |String | |
3919+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3920|dictionaryJson |N |1 |String | |
3921+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3922|dictionaryType |N |1 |String | |
3923+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3924|requestID |N |1 |String | |
3925+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3926
3927HTTP Response Code:
3928
3929+------------------+---------------------+
3930|HTTP CODE |Description |
3931+==================+=====================+
3932|200 |successful |
3933+------------------+---------------------+
3934|400 |Invalid Request |
3935+------------------+---------------------+
3936|401 |Unauthorized |
3937+------------------+---------------------+
3938|500 |Error |
3939+------------------+---------------------+
3940
3941Update Policy
3942+++++++++++++
3943
3944+--------------------+--------------------------+
3945|Interface Definition|Description |
3946+====================+==========================+
3947|URI |/updatePolicy |
3948+--------------------+--------------------------+
3949|Operation Type |PUT |
3950+--------------------+--------------------------+
3951
3952Request Headers:
3953
3954+-------------------+---------+-----------------------------------------------------------------------------------------+
3955|Header Name |Qualifier|Description |
3956+===================+=========+=========================================================================================+
3957|ClientAuth |Y |encoded client authentication details |
3958+-------------------+---------+-----------------------------------------------------------------------------------------+
3959|X-ECOMP-RequestID |N |Request ID to track the requests |
3960+-------------------+---------+-----------------------------------------------------------------------------------------+
3961|Environment |Y |execution environments |
3962+-------------------+---------+-----------------------------------------------------------------------------------------+
3963|Authorization |Y |Base64 encoded username:password |
3964+-------------------+---------+-----------------------------------------------------------------------------------------+
3965
3966Request Parameters:
3967
3968+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3969|Attribute |Qualifier|Cardinality|Content|Description |
3970+===================+=========+===========+=======+=============================================================+
3971|attributes |N |1 |Object | |
3972+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3973|configBody |N |1 |String | |
3974+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3975|configBodyType |N |1 |String | |
3976+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3977|configName |N |1 |String | |
3978+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3979|ecompName |N |1 |String | |
3980+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3981|policyClass |N |1 |String | |
3982+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3983|policyConfigType |N |1 |String | |
3984+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3985|policyDescription |N |1 |String | |
3986+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3987|policyName |N |1 |String | |
3988+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3989|requestID |N |1 |String | |
3990+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3991
3992HTTP Response Code:
3993
3994+------------------+---------------------+
3995|HTTP CODE |Description |
3996+==================+=====================+
3997|200 |successful |
3998+------------------+---------------------+
3999|400 |Invalid Request |
4000+------------------+---------------------+
4001|401 |Unauthorized |
4002+------------------+---------------------+
4003|500 |Error |
4004+------------------+---------------------+