Gitiles
Code Review Sign In
gerrit.nordix.org / onap / so / 1b54077ea266b040d6838470e63342fa17bd987b / . / docs / SO_R1_Interface.rst
blob: 0041fc670386674dea0933d22b073805a3659935 [file] [log] [blame]
sanchitap4f8eb3e2018-04-24 19:02:07 +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
5SO Amsterdam Interfaces
6================
7
8.. image:: images/SO_R1_1.png
9
10SO APIs
11============
12
13North Bound APIs
14----------------
15Create service instance
16++++++++++++++++++++++++
17
18+--------------------+-------------------------------------+
19|Interface Definition|Description |
20+====================+=====================================+
21|URI |{serverRoot}/serviceInstances/v4 |
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
sanchitap1b540772018-04-25 15:10:47 +0530[diff] [blame^]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|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
50+-------------------+--------------------------+-------------------------------------------------+
51|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
52+-------------------+--------------------------+-------------------------------------------------+
53|project |project Object |Content of project object. |
54+-------------------+--------------------------+-------------------------------------------------+
55|owningEntity |owningEntity Object |Content of owningEntity object. |
56+-------------------+--------------------------+-------------------------------------------------+
57|platform |platform Object |Content of platform object. |
58+-------------------+--------------------------+-------------------------------------------------+
59|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
60+-------------------+--------------------------+-------------------------------------------------+
sanchitap4f8eb3e2018-04-24 19:02:07 +0530[diff] [blame]61
62ModelInfo Object
63
64+-------------------------+------------------+-------------------------------------------------+
65|Attribute |Content |Description |
66+=========================+==================+=================================================+
67|ModelType |String |Type of model |
68+-------------------------+------------------+-------------------------------------------------+
69|ModelInvariantId |String |The Model Invariant Id. |
70+-------------------------+------------------+-------------------------------------------------+
71|ModelNameVersionId |String |The modelname Version Id |
72+-------------------------+------------------+-------------------------------------------------+
73|ModelName |String |Name of the Model |
74+-------------------------+------------------+-------------------------------------------------+
75|ModelVersion |String |Version of the model |
76+-------------------------+------------------+-------------------------------------------------+
77|ModelCustomization Name |String |The Model Customization name |
78+-------------------------+------------------+-------------------------------------------------+
79
80SubscriberInfo Object
81
82+-------------------------+------------------+-------------------------------------------------+
83|Attribute |Content |Description |
84+=========================+==================+=================================================+
85|GlobalSubscriberId |String |Global customer Id (in A&AI) |
86+-------------------------+------------------+-------------------------------------------------+
87|SubscriberName |String |Name of the Subscriber |
88+-------------------------+------------------+-------------------------------------------------+
89
90RequestInfo Object
91
92+-------------------------+------------------+-------------------------------------------------+
93|Attribute |Content |Description |
94+=========================+==================+=================================================+
95|InstanceName |String |The instance Name |
96+-------------------------+------------------+-------------------------------------------------+
97|ProductFamilyId |String |The product family Id. |
98+-------------------------+------------------+-------------------------------------------------+
99|Source |String |source of the request |
100+-------------------------+------------------+-------------------------------------------------+
101|SuppressRollback |Boolean |SuppressRollback |
102+-------------------------+------------------+-------------------------------------------------+
103
104RequestParameters Object
105
106+-------------------------+------------------+-------------------------------------------------+
107|Attribute |Content |Description |
108+=========================+==================+=================================================+
109|SubscriptionServiceType |String |The service type of the Subscription |
110+-------------------------+------------------+-------------------------------------------------+
111|UserParams |Array |The product family Id. |
112+-------------------------+------------------+-------------------------------------------------+
113
114UserParams Object
115
116+-------------------------+------------------+-------------------------------------------------+
117|Attribute |Content |Description |
118+=========================+==================+=================================================+
119|name |String |Tag name of attribute |
120+-------------------------+------------------+-------------------------------------------------+
121|value |String |Value of the tag |
122+-------------------------+------------------+-------------------------------------------------+
123
124Delete service instance
125++++++++++++++++++++++++
126
127+--------------------+---------------------------------------------------------+
128|Interface Definition|Description |
129+====================+=========================================================+
130|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId} |
131+--------------------+---------------------------------------------------------+
132|Operation Type |DELETE |
133+--------------------+---------------------------------------------------------+
134|Content-Type |application/json |
135+--------------------+---------------------------------------------------------+
136
137Request Body:
138
139+----------------+---------+-----------+--------------------------+-------------------------------------------+
140|Attribute |Qualifier|Cardinality|Content |Description |
141+================+=========+===========+==========================+===========================================+
142|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
143+----------------+---------+-----------+--------------------------+-------------------------------------------+
144
145RequestDetails Object
146
147+-------------------+-------------------------+-------------------------------------------------+
148|Attribute |Content |Description |
149+===================+=========================+=================================================+
150|modelInfo |modelInfo Object |Content of modelInfo object. |
151+-------------------+-------------------------+-------------------------------------------------+
152|requestInfo |requestInfo Object |Content of requestInfo object. |
153+-------------------+-------------------------+-------------------------------------------------+
154
155ModelInfo Object
156
157+-------------------------+------------------+-------------------------------------------------+
158|Attribute |Content |Description |
159+=========================+==================+=================================================+
160|ModelType |String |Type of model |
161+-------------------------+------------------+-------------------------------------------------+
162|ModelInvariantId |String |The Model Invariant Id. |
163+-------------------------+------------------+-------------------------------------------------+
164|ModelName |String |Name of the Model |
165+-------------------------+------------------+-------------------------------------------------+
166|ModelVersion |String |Version of the model |
167+-------------------------+------------------+-------------------------------------------------+
168
169RequestInfo Object
170
171+-------------------------+------------------+-------------------------------------------------+
172|Attribute |Content |Description |
173+=========================+==================+=================================================+
174|Source |String |source of the request |
175+-------------------------+------------------+-------------------------------------------------+
176
177Create Volume Group
178++++++++++++++++++++++++
179
180+--------------------+-------------------------------------------------------------------------------------------+
181|Interface Definition|Description |
182+====================+===========================================================================================+
183|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
184+--------------------+-------------------------------------------------------------------------------------------+
185|Operation Type |POST |
186+--------------------+-------------------------------------------------------------------------------------------+
187|Content-Type |application/json |
188+--------------------+-------------------------------------------------------------------------------------------+
189
190Request Body:
191
192+----------------+---------+-----------+--------------------------+-------------------------------------------+
193|Attribute |Qualifier|Cardinality|Content |Description |
194+================+=========+===========+==========================+===========================================+
195|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
196+----------------+---------+-----------+--------------------------+-------------------------------------------+
197
198RequestDetails Object
199
200+---------------------+-------------------------+-------------------------------------------------+
201|Attribute |Content |Description |
202+=====================+=========================+=================================================+
203|modelInfo |modelInfo Object |Content of modelInfo object. |
204+---------------------+-------------------------+-------------------------------------------------+
205|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
206+---------------------+-------------------------+-------------------------------------------------+
207|requestInfo |requestInfo Object |Content of requestInfo object. |
208+---------------------+-------------------------+-------------------------------------------------+
209|relatedInstanceList |List |Content of relatedInstanceList. |
210+---------------------+-------------------------+-------------------------------------------------+
211
212ModelInfo Object
213
214+-------------------------+------------------+-------------------------------------------------+
215|Attribute |Content |Description |
216+=========================+==================+=================================================+
217|ModelType |String |Type of model |
218+-------------------------+------------------+-------------------------------------------------+
219|ModelInvariantId |String |The Model Invariant Id. |
220+-------------------------+------------------+-------------------------------------------------+
221|ModelNameVersionId |String |The modelname Version Id |
222+-------------------------+------------------+-------------------------------------------------+
223|ModelName |String |Name of the Model |
224+-------------------------+------------------+-------------------------------------------------+
225|ModelVersion |String |Version of the model |
226+-------------------------+------------------+-------------------------------------------------+
227|ModelCustomization Name |String |The Model Customization name |
228+-------------------------+------------------+-------------------------------------------------+
229
230CloudConfiguration Object
231
232+-------------------------+------------------+-------------------------------------------------+
233|Attribute |Content |Description |
234+=========================+==================+=================================================+
235|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
236+-------------------------+------------------+-------------------------------------------------+
237|tenantId |String |Name of the Subscriber |
238+-------------------------+------------------+-------------------------------------------------+
239
240RequestInfo Object
241
242+-------------------------+------------------+-------------------------------------------------+
243|Attribute |Content |Description |
244+=========================+==================+=================================================+
245|InstanceName |String |The instance Name |
246+-------------------------+------------------+-------------------------------------------------+
247|Source |String |source of the request |
248+-------------------------+------------------+-------------------------------------------------+
249|SuppressRollback |Boolean |SuppressRollback |
250+-------------------------+------------------+-------------------------------------------------+
251
252relatedInstance List
253
254+-------------------------+------------------+-------------------------------------------------+
255|Attribute |Content |Description |
256+=========================+==================+=================================================+
257|relatedInstance |Object |relatedInstance Object |
258+-------------------------+------------------+-------------------------------------------------+
259
260relatedInstance List
261
262+-------------------------+------------------+-------------------------------------------------+
263|Attribute |Content |Description |
264+=========================+==================+=================================================+
265|instanceId |String |instanceId |
266+-------------------------+------------------+-------------------------------------------------+
267|modelInfo |Object |Content of modelInfo object. |
268+-------------------------+------------------+-------------------------------------------------+
269
270Delete Volume Group
271++++++++++++++++++++++++
272
273+--------------------+---------------------------------------------------------------------------------------------------------------------+
274|Interface Definition|Description |
275+====================+=====================================================================================================================+
276|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
277+--------------------+---------------------------------------------------------------------------------------------------------------------+
278|Operation Type |DELETE |
279+--------------------+---------------------------------------------------------------------------------------------------------------------+
280|Content-Type |application/json |
281+--------------------+---------------------------------------------------------------------------------------------------------------------+
282
283Request Body:
284
285+----------------+---------+-----------+--------------------------+-------------------------------------------+
286|Attribute |Qualifier|Cardinality|Content |Description |
287+================+=========+===========+==========================+===========================================+
288|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
289+----------------+---------+-----------+--------------------------+-------------------------------------------+
290
291RequestDetails Object
292
293+---------------------+-------------------------+-------------------------------------------------+
294|Attribute |Content |Description |
295+=====================+=========================+=================================================+
296|modelInfo |modelInfo Object |Content of modelInfo object. |
297+---------------------+-------------------------+-------------------------------------------------+
298|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
299+---------------------+-------------------------+-------------------------------------------------+
300|requestInfo |requestInfo Object |Content of requestInfo object. |
301+---------------------+-------------------------+-------------------------------------------------+
302
303ModelInfo Object
304
305+-------------------------+------------------+-------------------------------------------------+
306|Attribute |Content |Description |
307+=========================+==================+=================================================+
308|ModelType |String |Type of model |
309+-------------------------+------------------+-------------------------------------------------+
310|ModelName |String |Name of the Model |
311+-------------------------+------------------+-------------------------------------------------+
312
313CloudConfiguration Object
314
315+-------------------------+------------------+-------------------------------------------------+
316|Attribute |Content |Description |
317+=========================+==================+=================================================+
318|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
319+-------------------------+------------------+-------------------------------------------------+
320|tenantId |String |Name of the Subscriber |
321+-------------------------+------------------+-------------------------------------------------+
322
323RequestInfo Object
324
325+-------------------------+------------------+-------------------------------------------------+
326|Attribute |Content |Description |
327+=========================+==================+=================================================+
328|Source |String |source of the request |
329+-------------------------+------------------+-------------------------------------------------+
330
331Create VF Module
332+++++++++++++++++
333
334+--------------------+----------------------------------------------------------------------------------------+
335|Interface Definition|Description |
336+====================+========================================================================================+
337|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
338+--------------------+----------------------------------------------------------------------------------------+
339|Operation Type |POST |
340+--------------------+----------------------------------------------------------------------------------------+
341|Content-Type |application/json |
342+--------------------+----------------------------------------------------------------------------------------+
343
344Request Body:
345
346+----------------+---------+-----------+--------------------------+-------------------------------------------+
347|Attribute |Qualifier|Cardinality|Content |Description |
348+================+=========+===========+==========================+===========================================+
349|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
350+----------------+---------+-----------+--------------------------+-------------------------------------------+
351
352RequestDetails Object
353
354+---------------------+-------------------------+-------------------------------------------------+
355|Attribute |Content |Description |
356+=====================+=========================+=================================================+
357|modelInfo |modelInfo Object |Content of modelInfo object. |
358+---------------------+-------------------------+-------------------------------------------------+
359|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
360+---------------------+-------------------------+-------------------------------------------------+
361|requestInfo |requestInfo Object |Content of requestInfo object. |
362+---------------------+-------------------------+-------------------------------------------------+
363|relatedInstanceList |List |Content of relatedInstanceList. |
364+---------------------+-------------------------+-------------------------------------------------+
365
366ModelInfo Object
367
368+-------------------------+------------------+-------------------------------------------------+
369|Attribute |Content |Description |
370+=========================+==================+=================================================+
371|ModelType |String |Type of model |
372+-------------------------+------------------+-------------------------------------------------+
373|ModelInvariantId |String |The Model Invariant Id. |
374+-------------------------+------------------+-------------------------------------------------+
375|ModelNameVersionId |String |The modelname Version Id |
376+-------------------------+------------------+-------------------------------------------------+
377|ModelName |String |Name of the Model |
378+-------------------------+------------------+-------------------------------------------------+
379|ModelVersion |String |Version of the model |
380+-------------------------+------------------+-------------------------------------------------+
381|ModelCustomization Name |String |The Model Customization name |
382+-------------------------+------------------+-------------------------------------------------+
383
384CloudConfiguration Object
385
386+-------------------------+------------------+-------------------------------------------------+
387|Attribute |Content |Description |
388+=========================+==================+=================================================+
389|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
390+-------------------------+------------------+-------------------------------------------------+
391|tenantId |String |Name of the Subscriber |
392+-------------------------+------------------+-------------------------------------------------+
393
394RequestInfo Object
395
396+-------------------------+------------------+-------------------------------------------------+
397|Attribute |Content |Description |
398+=========================+==================+=================================================+
399|InstanceName |String |The instance Name |
400+-------------------------+------------------+-------------------------------------------------+
401|Source |String |source of the request |
402+-------------------------+------------------+-------------------------------------------------+
403|SuppressRollback |Boolean |SuppressRollback |
404+-------------------------+------------------+-------------------------------------------------+
405
406relatedInstance List
407
408+-------------------------+------------------+-------------------------------------------------+
409|Attribute |Content |Description |
410+=========================+==================+=================================================+
411|relatedInstance |Object |relatedInstance Object |
412+-------------------------+------------------+-------------------------------------------------+
413
414relatedInstance List
415
416+-------------------------+------------------+-------------------------------------------------+
417|Attribute |Content |Description |
418+=========================+==================+=================================================+
419|instanceId |String |instanceId |
420+-------------------------+------------------+-------------------------------------------------+
421|modelInfo |Object |Content of modelInfo object. |
422+-------------------------+------------------+-------------------------------------------------+
423|instanceName |String |Name of the instance |
424+-------------------------+------------------+-------------------------------------------------+
425
426Delete VF Module
427++++++++++++++++++++++++
428
429+--------------------+--------------------------------------------------------------------------------------------------------------+
430|Interface Definition|Description |
431+====================+==============================================================================================================+
432|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
433+--------------------+--------------------------------------------------------------------------------------------------------------+
434|Operation Type |DELETE |
435+--------------------+--------------------------------------------------------------------------------------------------------------+
436|Content-Type |application/json |
437+--------------------+--------------------------------------------------------------------------------------------------------------+
438
439Request Body:
440
441+----------------+---------+-----------+--------------------------+-------------------------------------------+
442|Attribute |Qualifier|Cardinality|Content |Description |
443+================+=========+===========+==========================+===========================================+
444|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
445+----------------+---------+-----------+--------------------------+-------------------------------------------+
446
447RequestDetails Object
448
449+---------------------+-------------------------+-------------------------------------------------+
450|Attribute |Content |Description |
451+=====================+=========================+=================================================+
452|modelInfo |modelInfo Object |Content of modelInfo object. |
453+---------------------+-------------------------+-------------------------------------------------+
454|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
455+---------------------+-------------------------+-------------------------------------------------+
456|requestInfo |requestInfo Object |Content of requestInfo object. |
457+---------------------+-------------------------+-------------------------------------------------+
458
459ModelInfo Object
460
461+-------------------------+------------------+-------------------------------------------------+
462|Attribute |Content |Description |
463+=========================+==================+=================================================+
464|ModelType |String |Type of model |
465+-------------------------+------------------+-------------------------------------------------+
466|ModelInvariantId |String |The Model Invariant Id. |
467+-------------------------+------------------+-------------------------------------------------+
468|ModelNameVersionId |String |The modelname Version Id |
469+-------------------------+------------------+-------------------------------------------------+
470|ModelName |String |Name of the Model |
471+-------------------------+------------------+-------------------------------------------------+
472|ModelVersion |String |Version of the model |
473+-------------------------+------------------+-------------------------------------------------+
474|ModelCustomization Name |String |The Model Customization name |
475+-------------------------+------------------+-------------------------------------------------+
476
477CloudConfiguration Object
478
479+-------------------------+------------------+-------------------------------------------------+
480|Attribute |Content |Description |
481+=========================+==================+=================================================+
482|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
483+-------------------------+------------------+-------------------------------------------------+
484|tenantId |String |Name of the Subscriber |
485+-------------------------+------------------+-------------------------------------------------+
486
487RequestInfo Object
488
489+-------------------------+------------------+-------------------------------------------------+
490|Attribute |Content |Description |
491+=========================+==================+=================================================+
492|Source |String |source of the request |
493+-------------------------+------------------+-------------------------------------------------+
494
495Create VNF
496+++++++++++++++
497
498+--------------------+--------------------------------------------------------------+
499|Interface Definition|Description |
500+====================+==============================================================+
501|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs |
502+--------------------+--------------------------------------------------------------+
503|Operation Type |POST |
504+--------------------+--------------------------------------------------------------+
505|Content-Type |application/json |
506+--------------------+--------------------------------------------------------------+
507
508Request Body:
509
510+----------------+---------+-----------+--------------------------+-------------------------------------------+
511|Attribute |Qualifier|Cardinality|Content |Description |
512+================+=========+===========+==========================+===========================================+
513|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
514+----------------+---------+-----------+--------------------------+-------------------------------------------+
515
516RequestDetails Object
517
518+---------------------+-------------------------+-------------------------------------------------+
519|Attribute |Content |Description |
520+=====================+=========================+=================================================+
521|modelInfo |modelInfo Object |Content of modelInfo object. |
522+---------------------+-------------------------+-------------------------------------------------+
523|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
524+---------------------+-------------------------+-------------------------------------------------+
525|requestInfo |requestInfo Object |Content of requestInfo object. |
526+---------------------+-------------------------+-------------------------------------------------+
527|relatedInstanceList |List |Content of relatedInstanceList. |
528+---------------------+-------------------------+-------------------------------------------------+
529|requestParameters |requestParameters Object |Content of requestParameters object. |
530+---------------------+-------------------------+-------------------------------------------------+
531
532ModelInfo Object
533
534+-------------------------+------------------+-------------------------------------------------+
535|Attribute |Content |Description |
536+=========================+==================+=================================================+
537|ModelType |String |Type of model |
538+-------------------------+------------------+-------------------------------------------------+
539|ModelInvariantId |String |The Model Invariant Id. |
540+-------------------------+------------------+-------------------------------------------------+
541|ModelNameVersionId |String |The modelname Version Id |
542+-------------------------+------------------+-------------------------------------------------+
543|ModelName |String |Name of the Model |
544+-------------------------+------------------+-------------------------------------------------+
545|ModelVersion |String |Version of the model |
546+-------------------------+------------------+-------------------------------------------------+
547|ModelCustomization Name |String |The Model Customization name |
548+-------------------------+------------------+-------------------------------------------------+
549
550CloudConfiguration Object
551
552+-------------------------+------------------+-------------------------------------------------+
553|Attribute |Content |Description |
554+=========================+==================+=================================================+
555|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
556+-------------------------+------------------+-------------------------------------------------+
557|tenantId |String |Name of the Subscriber |
558+-------------------------+------------------+-------------------------------------------------+
559
560RequestInfo Object
561
562+-------------------------+------------------+-------------------------------------------------+
563|Attribute |Content |Description |
564+=========================+==================+=================================================+
565|InstanceName |String |The instance Name |
566+-------------------------+------------------+-------------------------------------------------+
567|ProductFamilyId |String |The product family Id. |
568+-------------------------+------------------+-------------------------------------------------+
569|Source |String |source of the request |
570+-------------------------+------------------+-------------------------------------------------+
571|SuppressRollback |Boolean |SuppressRollback |
572+-------------------------+------------------+-------------------------------------------------+
573
574relatedInstance List
575
576+-------------------------+------------------+-------------------------------------------------+
577|Attribute |Content |Description |
578+=========================+==================+=================================================+
579|relatedInstance |Object |relatedInstance Object |
580+-------------------------+------------------+-------------------------------------------------+
581
582relatedInstance List
583
584+-------------------------+------------------+-------------------------------------------------+
585|Attribute |Content |Description |
586+=========================+==================+=================================================+
587|instanceId |String |instanceId |
588+-------------------------+------------------+-------------------------------------------------+
589|modelInfo |Object |Content of modelInfo object. |
590+-------------------------+------------------+-------------------------------------------------+
591
592RequestParameters Object
593
594+-------------------------+------------------+-------------------------------------------------+
595|Attribute |Content |Description |
596+=========================+==================+=================================================+
597|UserParams |Array |The product family Id. |
598+-------------------------+------------------+-------------------------------------------------+
599
600UserParams Object
601
602+-------------------------+------------------+-------------------------------------------------+
603|Attribute |Content |Description |
604+=========================+==================+=================================================+
605|name |String |Tag name of attribute |
606+-------------------------+------------------+-------------------------------------------------+
607|value |String |Value of the tag |
608+-------------------------+------------------+-------------------------------------------------+
609
610Delete VNF
611+++++++++++++++
612
613+--------------------+------------------------------------------------------------------------------+
614|Interface Definition|Description |
615+====================+==============================================================================+
616|URI |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId} |
617+--------------------+------------------------------------------------------------------------------+
618|Operation Type |DELETE |
619+--------------------+------------------------------------------------------------------------------+
620|Content-Type |application/json |
621+--------------------+------------------------------------------------------------------------------+
622
623Request Body:
624
625+----------------+---------+-----------+--------------------------+-------------------------------------------+
626|Attribute |Qualifier|Cardinality|Content |Description |
627+================+=========+===========+==========================+===========================================+
628|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
629+----------------+---------+-----------+--------------------------+-------------------------------------------+
630
631RequestDetails Object
632
633+---------------------+-------------------------+-------------------------------------------------+
634|Attribute |Content |Description |
635+=====================+=========================+=================================================+
636|modelInfo |modelInfo Object |Content of modelInfo object. |
637+---------------------+-------------------------+-------------------------------------------------+
638|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
639+---------------------+-------------------------+-------------------------------------------------+
640|requestInfo |requestInfo Object |Content of requestInfo object. |
641+---------------------+-------------------------+-------------------------------------------------+
642|requestParameters |requestParameters Object |Content of requestParameters object. |
643+---------------------+-------------------------+-------------------------------------------------+
644
645ModelInfo Object
646
647+-------------------------+------------------+-------------------------------------------------+
648|Attribute |Content |Description |
649+=========================+==================+=================================================+
650|ModelType |String |Type of model |
651+-------------------------+------------------+-------------------------------------------------+
652|ModelName |String |Name of the Model |
653+-------------------------+------------------+-------------------------------------------------+
654
655CloudConfiguration Object
656
657+-------------------------+------------------+-------------------------------------------------+
658|Attribute |Content |Description |
659+=========================+==================+=================================================+
660|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
661+-------------------------+------------------+-------------------------------------------------+
662|tenantId |String |Name of the Subscriber |
663+-------------------------+------------------+-------------------------------------------------+
664
665RequestInfo Object
666
667+-------------------------+------------------+-------------------------------------------------+
668|Attribute |Content |Description |
669+=========================+==================+=================================================+
670|Source |String |source of the request |
671+-------------------------+------------------+-------------------------------------------------+
672
673RequestParameters Object
674
675+-------------------------+------------------+-------------------------------------------------+
676|Attribute |Content |Description |
677+=========================+==================+=================================================+
678|UserParams |Array |The product family Id. |
679+-------------------------+------------------+-------------------------------------------------+
680
681UserParams Object
682
683+-------------------------+------------------+-------------------------------------------------+
684|Attribute |Content |Description |
685+=========================+==================+=================================================+
686|name |String |Tag name of attribute |
687+-------------------------+------------------+-------------------------------------------------+
688|value |String |Value of the tag |
689+-------------------------+------------------+-------------------------------------------------+
690
691GET Orchestration Request
692++++++++++++++++++++++++++
693
694+--------------------+--------------------------------------------------------------+
695|Interface Definition|Description |
696+====================+==============================================================+
697|URI |{serverRoot}/orchestrationRequests/v2/{request-id} |
698+--------------------+--------------------------------------------------------------+
699|Operation Type |GET |
700+--------------------+--------------------------------------------------------------+
701|Content-Type |application/json |
702+--------------------+--------------------------------------------------------------+
703
704Response Body:
705
706+----------------+---------+-----------+--------------------------+-------------------------------------------+
707|Attribute |Qualifier|Cardinality|Content |Description |
708+================+=========+===========+==========================+===========================================+
709|request |M |1 |request Object |Content of request object. |
710+----------------+---------+-----------+--------------------------+-------------------------------------------+
711
712Request Object
713
714+-------------------+---------+-----------+--------------------------+-------------------------------------------+
715|Attribute |Qualifier|Cardinality|Content |Description |
716+===================+=========+===========+==========================+===========================================+
717|requestId |M |1 |String |Request Id |
718+-------------------+---------+-----------+--------------------------+-------------------------------------------+
719|startTime |M |1 |request Object |Start time. |
720+-------------------+---------+-----------+--------------------------+-------------------------------------------+
721|serviceInstanceId |M |1 |request Object |Service Instance id. |
722+-------------------+---------+-----------+--------------------------+-------------------------------------------+
723|requestScope |M |1 |request Object |Scope of the request. |
724+-------------------+---------+-----------+--------------------------+-------------------------------------------+
725|requestType |M |1 |request Object |Type of the request. |
726+-------------------+---------+-----------+--------------------------+-------------------------------------------+
727|requestDetails |M |1 |requestDetails Object |Type of the request. |
728+-------------------+---------+-----------+--------------------------+-------------------------------------------+
729|requestStatus |M |1 |requestStatus Object |Type of the request. |
730+-------------------+---------+-----------+--------------------------+-------------------------------------------+
731
732RequestDetails Object
733
734+-------------------+-------------------------+-------------------------------------------------+
735|Attribute |Content |Description |
736+===================+=========================+=================================================+
737|modelInfo |modelInfo Object |Content of modelInfo object. |
738+-------------------+-------------------------+-------------------------------------------------+
739|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
740+-------------------+-------------------------+-------------------------------------------------+
741|requestInfo |requestInfo Object |Content of requestInfo object. |
742+-------------------+-------------------------+-------------------------------------------------+
743|requestParameters |requestParameters Object |Content of requestParameters object. |
744+-------------------+-------------------------+-------------------------------------------------+
745
746ModelInfo Object
747
748+-------------------------+------------------+-------------------------------------------------+
749|Attribute |Content |Description |
750+=========================+==================+=================================================+
751|ModelType |String |Type of model |
752+-------------------------+------------------+-------------------------------------------------+
753|ModelInvariantId |String |The Model Invariant Id. |
754+-------------------------+------------------+-------------------------------------------------+
755|ModelNameVersionId |String |The modelname Version Id |
756+-------------------------+------------------+-------------------------------------------------+
757|ModelName |String |Name of the Model |
758+-------------------------+------------------+-------------------------------------------------+
759|ModelVersion |String |Version of the model |
760+-------------------------+------------------+-------------------------------------------------+
761
762SubscriberInfo Object
763
764+-------------------------+------------------+-------------------------------------------------+
765|Attribute |Content |Description |
766+=========================+==================+=================================================+
767|GlobalSubscriberId |String |Global customer Id (in A&AI) |
768+-------------------------+------------------+-------------------------------------------------+
769|SubscriberName |String |Name of the Subscriber |
770+-------------------------+------------------+-------------------------------------------------+
771
772RequestInfo Object
773
774+-------------------------+------------------+-------------------------------------------------+
775|Attribute |Content |Description |
776+=========================+==================+=================================================+
777|InstanceName |String |The instance Name |
778+-------------------------+------------------+-------------------------------------------------+
779|Source |String |source of the request |
780+-------------------------+------------------+-------------------------------------------------+
781|SuppressRollback |Boolean |SuppressRollback |
782+-------------------------+------------------+-------------------------------------------------+
783
784RequestParameters Object
785
786+-------------------------+------------------+-------------------------------------------------+
787|Attribute |Content |Description |
788+=========================+==================+=================================================+
789|SubscriptionServiceType |String |The service type of the Subscription |
790+-------------------------+------------------+-------------------------------------------------+
791
792RequestStatus Object
793
794+-------------------------+------------------+-------------------------------------------------+
795|Attribute |Content |Description |
796+=========================+==================+=================================================+
797|timestamp |String |Time |
798+-------------------------+------------------+-------------------------------------------------+
799|requestState |String |state of the request |
800+-------------------------+------------------+-------------------------------------------------+
801|statusMessage |String |statusMessage |
802+-------------------------+------------------+-------------------------------------------------+
803|percentProgress |String |percentage of progress |
804+-------------------------+------------------+-------------------------------------------------+
805
806GET Orchestration Requests
807++++++++++++++++++++++++++
808
809+--------------------+--------------------------------------------------------------+
810|Interface Definition|Description |
811+====================+==============================================================+
812|URI |{serverRoot}/orchestrationRequests/v2 |
813+--------------------+--------------------------------------------------------------+
814|Operation Type |GET |
815+--------------------+--------------------------------------------------------------+
816|Content-Type |application/json |
817+--------------------+--------------------------------------------------------------+
818
819Response Body:
820
821+----------------+---------+-----------+--------------------------+-------------------------------------------+
822|Attribute |Qualifier|Cardinality|Content |Description |
823+================+=========+===========+==========================+===========================================+
824|requestList |M |1 |Array |Content of request List. |
825+----------------+---------+-----------+--------------------------+-------------------------------------------+
826
827RequestList :
828
829+----------------+---------+-----------+--------------------------+-------------------------------------------+
830|Attribute |Qualifier|Cardinality|Content |Description |
831+================+=========+===========+==========================+===========================================+
832|request |M |1 |request Object |Content of request object. |
833+----------------+---------+-----------+--------------------------+-------------------------------------------+
834
835Request Object
836
837+-------------------+---------+-----------+--------------------------+-------------------------------------------+
838|Attribute |Qualifier|Cardinality|Content |Description |
839+===================+=========+===========+==========================+===========================================+
840|requestId |M |1 |String |Request Id |
841+-------------------+---------+-----------+--------------------------+-------------------------------------------+
842|startTime |M |1 |request Object |Start time. |
843+-------------------+---------+-----------+--------------------------+-------------------------------------------+
844|serviceInstanceId |M |1 |request Object |Service Instance id. |
845+-------------------+---------+-----------+--------------------------+-------------------------------------------+
846|requestScope |M |1 |request Object |Scope of the request. |
847+-------------------+---------+-----------+--------------------------+-------------------------------------------+
848|requestType |M |1 |request Object |Type of the request. |
849+-------------------+---------+-----------+--------------------------+-------------------------------------------+
850|requestDetails |M |1 |requestDetails Object |Type of the request. |
851+-------------------+---------+-----------+--------------------------+-------------------------------------------+
852|requestStatus |M |1 |requestStatus Object |Type of the request. |
853+-------------------+---------+-----------+--------------------------+-------------------------------------------+
854
855RequestDetails Object
856
857+-------------------+-------------------------+-------------------------------------------------+
858|Attribute |Content |Description |
859+===================+=========================+=================================================+
860|modelInfo |modelInfo Object |Content of modelInfo object. |
861+-------------------+-------------------------+-------------------------------------------------+
862|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
863+-------------------+-------------------------+-------------------------------------------------+
864|requestInfo |requestInfo Object |Content of requestInfo object. |
865+-------------------+-------------------------+-------------------------------------------------+
866|requestParameters |requestParameters Object |Content of requestParameters object. |
867+-------------------+-------------------------+-------------------------------------------------+
868
869ModelInfo Object
870
871+-------------------------+------------------+-------------------------------------------------+
872|Attribute |Content |Description |
873+=========================+==================+=================================================+
874|ModelType |String |Type of model |
875+-------------------------+------------------+-------------------------------------------------+
876|ModelInvariantId |String |The Model Invariant Id. |
877+-------------------------+------------------+-------------------------------------------------+
878|ModelNameVersionId |String |The modelname Version Id |
879+-------------------------+------------------+-------------------------------------------------+
880|ModelName |String |Name of the Model |
881+-------------------------+------------------+-------------------------------------------------+
882|ModelVersion |String |Version of the model |
883+-------------------------+------------------+-------------------------------------------------+
884
885SubscriberInfo Object
886
887+-------------------------+------------------+-------------------------------------------------+
888|Attribute |Content |Description |
889+=========================+==================+=================================================+
890|GlobalSubscriberId |String |Global customer Id (in A&AI) |
891+-------------------------+------------------+-------------------------------------------------+
892|SubscriberName |String |Name of the Subscriber |
893+-------------------------+------------------+-------------------------------------------------+
894
895RequestInfo Object
896
897+-------------------------+------------------+-------------------------------------------------+
898|Attribute |Content |Description |
899+=========================+==================+=================================================+
900|InstanceName |String |The instance Name |
901+-------------------------+------------------+-------------------------------------------------+
902|Source |String |source of the request |
903+-------------------------+------------------+-------------------------------------------------+
904|SuppressRollback |Boolean |SuppressRollback |
905+-------------------------+------------------+-------------------------------------------------+
906
907RequestParameters Object
908
909+-------------------------+------------------+-------------------------------------------------+
910|Attribute |Content |Description |
911+=========================+==================+=================================================+
912|SubscriptionServiceType |String |The service type of the Subscription |
913+-------------------------+------------------+-------------------------------------------------+
914
915RequestStatus Object
916
917+-------------------------+------------------+-------------------------------------------------+
918|Attribute |Content |Description |
919+=========================+==================+=================================================+
920|timestamp |String |Time |
921+-------------------------+------------------+-------------------------------------------------+
922|requestState |String |state of the request |
923+-------------------------+------------------+-------------------------------------------------+
924|statusMessage |String |statusMessage |
925+-------------------------+------------------+-------------------------------------------------+
926|percentProgress |String |percentage of progress |
927+-------------------------+------------------+-------------------------------------------------+
928
929SDC API
930--------
931
932Get List of Existing Catalog Assets
933+++++++++++++++++++++++++++++++++++
934
935+--------------------+--------------------------+
936|Interface Definition|Description |
937+====================+==========================+
938|URI |sdc/v1/catalog/{assetType}|
939+--------------------+--------------------------+
940|Operation Type |GET |
941+--------------------+--------------------------+
942
943Request Parameters:
944
945+-------------------+---------+-----------+-------+-------------------------------------------------------------+
946|Attribute |Qualifier|Cardinality|Content|Description |
947+===================+=========+===========+=======+=============================================================+
948|assetType |M |1 |String |The requested asset type.valid values are resources/services.|
949+-------------------+---------+-----------+-------+-------------------------------------------------------------+
950|service-type |M |1 |String |Service Type |
951+-------------------+---------+-----------+-------+-------------------------------------------------------------+
952|service-instance-id|M |1 |String |Service Instance ID |
953+-------------------+---------+-----------+-------+-------------------------------------------------------------+
954
955Request Headers:
956
957+-------------------+---------+-----------------------------------------------------------------------------------------+
958|Header Name |Qualifier|Description |
959+===================+=========+=========================================================================================+
960|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
961+-------------------+---------+-----------------------------------------------------------------------------------------+
962|X-ECOMP-InstanceID |Y |Instance ID |
963+-------------------+---------+-----------------------------------------------------------------------------------------+
964|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
965+-------------------+---------+-----------------------------------------------------------------------------------------+
966|Authorization |Y |Base64 encoded username:password |
967+-------------------+---------+-----------------------------------------------------------------------------------------+
968
969Response:
970
971+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
972|Attribute |Qualifier|Cardinality|Content|Description |
973+==================+=========+===========+=======+======================================================================================+
974|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
975+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
976|invariantUUID |M |1 |String |UUID generated by SDC per each asset. |
977+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
978|name |M |1 |String |The name of the asset |
979+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
980|version |M |1 |String |The asset version in SDC catalog. |
981+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
982|toscaModelURL |M |1 |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
983+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
984|category |M |1 |String |Category of the asset. |
985+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
986|subcategory |M |1 |String |Sub-category of the asset |
987+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
988|resourceType |M |1 |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF. |
989+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
990|lifecycleState |M |1 |String |The lifecycle state of the asset |
991+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
992|lastUpdaterUserId |M |1 |String |UserID of the SDC designer who was the last to update the asset for this major version|
993+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
994
995Get Specific Asset Detailed Metadata
996++++++++++++++++++++++++++++++++++++
997
998+--------------------+-------------------------------------------+
999|Interface Definition|Description |
1000+====================+===========================================+
1001|URI |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
1002+--------------------+-------------------------------------------+
1003|Operation Type |GET |
1004+--------------------+-------------------------------------------+
1005
1006Request Parameters:
1007
1008+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1009|Attribute |Qualifier|Cardinality|Content|Description |
1010+===================+=========+===========+=======+=====================================================================================+
1011|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1012+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1013|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
1014+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1015
1016Request Headers:
1017
1018+-------------------+---------+-----------------------------------------------------------------------------------------+
1019|Header Name |Qualifier|Description |
1020+===================+=========+=========================================================================================+
1021|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1022+-------------------+---------+-----------------------------------------------------------------------------------------+
1023|X-ECOMP-InstanceID |Y |Instance ID |
1024+-------------------+---------+-----------------------------------------------------------------------------------------+
1025|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1026+-------------------+---------+-----------------------------------------------------------------------------------------+
1027|Authorization |Y |Base64 encoded username:password |
1028+-------------------+---------+-----------------------------------------------------------------------------------------+
1029
1030Response:
1031
1032+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1033|Attribute |Qualifier|Content|Description |
1034+====================+=========+=======+======================================================================================+
1035|uuid |M |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1036+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1037|invariantUUID |M |String |UUID generated by SDC per each asset. |
1038+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1039|name |M |String |The name of the asset |
1040+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1041|version |M |String |The asset version in SDC catalog. |
1042+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1043|toscaModelURL |M |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
1044+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1045|description |M |String |Short description of the resource |
1046+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1047|lastUpdaterUserId |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1048+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1049|lastUpdaterFullName |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1050+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1051|category |M |String |Category of the asset |
1052+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1053|subCategory |M |String |Sub-category of the asset. |
1054+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1055|toscaResourceName |M |String |The full name of the asset |
1056+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1057|resourceType |M |String |The type of resource. |
1058+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1059|lifecycleState |M |String |The lifecycle state of the asset |
1060+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1061|resources |N |Object |Category of the asset |
1062+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1063|artifacts |M |Object |Category of the asset |
1064+--------------------+---------+-------+--------------------------------------------------------------------------------------+
1065
1066Resource Object:
1067
1068+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1069|Attribute |Qualifier|Content|Description | |
1070+=====================+=========+=======+===================================================================================================================+
1071|resourceInstanceName |M |String |Logical Resource Instance Name.Unique Identifier of the instance of the specific resource in the service context.|
1072+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1073|resourceName |M |String |Resource Name |
1074+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1075|resourceInvariantUUID|M |String |The invariant UUID of the resource |
1076+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1077|resourceVersion |M |String |Resource Version |
1078+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1079|resoucreType |M |String |Resource Type |
1080+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1081|resourceUUID |M |String |Global UUID of the resource that specific artifact belongs to |
1082+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1083|artifacts |M |Object |Array of resource instance deployment artifacts. |
1084+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1085
1086Artifact Metadata Object:
1087
1088+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1089|Attribute |Qualifier|Content |Description |
1090+=====================+=========+========+===================================================================================================================+
1091|artifactName |M |String |Artifact File name |
1092+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1093|artifactLabel |M |String |Identifier of the artifact within the VF / Service. |
1094+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1095|artifactType |M |String |Artifact Type |
1096+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1097|artifactGroupType |M |String |Whether the artifact is informational or deployment. |
1098+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1099|artifactURL |M |String |Relative artifact’s URL. |
1100+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1101|artifactDescription |M |String |Artifact Description |
1102+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1103|artifactTimeout |N |Integer |Artifact Description |
1104+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1105|artifactChecksum |M |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1106+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1107|artifactUUID |M |String |Global UUID generated by SDC each time when artifact payload is updated. |
1108+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1109|artifactVersion |M |String |Service Version |
1110+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1111|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1112+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1113
1114Download (CSAR of) Specific Asset
1115+++++++++++++++++++++++++++++++++
1116
1117+--------------------+-----------------------------------------------------------+
1118|Interface Definition|Description |
1119+====================+===========================================================+
1120|URI |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
1121+--------------------+-----------------------------------------------------------+
1122|Operation Type |GET |
1123+--------------------+-----------------------------------------------------------+
1124
1125Request Parameters:
1126
1127+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1128|Attribute |Qualifier|Cardinality|Content|Description |
1129+===================+=========+===========+=======+=====================================================================================+
1130|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1131+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1132|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1133+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1134|artifactUUID |M |1 |String |The artifactUUID of the asset as published in the metadata |
1135+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1136
1137Response:
1138
1139+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1140|Header name |Qualifier|Description |
1141+====================+=========+==========================================================================================================================+
1142|Content-Type |M |Specifies the downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
1143+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1144|Content-Length |M |Streamed artifact payload size |
1145+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1146|Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . |
1147+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1148
1149Upload Artifact
1150+++++++++++++++
1151
1152+--------------------+-----------------------------------------------------------------------------------------------+
1153|Interface Definition|Description |
1154+====================+===============================================================================================+
1155|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
1156+--------------------+-----------------------------------------------------------------------------------------------+
1157|Operation Type |POST |
1158+--------------------+-----------------------------------------------------------------------------------------------+
1159
1160Request Parameters:
1161
1162+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1163|Attribute |Qualifier|Cardinality|Content|Description |
1164+==============================+=========+===========+=======+=====================================================================================+
1165|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1166+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1167|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1168+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1169|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1170+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1171
1172Request Body
1173++++++++++++
1174
1175+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1176|Attribute |Qualifier|Cardinality|Content|Description |
1177+==============================+=========+===========+=======+=====================================================================================+
1178|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1179+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1180|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1181+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1182|artifactName |M |1 |String |The name of the artifact |
1183+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1184|artifactType |M |1 |String |The type of the artifact |
1185+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1186|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1187+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1188|description |M |1 |String |Description of the artifact |
1189+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1190
1191Request Headers:
1192
1193+-------------------+---------+-----------------------------------------------------------------------------------------+
1194|Header Name |Qualifier|Description |
1195+===================+=========+=========================================================================================+
1196|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1197+-------------------+---------+-----------------------------------------------------------------------------------------+
1198|X-ECOMP-InstanceID |Y |Instance ID |
1199+-------------------+---------+-----------------------------------------------------------------------------------------+
1200|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1201+-------------------+---------+-----------------------------------------------------------------------------------------+
1202|Authorization |Y |Base64 encoded username:password |
1203+-------------------+---------+-----------------------------------------------------------------------------------------+
1204|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1205+-------------------+---------+-----------------------------------------------------------------------------------------+
1206|Content-Type |Y |Valid value is : application/json |
1207+-------------------+---------+-----------------------------------------------------------------------------------------+
1208|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1209+-------------------+---------+-----------------------------------------------------------------------------------------+
1210
1211Response:
1212
1213+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1214|Attribute |Qualifier|Content|Description |
1215+====================+=========+=======+===================================================================================================+
1216|artifactName |M |String |Artifact File name |
1217+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1218|artifactType |M |String |Artifact Type |
1219+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1220|artifactURL |M |String |Relative artifact’s URL. |
1221+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1222|artifactDescription |M |String |Artifact Description. |
1223+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1224|artifactTimeout |N |String |Will be populated only if its value is not 0. |
1225+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1226|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1227+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1228|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1229+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1230|artifactVersion |Y |String |Service Version . |
1231+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1232|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1233+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1234
1235Update Artifact
1236+++++++++++++++
1237
1238+--------------------+--------------------------------------------------------------------------------------------------------------+
1239|Interface Definition|Description |
1240+====================+==============================================================================================================+
1241|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1242+--------------------+--------------------------------------------------------------------------------------------------------------+
1243|Operation Type |POST |
1244+--------------------+--------------------------------------------------------------------------------------------------------------+
1245
1246Request Parameters:
1247
1248+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1249|Attribute |Qualifier|Cardinality|Content|Description |
1250+==============================+=========+===========+=======+=====================================================================================+
1251|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1252+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1253|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1254+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1255|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1256+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1257|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1258+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1259
1260Request Headers:
1261
1262+-------------------+---------+-----------------------------------------------------------------------------------------+
1263|Header Name |Qualifier|Description |
1264+===================+=========+=========================================================================================+
1265|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1266+-------------------+---------+-----------------------------------------------------------------------------------------+
1267|X-ECOMP-InstanceID |Y |Instance ID |
1268+-------------------+---------+-----------------------------------------------------------------------------------------+
1269|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1270+-------------------+---------+-----------------------------------------------------------------------------------------+
1271|Authorization |Y |Base64 encoded username:password |
1272+-------------------+---------+-----------------------------------------------------------------------------------------+
1273|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1274+-------------------+---------+-----------------------------------------------------------------------------------------+
1275|Content-Type |Y |Valid value is : application/json |
1276+-------------------+---------+-----------------------------------------------------------------------------------------+
1277|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1278+-------------------+---------+-----------------------------------------------------------------------------------------+
1279
1280Request Body:
1281
1282+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1283|Attribute |Qualifier|Cardinality|Content|Description |
1284+==============================+=========+===========+=======+=====================================================================================+
1285|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1286+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1287|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1288+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1289|artifactName |M |1 |String |The name of the artifact |
1290+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1291|artifactType |M |1 |String |The type of the artifact |
1292+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1293|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1294+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1295|description |M |1 |String |Description of the artifact |
1296+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1297
1298Response:
1299
1300+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1301|Attribute |Qualifier|Content|Description |
1302+====================+=========+=======+===================================================================================================+
1303|artifactName |M |String |Artifact File name |
1304+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1305|artifactType |M |String |Artifact Type |
1306+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1307|artifactURL |M |String |Relative artifact’s URL. |
1308+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1309|artifactDescription |M |String |Artifact Description. |
1310+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1311|artifactTimeout |N |String |Will be populated only if its value is not 0. |
1312+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1313|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1314+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1315|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1316+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1317|artifactVersion |Y |String |Service Version . |
1318+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1319|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1320+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1321
1322Delete Artifact
1323+++++++++++++++
1324
1325+--------------------+--------------------------------------------------------------------------------------------------------------+
1326|Interface Definition|Description |
1327+====================+==============================================================================================================+
1328|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1329+--------------------+--------------------------------------------------------------------------------------------------------------+
1330|Operation Type |DELETE |
1331+--------------------+--------------------------------------------------------------------------------------------------------------+
1332
1333Request Parameters:
1334
1335+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1336|Attribute |Qualifier|Cardinality|Content|Description |
1337+==============================+=========+===========+=======+=====================================================================================+
1338|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1339+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1340|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1341+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1342|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1343+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1344|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1345+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1346
1347Request Headers:
1348
1349+-------------------+---------+-----------------------------------------------------------------------------------------+
1350|Header Name |Qualifier|Description |
1351+===================+=========+=========================================================================================+
1352|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1353+-------------------+---------+-----------------------------------------------------------------------------------------+
1354|X-ECOMP-InstanceID |Y |Instance ID |
1355+-------------------+---------+-----------------------------------------------------------------------------------------+
1356|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1357+-------------------+---------+-----------------------------------------------------------------------------------------+
1358|Authorization |Y |Base64 encoded username:password |
1359+-------------------+---------+-----------------------------------------------------------------------------------------+
1360|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1361+-------------------+---------+-----------------------------------------------------------------------------------------+
1362
1363Response:
1364
1365+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1366|Attribute |Qualifier|Content|Description |
1367+====================+=========+=======+===================================================================================================+
1368|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1369+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1370
1371Update Lifecycle
1372++++++++++++++++
1373
1374+--------------------+--------------------------------------------------------------------------------------------------------------+
1375|Interface Definition|Description |
1376+====================+==============================================================================================================+
1377|URI |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation} |
1378+--------------------+--------------------------------------------------------------------------------------------------------------+
1379|Operation Type |POST |
1380+--------------------+--------------------------------------------------------------------------------------------------------------+
1381
1382Request Parameters:
1383
1384+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1385|Attribute |Qualifier|Cardinality|Content|Description |
1386+==============================+=========+===========+=======+=====================================================================================================+
1387|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1388+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1389|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1390+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1391|lifecycleOperation |M |1 |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout / Certify |
1392+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1393
1394Request Headers:
1395
1396+-------------------+---------+-----------------------------------------------------------------------------------------+
1397|Header Name |Qualifier|Description |
1398+===================+=========+=========================================================================================+
1399|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1400+-------------------+---------+-----------------------------------------------------------------------------------------+
1401|X-ECOMP-InstanceID |Y |Instance ID |
1402+-------------------+---------+-----------------------------------------------------------------------------------------+
1403|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1404+-------------------+---------+-----------------------------------------------------------------------------------------+
1405|Authorization |Y |Base64 encoded username:password |
1406+-------------------+---------+-----------------------------------------------------------------------------------------+
1407|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1408+-------------------+---------+-----------------------------------------------------------------------------------------+
1409
1410Request Parameters:
1411
1412+-------------------+---------+-----------------------------------------------------------------------------------------+
1413|Attribute |Qualifier|Description |
1414+===================+=========+=========================================================================================+
1415|userRemarks |N |Short description (free text) about the asset version being changed |
1416+-------------------+---------+-----------------------------------------------------------------------------------------+
1417
1418Response:
1419
1420+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1421|Attribute |Qualifier|Content|Description |
1422+====================+=========+=======+===================================================================================================+
1423|uuid |Y |String |UUID generated by SDC per each major version of the asset |
1424+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1425|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1426+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1427|name |Y |String |The name of the asset. |
1428+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1429|version |Y |String |The asset version in SDC catalog |
1430+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1431|category |Y |String |Category of the asset. |
1432+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1433|subcategory |Y |String |Sub-category of the asset. |
1434+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1435|resourceType |Y |String |The type of resource. |
1436+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1437|lifecycleState |Y |String |The lifecycle state of the asset. |
1438+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1439|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1440+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1441
1442Create Resource
1443+++++++++++++++
1444
1445+--------------------+--------------------------------------------------------------------------------------------------------------+
1446|Interface Definition|Description |
1447+====================+==============================================================================================================+
1448|URI |/sdc/v1/catalog/resources |
1449+--------------------+--------------------------------------------------------------------------------------------------------------+
1450|Operation Type |POST |
1451+--------------------+--------------------------------------------------------------------------------------------------------------+
1452
1453Request Headers:
1454
1455+-------------------+---------+-----------------------------------------------------------------------------------------+
1456|Header Name |Qualifier|Description |
1457+===================+=========+=========================================================================================+
1458|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1459+-------------------+---------+-----------------------------------------------------------------------------------------+
1460|X-ECOMP-InstanceID |Y |Instance ID |
1461+-------------------+---------+-----------------------------------------------------------------------------------------+
1462|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1463+-------------------+---------+-----------------------------------------------------------------------------------------+
1464|Authorization |Y |Base64 encoded username:password |
1465+-------------------+---------+-----------------------------------------------------------------------------------------+
1466|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1467+-------------------+---------+-----------------------------------------------------------------------------------------+
1468|Content-Type |Y |Valid value is : application/json |
1469+-------------------+---------+-----------------------------------------------------------------------------------------+
1470
1471Request Parameters:
1472
1473+-------------------+---------+-----------------------------------------------------------------------------------------+
1474|Attribute |Qualifier|Description |
1475+===================+=========+=========================================================================================+
1476|name |Y |The name of the resource |
1477+-------------------+---------+-----------------------------------------------------------------------------------------+
1478|description |Y |Short description of the resource |
1479+-------------------+---------+-----------------------------------------------------------------------------------------+
1480|resourceType |Y |“VFCMT” / “VF” / “PNF” |
1481+-------------------+---------+-----------------------------------------------------------------------------------------+
1482|category |Y |VFCMT category is “Template”. |
1483+-------------------+---------+-----------------------------------------------------------------------------------------+
1484|subcategory |Y |VFCMT subcategory is “Monitoring Template”. |
1485+-------------------+---------+-----------------------------------------------------------------------------------------+
1486|vendorName |Y |Vendor Name |
1487+-------------------+---------+-----------------------------------------------------------------------------------------+
1488|vendorRelease |Y |Vendor Release |
1489+-------------------+---------+-----------------------------------------------------------------------------------------+
1490|tags |Y |The tags are used for search options. |
1491+-------------------+---------+-----------------------------------------------------------------------------------------+
1492|icon |Y |The icon should be pre-defined in SDC. |
1493+-------------------+---------+-----------------------------------------------------------------------------------------+
1494|contactId |Y |The user ID of user responsible for this VFCMT. |
1495+-------------------+---------+-----------------------------------------------------------------------------------------+
1496
1497Response:
1498
1499+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1500|Attribute |Qualifier|Content|Description |
1501+====================+=========+=======+===================================================================================================+
1502|uuid |Y |String |UUID generated by SDC per each major version of the asset |
1503+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1504|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1505+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1506|name |Y |String |The name of the asset. |
1507+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1508|version |Y |String |The asset version in SDC catalog |
1509+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1510|category |Y |String |Category of the asset. |
1511+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1512|subcategory |Y |String |Sub-category of the asset. |
1513+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1514|resourceType |Y |String |The type of resource. |
1515+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1516|lifecycleState |Y |String |The lifecycle state of the asset. |
1517+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1518|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1519+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1520
1521UUI API
1522----------------
1523Create E2E service instance
1524++++++++++++++++++++++++++++
1525
1526+--------------------+-------------------------------------+
1527|Interface Definition|Description |
1528+====================+=====================================+
1529|URI |{serverRoot}/e2eServiceInstances/v3 |
1530+--------------------+-------------------------------------+
1531|Operation Type |POST |
1532+--------------------+-------------------------------------+
1533|Content-Type |application/json |
1534+--------------------+-------------------------------------+
1535
1536Request Body:
1537
1538+---------+---------+-----------+--------------------------+-----------------------------+
1539|Attribute|Qualifier|Cardinality|Content |Description |
1540+=========+=========+===========+==========================+=============================+
1541|service |M |1 |Service Object |Content of service object. |
1542+---------+---------+-----------+--------------------------+-----------------------------+
1543
1544Service Object
1545
1546+----------------+------------------+-------------------------------------------------+
1547|Attribute |Content |Description |
1548+================+==================+=================================================+
1549|name |String |Service instance name. |
1550+----------------+------------------+-------------------------------------------------+
1551|description |String |Service instance description |
1552+----------------+------------------+-------------------------------------------------+
1553|serviceDef ID |String |The service invariantUUID. It is defined in SDC. |
1554+----------------+------------------+-------------------------------------------------+
1555|templateId |String |The service Template UUID. It is defined in SDC. |
1556+----------------+------------------+-------------------------------------------------+
1557|parameters |Parameter Object |Parameter Object |
1558+----------------+------------------+-------------------------------------------------+
1559
1560Parameter Object
1561
1562+----------------------+------------------+-----------------------------------------------------+
1563|Attribute |Content |Description |
1564+======================+==================+=====================================================+
1565|globalSubscriberId |String |The subscriber id. It is defined in AAI |
1566+----------------------+------------------+-----------------------------------------------------+
1567|subscriberName |String |The subscriber name. It is defined in AAI |
1568+----------------------+------------------+-----------------------------------------------------+
1569|serviceType |String |The service type. It is defined in AAI |
1570+----------------------+------------------+-----------------------------------------------------+
1571|templateName |String |The service Template name |
1572+----------------------+------------------+-----------------------------------------------------+
1573|resources |Object |This field manages parameters of resources |
1574+----------------------+------------------+-----------------------------------------------------+
1575|resourceName |String |The resource name |
1576+----------------------+------------------+-----------------------------------------------------+
1577|resouceDefId |String |The resource invariantUUID. It is defined in SDC. |
1578+----------------------+------------------+-----------------------------------------------------+
1579|resourceId |String |The resource UUID. It is defined in SDC. |
1580+----------------------+------------------+-----------------------------------------------------+
1581|nsParameters |String |Parameters for current resource object. |
1582+----------------------+------------------+-----------------------------------------------------+
1583|locationConstraints |String |The DC location info for each VNF of current service |
1584+----------------------+------------------+-----------------------------------------------------+
1585|vnfProfileId |String |VNFD id |
1586+----------------------+------------------+-----------------------------------------------------+
1587|additionalParamForNs |String |The parameter for current resource |
1588+----------------------+------------------+-----------------------------------------------------+
1589
1590
1591Response:
1592
1593+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1594|Attribute |Qualifier|Cardinality|Content|Description |
1595+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1596|serviceId |M |1 |String |Service instance ID. |
1597+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1598|operationId |M |1 |String |Service Operation ID. |
1599+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1600
1601Delete E2E service instance
1602++++++++++++++++++++++++++++
1603
1604+--------------------+-----------------------------------------------+
1605|Interface Definition|Description |
1606+====================+===============================================+
1607|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
1608+--------------------+-----------------------------------------------+
1609|Operation Type |DELETE |
1610+--------------------+-----------------------------------------------+
1611
1612Request Parameters:
1613
1614+-------------------+---------+-----------+-------+----------------------------------------+
1615|Attribute |Qualifier|Cardinality|Content|Description |
1616+===================+=========+===========+=======+========================================+
1617|globalSubscriberId |M |1 |String |The subscriber id. It is defined in AAI |
1618+-------------------+---------+-----------+-------+----------------------------------------+
1619|serviceType |M |1 |String |The service type. It is defined in AAI |
1620+-------------------+---------+-----------+-------+----------------------------------------+
1621
1622Response:
1623
1624+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1625|Attribute |Qualifier|Cardinality|Content|Description |
1626+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1627|operationId |M |1 |String |The operation id. |
1628+-------------+---------+-----------+-------+------------------------------------------------------------------------+
1629
1630Query E2E service operation result
1631++++++++++++++++++++++++++
1632
1633+--------------------+------------------------------------------------------------------------+
1634|Interface Definition|Description |
1635+====================+========================================================================+
1636|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
1637+--------------------+------------------------------------------------------------------------+
1638|Operation Type |GET |
1639+--------------------+------------------------------------------------------------------------+
1640
1641Request Parameters:
1642
1643+--------------+---------+-----------+-------+--------------+
1644|Attribute |Qualifier|Cardinality|Content|Description |
1645+==============+=========+===========+=======+==============+
1646|serviceId |M |1 |Service instance ID. |
1647+--------------+---------+-----------+-------+--------------+
1648|operationId |M |1 |Service Operation ID. |
1649+--------------+---------+-----------+-------+--------------+
1650
1651Response:
1652
1653+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1654|Attribute |Qualifier|Cardinality|Content|Description |
1655+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1656|operation |M |1 |String |Operation object identify. |
1657+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1658|operationId |M |1 |String |Operation ID. |
1659+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1660|operation |M |1 |String |Operation type, create|delete. |
1661+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1662|result |M |1 |String |Operation result: finished, error, processing. |
1663+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1664|reason |M |1 |String |If failing, need to write fail reason. |
1665+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1666|userId |M |1 |String |Operation user ID. |
1667+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1668|operationContent |M |1 |String |The status detail of current operation which is being executing. |
1669+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1670|progress |M |1 |String |Current operation progress. |
1671+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1672|operateAt |M |1 |String |Time that it starts to execute operation. |
1673+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1674|finishedAt |M |1 |String |Time that it finished executing operation. |
1675+------------------+---------+-----------+-------+------------------------------------------------------------------------+
1676
1677Inventory APIs
1678----------------
1679
1680create or update an existing service-instance
1681+++++++++++++++++++++++++++++++++++++++++++++
1682
1683+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1684|Interface Definition|Description |
1685+====================+====================================================================================================================================================================+
1686|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1687+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1688|Operation Type |PUT |
1689+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1690
1691Request Parameters:
1692
1693+-------------------+---------+-----------+-------+-----------------------+
1694|Attribute |Qualifier|Cardinality|Content|Description |
1695+===================+=========+===========+=======+=======================+
1696|global-customer-id |M |1 |String |Global Customer ID |
1697+-------------------+---------+-----------+-------+-----------------------+
1698|service-type |M |1 |String |Service Type |
1699+-------------------+---------+-----------+-------+-----------------------+
1700|service-instance-id|M |1 |String |Service Instance ID |
1701+-------------------+---------+-----------+-------+-----------------------+
1702
1703Response:
1704
1705+---------+---------+-----------+-------+-------------------+
1706|Attribute|Qualifier|Cardinality|Content|Description |
1707+---------+---------+-----------+-------+-------------------+
1708|HTTP code|M |1 |Integer|HTTP response code |
1709+---------+---------+-----------+-------+-------------------+
1710
1711delete an existing service-instance
1712+++++++++++++++++++++++++++++++++++
1713
1714+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1715|Interface Definition|Description |
1716+====================+====================================================================================================================================================================+
1717|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1718+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1719|Operation Type |DELETE |
1720+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1721
1722Request Parameters:
1723
1724+-------------------+---------+-----------+-------+-----------------------+
1725|Attribute |Qualifier|Cardinality|Content|Description |
1726+===================+=========+===========+=======+=======================+
1727|global-customer-id |M |1 |String |Global Customer ID |
1728+-------------------+---------+-----------+-------+-----------------------+
1729|service-type |M |1 |String |Service Type |
1730+-------------------+---------+-----------+-------+-----------------------+
1731|service-instance-id|M |1 |String |Service Instance ID |
1732+-------------------+---------+-----------+-------+-----------------------+
1733
1734Response:
1735
1736+---------+---------+-----------+-------+-------------------+
1737|Attribute|Qualifier|Cardinality|Content|Description |
1738+---------+---------+-----------+-------+-------------------+
1739|HTTP code|M |1 |Integer|HTTP response code |
1740+---------+---------+-----------+-------+-------------------+
1741
1742get service-instances
1743+++++++++++++++++++++
1744
1745+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1746|Interface Definition|Description |
1747+====================+=============================================================================================================================+
1748|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
1749+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1750|Operation Type |GET |
1751+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1752
1753Request Parameters:
1754
1755+-------------------+---------+-----------+-------+-----------------------+
1756|Attribute |Qualifier|Cardinality|Content|Description |
1757+===================+=========+===========+=======+=======================+
1758|global-customer-id |M |1 |String |Global Customer ID |
1759+-------------------+---------+-----------+-------+-----------------------+
1760|service-type |M |1 |String |Service Type |
1761+-------------------+---------+-----------+-------+-----------------------+
1762
1763Response:
1764
1765+-----------------+---------+-----------+----------------+-------------------+
1766|Attribute |Qualifier|Cardinality|Content |Description |
1767+-----------------+---------+-----------+----------------+-------------------+
1768|service-instances|M |1 |ServiceInstances|Service Instances |
1769+-----------------+---------+-----------+----------------+-------------------+
1770
1771get service-instance
1772++++++++++++++++++++
1773
1774+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1775|Interface Definition|Description |
1776+====================+====================================================================================================================================================================+
1777|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1778+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1779|Operation Type |GET |
1780+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1781
1782Request Parameters:
1783
1784+-------------------+---------+-----------+-------+-----------------------+
1785|Attribute |Qualifier|Cardinality|Content|Description |
1786+===================+=========+===========+=======+=======================+
1787|global-customer-id |M |1 |String |Global Customer ID |
1788+-------------------+---------+-----------+-------+-----------------------+
1789|service-type |M |1 |String |Service Type |
1790+-------------------+---------+-----------+-------+-----------------------+
1791|service-instance-id|M |1 |String |Service instance ID |
1792+-------------------+---------+-----------+-------+-----------------------+
1793
1794Response:
1795
1796+-----------------+---------+-----------+----------------+-------------------+
1797|Attribute |Qualifier|Cardinality|Content |Description |
1798+-----------------+---------+-----------+----------------+-------------------+
1799|service-instance |M |1 |ServiceInstance |Service Instance |
1800+-----------------+---------+-----------+----------------+-------------------+
1801
1802see node definition for valid relationships
1803+++++++++++++++++++++++++++++++++++++++++++
1804
1805+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1806|Interface Definition|Description |
1807+====================+===================================================================================================================================================================================================+
1808|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
1809+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1810|Operation Type |PUT |
1811+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1812
1813Request Parameters:
1814
1815+-------------------+---------+-----------+-------+-----------------------+
1816|Attribute |Qualifier|Cardinality|Content|Description |
1817+===================+=========+===========+=======+=======================+
1818|global-customer-id |M |1 |String |Global Customer ID |
1819+-------------------+---------+-----------+-------+-----------------------+
1820|service-type |M |1 |String |Service Type |
1821+-------------------+---------+-----------+-------+-----------------------+
1822|service-instance-id|M |1 |String |Service instance ID |
1823+-------------------+---------+-----------+-------+-----------------------+
1824
1825Response:
1826
1827+---------+---------+-----------+-------+-------------------+
1828|Attribute|Qualifier|Cardinality|Content|Description |
1829+---------+---------+-----------+-------+-------------------+
1830|HTTP code|M |1 |Integer|HTTP response code |
1831+---------+---------+-----------+-------+-------------------+
1832
1833delete an existing relationship
1834+++++++++++++++++++++++++++++++
1835
1836+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1837|Interface Definition|Description |
1838+====================+===================================================================================================================================================================================================+
1839|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
1840+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1841|Operation Type |DELETE |
1842+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1843
1844Request Parameters:
1845
1846+-------------------+---------+-----------+-------+-----------------------+
1847|Attribute |Qualifier|Cardinality|Content|Description |
1848+===================+=========+===========+=======+=======================+
1849|global-customer-id |M |1 |String |Global Customer ID |
1850+-------------------+---------+-----------+-------+-----------------------+
1851|service-type |M |1 |String |Service Type |
1852+-------------------+---------+-----------+-------+-----------------------+
1853|service-instance-id|M |1 |String |Service instance ID |
1854+-------------------+---------+-----------+-------+-----------------------+
1855
1856Response:
1857
1858+---------+---------+-----------+-------+-------------------+
1859|Attribute|Qualifier|Cardinality|Content|Description |
1860+---------+---------+-----------+-------+-------------------+
1861|HTTP code|M |1 |Integer|HTTP response code |
1862+---------+---------+-----------+-------+-------------------+
1863
1864
1865VFC APIs
1866---------
1867
1868Create NS
1869+++++++++++
1870
1871+--------------------+-------------------+
1872|Interface Definition|Description |
1873+====================+===================+
1874|URI |/ns |
1875+--------------------+-------------------+
1876|Operation Type |POST |
1877+--------------------+-------------------+
1878|Content-Type |application/json |
1879+--------------------+-------------------+
1880
1881Request Parameters:
1882
1883+-------------------+---------+-----------+-------+-----------------------+
1884|Attribute |Qualifier|Cardinality|Content|Description |
1885+===================+=========+===========+=======+=======================+
1886|context |M |1 |Object |Context |
1887+-------------------+---------+-----------+-------+-----------------------+
1888|csarId |M |1 |String |csarId |
1889+-------------------+---------+-----------+-------+-----------------------+
1890|nsName |M |1 |String |Name of the NS |
1891+-------------------+---------+-----------+-------+-----------------------+
1892|description |M |1 |String |description |
1893+-------------------+---------+-----------+-------+-----------------------+
1894
1895Response:
1896
1897+-----------------+---------+-----------+----------------+-------------------+
1898|Attribute |Qualifier|Cardinality|Content |Description |
1899+-----------------+---------+-----------+----------------+-------------------+
1900|nsInstanceId |M |1 |String |nsInstanceId |
1901+-----------------+---------+-----------+----------------+-------------------+
1902
1903Get NS
1904+++++++
1905
1906+--------------------+-------------------+
1907|Interface Definition|Description |
1908+====================+===================+
1909|URI |/ns |
1910+--------------------+-------------------+
1911|Operation Type |GET |
1912+--------------------+-------------------+
1913|Content-Type |application/json |
1914+--------------------+-------------------+
1915
1916Response:
1917
1918+-----------------+---------+-----------+----------------+-------------------+
1919|Attribute |Qualifier|Cardinality|Content |Description |
1920+-----------------+---------+-----------+----------------+-------------------+
1921|nsInstanceId |M |1 |String |nsInstanceId |
1922+-----------------+---------+-----------+----------------+-------------------+
1923|nsName |M |1 |String |The name of ns |
1924+-----------------+---------+-----------+----------------+-------------------+
1925|description |M |1 |String |description |
1926+-----------------+---------+-----------+----------------+-------------------+
1927|nsdId |M |1 |String |ID of ns |
1928+-----------------+---------+-----------+----------------+-------------------+
1929|vnfInfo |M |1 |Array |Vnf information |
1930+-----------------+---------+-----------+----------------+-------------------+
1931|vlInfo |M |1 |Array |vl information |
1932+-----------------+---------+-----------+----------------+-------------------+
1933|vnffgInfo |M |1 |Array |vnffg information |
1934+-----------------+---------+-----------+----------------+-------------------+
1935|nsState |M |1 |String |state of ns |
1936+-----------------+---------+-----------+----------------+-------------------+
1937
1938vnfInfo Object:
1939
1940+-----------------+---------+-----------+----------------+-------------------+
1941|Attribute |Qualifier|Cardinality|Content |Description |
1942+-----------------+---------+-----------+----------------+-------------------+
1943|vnfInstanceId |M |1 |String |vnfInstanceId |
1944+-----------------+---------+-----------+----------------+-------------------+
1945|vnfInstanceName |M |1 |String |vnfInstanceName |
1946+-----------------+---------+-----------+----------------+-------------------+
1947|vnfdId |M |1 |String |vnfdId |
1948+-----------------+---------+-----------+----------------+-------------------+
1949
1950vlInfo Object:
1951
1952+----------------------+---------+-----------+----------------+-------------------+
1953|Attribute |Qualifier|Cardinality|Content |Description |
1954+----------------------+---------+-----------+----------------+-------------------+
1955|vlInstanceId |M |1 |String |vlInstanceId |
1956+----------------------+---------+-----------+----------------+-------------------+
1957|vlInstanceName |M |1 |String |vlInstanceName |
1958+----------------------+---------+-----------+----------------+-------------------+
1959|vldId |M |1 |String |vldId |
1960+----------------------+---------+-----------+----------------+-------------------+
1961|relatedCpInstanceId |M |1 |Array |relatedCpInstanceId|
1962+----------------------+---------+-----------+----------------+-------------------+
1963
1964relatedCpInstanceId Array:
1965
1966+----------------------+---------+-----------+----------------+-------------------+
1967|Attribute |Qualifier|Cardinality|Content |Description |
1968+----------------------+---------+-----------+----------------+-------------------+
1969|cpInstanceId |M |1 |String |cpInstanceId |
1970+----------------------+---------+-----------+----------------+-------------------+
1971|cpInstanceName |M |1 |String |cpInstanceName |
1972+----------------------+---------+-----------+----------------+-------------------+
1973|cpdId |M |1 |String |cpdId |
1974+----------------------+---------+-----------+----------------+-------------------+
1975
1976vnffgInfo Array:
1977
1978+----------------------+---------+-----------+----------------+-------------------+
1979|Attribute |Qualifier|Cardinality|Content |Description |
1980+----------------------+---------+-----------+----------------+-------------------+
1981|vnffgInstanceId |M |1 |String |vnffgInstanceId |
1982+----------------------+---------+-----------+----------------+-------------------+
1983|vnfId |M |1 |String |vnfId |
1984+----------------------+---------+-----------+----------------+-------------------+
1985|pnfId |M |1 |String |pnfId |
1986+----------------------+---------+-----------+----------------+-------------------+
1987|virtualLinkId |M |1 |Array |virtualLinkId |
1988+----------------------+---------+-----------+----------------+-------------------+
1989|cpId |M |1 |Array |cpId |
1990+----------------------+---------+-----------+----------------+-------------------+
1991|nfp |M |1 |Array |nfp |
1992+----------------------+---------+-----------+----------------+-------------------+
1993
1994Instantiate NS
1995+++++++++++++++
1996
1997+--------------------+-------------------------------------+
1998|Interface Definition|Description |
1999+====================+=====================================+
2000|URI |/ns/{nsInstanceId}/Instantiate |
2001+--------------------+-------------------------------------+
2002|Operation Type |POST |
2003+--------------------+-------------------------------------+
2004|Content-Type |application/json |
2005+--------------------+-------------------------------------+
2006
2007Request Parameters:
2008
2009+----------------------+---------+-----------+-------+-----------------------+
2010|Attribute |Qualifier|Cardinality|Content|Description |
2011+======================+=========+===========+=======+=======================+
2012|LocationConstraints |M |1 |Array |LocationConstraints |
2013+----------------------+---------+-----------+-------+-----------------------+
2014|additionalParamForNs |M |1 |String |additionalParamForNs |
2015+----------------------+---------+-----------+-------+-----------------------+
2016|nsInstanceId |M |1 |String |nsInstanceId |
2017+----------------------+---------+-----------+-------+-----------------------+
2018
2019LocationConstraints Array:
2020
2021+----------------------+---------+-----------+-------+-----------------------+
2022|Attribute |Qualifier|Cardinality|Content|Description |
2023+======================+=========+===========+=======+=======================+
2024|vnfProfileId |M |1 |String |vnfProfileId |
2025+----------------------+---------+-----------+-------+-----------------------+
2026|vimid |M |1 |String |vimid |
2027+----------------------+---------+-----------+-------+-----------------------+
2028
2029Response:
2030
2031+--------------+---------+-----------+-------+-----------------------+
2032|Attribute |Qualifier|Cardinality|Content|Description |
2033+==============+=========+===========+=======+=======================+
2034|jobId |M |1 |String |jobId |
2035+--------------+---------+-----------+-------+-----------------------+
2036
2037Terminate NS
2038+++++++++++++++
2039
2040+--------------------+-------------------------------------+
2041|Interface Definition|Description |
2042+====================+=====================================+
2043|URI |/ns/{ns_instance_id}/terminate |
2044+--------------------+-------------------------------------+
2045|Operation Type |POST |
2046+--------------------+-------------------------------------+
2047|Content-Type |application/json |
2048+--------------------+-------------------------------------+
2049
2050Request Parameters:
2051
2052+----------------------------+---------+-----------+-------+-----------------------------+
2053|Attribute |Qualifier|Cardinality|Content|Description |
2054+============================+=========+===========+=======+=============================+
2055|terminationType |M |1 |String |terminationType |
2056+----------------------------+---------+-----------+-------+-----------------------------+
2057|gracefulTerminationTimeout |M |1 |String |gracefulTerminationTimeout |
2058+----------------------------+---------+-----------+-------+-----------------------------+
2059|nsInstanceId |M |1 |String |nsInstanceId |
2060+----------------------------+---------+-----------+-------+-----------------------------+
2061
2062Response:
2063
2064+--------------+---------+-----------+-------+-----------------------+
2065|Attribute |Qualifier|Cardinality|Content|Description |
2066+==============+=========+===========+=======+=======================+
2067|jobId |M |1 |String |jobId |
2068+--------------+---------+-----------+-------+-----------------------+
2069
2070Delete NS
2071+++++++++++++++
2072
2073+--------------------+-------------------------------------+
2074|Interface Definition|Description |
2075+====================+=====================================+
2076|URI |/ns/{ns_instance_id} |
2077+--------------------+-------------------------------------+
2078|Operation Type |DELETE |
2079+--------------------+-------------------------------------+
2080
2081Request Parameters:
2082
2083+----------------------------+---------+-----------+-------+-----------------------------+
2084|Attribute |Qualifier|Cardinality|Content|Description |
2085+============================+=========+===========+=======+=============================+
2086|nsInstanceId |M |1 |String |nsInstanceId |
2087+----------------------------+---------+-----------+-------+-----------------------------+
2088
2089MultiVIM API
2090----------------
2091Get token
2092++++++++++
2093
2094https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
2095
2096+--------------------+-----------------------------------------------------------------------------------------------+
2097|Interface Definition|Description |
2098+====================+===============================================================================================+
2099|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens |
2100+--------------------+-----------------------------------------------------------------------------------------------+
2101|Operation Type |POST |
2102+--------------------+-----------------------------------------------------------------------------------------------+
2103|Content-Type |application/json |
2104+--------------------+-----------------------------------------------------------------------------------------------+
2105
2106Request Body:
2107
2108+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2109|Attribute |Qualifier|Cardinality|Content |Description |
2110+================+=========+===========+==========================+================================================================================================================================================+
2111|nocatalog |O |1 |string |The authentication response excludes the service catalog. By default, the response includes the service catalog. |
2112+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2113|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.|
2114+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2115|auth |M |1 |object |An auth object. |
2116+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2117|user |M |1 |object |A user object. |
2118+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2119|scope |O |1 |string |The authorization scope, including either a project or a domain |
2120+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2121|password |M |1 |object |The password object, contains the authentication information. |
2122+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2123|id |O |1 |string |The ID of the user. Required if you do not specify the user name. |
2124+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2125|identity |M |1 |object |An identity object. |
2126+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2127|methods |M |1 |array |The authentication method. For password authentication, specify password. |
2128+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2129
2130Response:
2131
2132+-------------------------+------------------+--------------------------------------------------------------------------+
2133|Attribute |Content |Description |
2134+=========================+==================+==========================================================================+
2135|X-Subject-Token |String |The authentication token. |
2136+-------------------------+------------------+--------------------------------------------------------------------------+
2137|domain |object |A domain object, containing: |
2138+-------------------------+------------------+--------------------------------------------------------------------------+
2139|region_id |String |The ID of the region that contains the service endpoint. |
2140+-------------------------+------------------+--------------------------------------------------------------------------+
2141|methods |array |The authentication method. For password authentication, specify password. |
2142+-------------------------+------------------+--------------------------------------------------------------------------+
2143|roles |array |A list of role objects, each containing: |
2144+-------------------------+------------------+--------------------------------------------------------------------------+
2145|url |String |The endpoint URL. |
2146+-------------------------+------------------+--------------------------------------------------------------------------+
2147|region |String |The geographic location of the service endpoint. |
2148+-------------------------+------------------+--------------------------------------------------------------------------+
2149|token |object |A token object. |
2150+-------------------------+------------------+--------------------------------------------------------------------------+
2151|expires_at |String |The date and time when the token expires. |
2152+-------------------------+------------------+--------------------------------------------------------------------------+
2153|project |object |A project object, containing: |
2154+-------------------------+------------------+--------------------------------------------------------------------------+
2155|issued_at |String |The date and time when the token was issued. |
2156+-------------------------+------------------+--------------------------------------------------------------------------+
2157|catalog |array |A catalog object. |
2158+-------------------------+------------------+--------------------------------------------------------------------------+
2159|extras |object |A set of metadata key and value pairs, if any. |
2160+-------------------------+------------------+--------------------------------------------------------------------------+
2161|user |object |A user object. |
2162+-------------------------+------------------+--------------------------------------------------------------------------+
2163|audit_ids |array |A list of one or two audit IDs. |
2164+-------------------------+------------------+--------------------------------------------------------------------------+
2165|interface |String |The interface type, which describes the visibility of the endpoint. |
2166+-------------------------+------------------+--------------------------------------------------------------------------+
2167|endpoints |array |A list of endpoint objects. |
2168+-------------------------+------------------+--------------------------------------------------------------------------+
2169|type |String |The endpoint type. |
2170+-------------------------+------------------+--------------------------------------------------------------------------+
2171|id |String |The ID of the user. Required if you do not specify the user name. |
2172+-------------------------+------------------+--------------------------------------------------------------------------+
2173|name |String |The user name. |
2174+-------------------------+------------------+--------------------------------------------------------------------------+
2175
2176Create stack
2177+++++++++++++
2178
2179https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
2180
2181+--------------------+-----------------------------------------------------------------------------------------------+
2182|Interface Definition|Description |
2183+====================+===============================================================================================+
2184|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks |
2185+--------------------+-----------------------------------------------------------------------------------------------+
2186|Operation Type |POST |
2187+--------------------+-----------------------------------------------------------------------------------------------+
2188|Content-Type |application/json |
2189+--------------------+-----------------------------------------------------------------------------------------------+
2190
2191Request Body:
2192
2193+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2194|Attribute |Qualifier|Cardinality|Content |Description |
2195+==================+=========+===========+==========================+=================================================================================================+
2196|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2197+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2198|disable_rollback |O |1 |boolean |Enables or disables deletion of all stack resources when stack creation fails. |
2199+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2200|environment |O |1 |object |A JSON environment for the stack. |
2201+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2202|files |O |1 |object |Supplies the contents of files referenced in the template or the environment. |
2203+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2204|parameters |O |1 |object |Supplies arguments for parameters defined in the stack template. |
2205+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2206|stack_name |M |1 |string |A name for the stack. |
2207+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2208|tags |O |1 |string |One or more simple string tags to associate with the stack. |
2209+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2210|template |O |1 |object |The stack template on which to perform the operation. |
2211+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2212|template_url |O |1 |string |A URI to the location containing the stack template on which to perform the operation. |
2213+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2214|timeout_mins |O |1 |integer |The timeout for stack creation in minutes. |
2215+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2216
2217Response:
2218
2219+-------------------------+------------------+--------------------------------------------------------------------------+
2220|Attribute |Content |Description |
2221+=========================+==================+==========================================================================+
2222|location |String |For asynchronous resource operations. |
2223+-------------------------+------------------+--------------------------------------------------------------------------+
2224|X-Openstack-Reqeuest-Id |object |A domain object, containing: |
2225+-------------------------+------------------+--------------------------------------------------------------------------+
2226|stack |String |The ID of the region that contains the service endpoint. |
2227+-------------------------+------------------+--------------------------------------------------------------------------+
2228|id |String |The authentication method. For password authentication, specify password. |
2229+-------------------------+------------------+--------------------------------------------------------------------------+
2230|links |String |The authentication method. For password authentication, specify password. |
2231+-------------------------+------------------+--------------------------------------------------------------------------+
2232
2233Get stack
2234+++++++++++++
2235
2236https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2237
2238+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2239|Interface Definition|Description |
2240+====================+=======================================================================================================================+
2241|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2242+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2243|Operation Type |GET |
2244+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2245|Content-Type |application/json |
2246+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2247
2248Request Body:
2249
2250+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2251|Attribute |Qualifier|Cardinality|Content |Description |
2252+==================+=========+===========+==========================+=================================================================================================+
2253|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2254+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2255|stack_name |M |1 |string |The name of a stack. |
2256+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2257|stack_id |M |1 |string |The UUID of the stack. |
2258+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2259|resolve_outputs |O |1 |boolean |A boolean indicating whether the outputs section of a stack should be resolved. |
2260+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2261
2262Response:
2263
2264+-------------------------+------------------+------------------------------------------------------------------------------+
2265|Attribute |Content |Description |
2266+=========================+==================+==============================================================================+
2267|X-Openstack-Reqeuest-Id |String |A unique ID for tracking service request. |
2268+-------------------------+------------------+------------------------------------------------------------------------------+
2269|stack |Object |The stack object. |
2270+-------------------------+------------------+------------------------------------------------------------------------------+
2271|capabilities |array |List of stack capabilities for stack. |
2272+-------------------------+------------------+------------------------------------------------------------------------------+
2273|creation_time |String |The date and time when the resource was created. |
2274+-------------------------+------------------+------------------------------------------------------------------------------+
2275|deletion_time |String |The date and time when the resource was (soft-) deleted. |
2276+-------------------------+------------------+------------------------------------------------------------------------------+
2277|description |String |The description of the stack resource. |
2278+-------------------------+------------------+------------------------------------------------------------------------------+
2279|disable_rollback |boolean |Whether deletion of all stack resources when stack creation fails is enabled. |
2280+-------------------------+------------------+------------------------------------------------------------------------------+
2281|id |String |The UUID of the stack. |
2282+-------------------------+------------------+------------------------------------------------------------------------------+
2283|links |array |A list of URLs for the stack. |
2284+-------------------------+------------------+------------------------------------------------------------------------------+
2285|notification_topics |array |List of notification topics for stack. |
2286+-------------------------+------------------+------------------------------------------------------------------------------+
2287|outputs |array |A list of stack outputs. |
2288+-------------------------+------------------+------------------------------------------------------------------------------+
2289|parameters |object | A group of key-value pairs |
2290+-------------------------+------------------+------------------------------------------------------------------------------+
2291|parent |String |The stack ID of the parent stack, if this is a nested stack. |
2292+-------------------------+------------------+------------------------------------------------------------------------------+
2293|stack_name |String |A name for the stack. |
2294+-------------------------+------------------+------------------------------------------------------------------------------+
2295|stack_owner |String |The owner of the stack. |
2296+-------------------------+------------------+------------------------------------------------------------------------------+
2297|stack_status |String |The status of the stack. |
2298+-------------------------+------------------+------------------------------------------------------------------------------+
2299|stack_status_reason |String |The reason for the current status of the stack. |
2300+-------------------------+------------------+------------------------------------------------------------------------------+
2301|stack_user_project_id |String |The project UUID of the stack user. |
2302+-------------------------+------------------+------------------------------------------------------------------------------+
2303|tags |array |The stack tags. |
2304+-------------------------+------------------+------------------------------------------------------------------------------+
2305|template_description |String |The description of the stack template. |
2306+-------------------------+------------------+------------------------------------------------------------------------------+
2307|timeout_mins |integer |The timeout for stack creation in minutes. |
2308+-------------------------+------------------+------------------------------------------------------------------------------+
2309|updated_time |String |The date and time when the object was updated. |
2310+-------------------------+------------------+------------------------------------------------------------------------------+
2311
2312Delete stack
2313+++++++++++++
2314
2315https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2316
2317+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2318|Interface Definition|Description |
2319+====================+=======================================================================================================================+
2320|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2321+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2322|Operation Type |DELETE |
2323+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2324|Content-Type |application/json |
2325+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2326
2327Request Body:
2328
2329+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2330|Attribute |Qualifier|Cardinality|Content |Description |
2331+==================+=========+===========+==========================+=================================================================================================+
2332|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2333+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2334|stack_name |M |1 |string |The name of a stack. |
2335+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2336|stack_id |M |1 |string |The UUID of the stack. |
2337+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2338
2339Create server
2340+++++++++++++
2341
2342https://developer.openstack.org/api-ref/compute/#create-server
2343
2344+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2345|Interface Definition|Description |
2346+====================+=======================================================================================================================+
2347|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers |
2348+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2349|Operation Type |POST |
2350+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2351|Content-Type |application/json |
2352+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2353
2354Request Body:
2355
2356+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2357|Attribute |Qualifier|Cardinality|Content |Description |
2358+================================================+=========+===========+==========================+=================================================================================================+
2359|server |M |1 |object |A server object. |
2360+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2361|name |M |1 |string |The server name. |
2362+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2363|flavorRef |M |1 |string |The flavor reference, as an ID (including a UUID) or full URL |
2364+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2365|imageRef |M |1 |string |The UUID of the image to use for your server instance |
2366+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2367|security_groups |O |1 |array |One or more security groups. |
2368+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2369|metadata |O |1 |object |Metadata key and value pairs. |
2370+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2371|accessIPv4 |O |1 |string |IPv4 address that should be used to access this server. |
2372+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2373|accessIPv6 |O |1 |string |IPv6 address that should be used to access this server. |
2374+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2375|adminPass |O |1 |string |The administrative password of the server. |
2376+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2377|user_data |O |1 |string |Configuration information or scripts to use upon launch. |
2378+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2379|availability_zone |O |1 |string |The availability zone from which to launch the server. |
2380+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2381|networks |M |1 |object |A networks object. |
2382+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2383|networks.uuid |O |1 |string |To provision the server instance with a NIC for a network |
2384+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2385|networks.port |O |1 |string |To provision the server instance with a NIC for an already existing port |
2386+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2387|networks.fixed_ip |O |1 |string |A fixed IPv4 address for the NIC |
2388+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2389|networks.tag |O |1 |string |A device role tag that can be applied to a network interface. |
2390+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2391|personality |O |1 |array |The file path and contents, text only, to inject into the server at launch. |
2392+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2393|block_device_mapping_v2 |O |1 |array |Enables fine grained control of the block device mapping for an instance. |
2394+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2395|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. |
2396+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2397|block_device_mapping_v2.source_type |M |1 |string |The source type of the volume. |
2398+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2399|block_device_mapping_v2.destination_type |O |1 |string |Defines where the volume comes from. |
2400+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2401|block_device_mapping_v2.delete_on_termination |O |1 |string |To delete the boot volume when the server is destroyed, specify true. |
2402+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2403|block_device_mapping_v2.guest_format |M |1 |string |Specifies the guest server disk file system format, such as ephemeral or swap. |
2404+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2405|block_device_mapping_v2.boot_index |M |1 |string |Defines the order in which a hypervisor tries devices |
2406+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2407|block_device_mapping_v2.uuid |O |1 |string |This is the uuid of source resource. |
2408+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2409|block_device_mapping_v2.tag |O |1 |string |A device role tag that can be applied to a block device. |
2410+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2411|block_device_mapping_v2.disk_bus |O |1 |string |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter |
2412+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2413|config_drive |O |1 |boolean |Indicates whether a configuration drive enables metadata injection. |
2414+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2415|key_name |O |1 |string |Key pair name. |
2416+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2417|os:scheduler_hints |O |1 |object |The dictionary of data to send to the scheduler. |
2418+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2419|OS-DCF:diskConfig |O |1 |string |Controls how the API partitions the disk when you create, rebuild, or resize servers. |
2420+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2421|description |O |1 |string |A free form description of the server. |
2422+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2423|tags |O |1 |array |A list of tags. |
2424+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2425
2426Response:
2427
2428+-------------------------+------------------+------------------------------------------------------------------------------+
2429|Attribute |Content |Description |
2430+=========================+==================+==============================================================================+
2431|server |object |A server object. |
2432+-------------------------+------------------+------------------------------------------------------------------------------+
2433|id |String |The UUID of the server. |
2434+-------------------------+------------------+------------------------------------------------------------------------------+
2435|links |array |Links to the resources in question. |
2436+-------------------------+------------------+------------------------------------------------------------------------------+
2437|OS-DCF:diskConfig |String |Disk configuration. |
2438+-------------------------+------------------+------------------------------------------------------------------------------+
2439|security_groups |array |One or more security groups objects. |
2440+-------------------------+------------------+------------------------------------------------------------------------------+
2441|security_groups.name |String |The security group name. |
2442+-------------------------+------------------+------------------------------------------------------------------------------+
2443|adminPass |String |The administrative password for the server. |
2444+-------------------------+------------------+------------------------------------------------------------------------------+
2445
2446Delete server
2447+++++++++++++
2448
2449https://developer.openstack.org/api-ref/compute/#delete-server
2450
2451+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2452|Interface Definition|Description |
2453+====================+=======================================================================================================================+
2454|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id} |
2455+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2456|Operation Type |DELETE |
2457+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2458|Content-Type |application/json |
2459+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2460
2461Request Body:
2462
2463+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2464|Attribute |Qualifier|Cardinality|Content |Description |
2465+==================+=========+===========+==========================+=================================================================================================+
2466|server_id |M |1 |string |The UUID of the server. |
2467+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2468
2469Create Keypair
2470+++++++++++++++
2471
2472https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
2473
2474+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2475|Interface Definition|Description |
2476+====================+=======================================================================================================================+
2477|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs |
2478+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2479|Operation Type |POST |
2480+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2481|Content-Type |application/json |
2482+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2483
2484Request Body:
2485
2486+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2487|Attribute |Qualifier|Cardinality|Content |Description |
2488+==================+=========+===========+==========================+=================================================================================================+
2489|keypair |M |1 |Object |Keypair object |
2490+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2491|name |M |1 |string |A name for the keypair which will be used to reference it later. |
2492+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2493|public_key |O |1 |string |The public ssh key to import. If you omit this value, a keypair is generated for you. |
2494+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2495|type |O |1 |string |The type of the keypair. |
2496+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2497|user_id |O |1 |string |The user_id for a keypair. |
2498+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2499
2500Response:
2501
2502+-----------------+------------------+------------------------------------------------------------------------------+
2503|Attribute |Content |Description |
2504+=================+==================+==============================================================================+
2505|keypair |object |Keypair object |
2506+-----------------+------------------+------------------------------------------------------------------------------+
2507|name |String |A name for the keypair which will be used to reference it later. |
2508+-----------------+------------------+------------------------------------------------------------------------------+
2509|public_key |String |The keypair public key. |
2510+-----------------+------------------+------------------------------------------------------------------------------+
2511|fingerprint |String |The fingerprint for the keypair. |
2512+-----------------+------------------+------------------------------------------------------------------------------+
2513|user_id |String |The user_id for a keypair. |
2514+-----------------+------------------+------------------------------------------------------------------------------+
2515|private_key |String |If you do not provide a public key on create |
2516+-----------------+------------------+------------------------------------------------------------------------------+
2517|type |String |The type of the keypair. |
2518+-----------------+------------------+------------------------------------------------------------------------------+
2519
2520Delete Keypair
2521+++++++++++++++
2522
2523https://developer.openstack.org/api-ref/compute/#delete-keypair
2524
2525+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2526|Interface Definition|Description |
2527+====================+=======================================================================================================================+
2528|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id} |
2529+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2530|Operation Type |DELETE |
2531+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2532|Content-Type |application/json |
2533+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2534
2535Request Body:
2536
2537+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2538|Attribute |Qualifier|Cardinality|Content |Description |
2539+==================+=========+===========+==========================+=================================================================================================+
2540|keypair_name |M |1 |String |The keypair name. |
2541+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2542|user_id |O |1 |String |This allows administrative users to operate key-pairs of specified user ID. |
2543+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2544
2545Create Network
2546+++++++++++++++
2547
2548https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
2549
2550+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2551|Interface Definition|Description |
2552+====================+=======================================================================================================================+
2553|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks |
2554+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2555|Operation Type |POST |
2556+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2557|Content-Type |application/json |
2558+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2559
2560Request Body:
2561
2562+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2563|Attribute |Qualifier|Cardinality|Content |Description |
2564+============================+=========+===========+==========================+=================================================================================================+
2565|network |M |1 |Object |A network object. |
2566+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2567|admin_state_up |O |1 |boolean |The administrative state of the network, which is up (true) or down (false). |
2568+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2569|dns_domain |O |1 |string |A valid DNS domain. |
2570+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2571|mtu |O |1 |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2572+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2573|name |O |1 |string |Human-readable name of the network. |
2574+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2575|port_security_enabled |O |1 |boolean |The port security status of the network. |
2576+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2577|project_id |O |1 |string |The ID of the project that owns the resource. |
2578+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2579|provider:network_type |O |1 |string |The type of physical network that this network should be mapped to. |
2580+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2581|provider:physical_network |O |1 |string |The physical network where this network should be implemented. |
2582+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2583|provider:segmentation_id |O |1 |integer |The ID of the isolated segment on the physical network. |
2584+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2585|qos_policy_id |O |1 |string |The ID of the QoS policy. |
2586+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2587|router:external |O |1 |boolean |Indicates whether this network can provide floating IPs via a router. |
2588+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2589|segments |O |1 |array |A list of provider segment objects. |
2590+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2591|shared |O |1 |boolean |Indicates whether this network is shared across all tenants. |
2592+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2593|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2594+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2595|vlan_transparent |O |1 |boolean |Indicates the VLAN transparency mode of the network, |
2596+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2597|description |O |1 |string |A human-readable description for the resource. |
2598+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2599
2600Response:
2601
2602+-----------------------------+------------------+------------------------------------------------------------------------------+
2603|Attribute |Content |Description |
2604+=============================+==================+==============================================================================+
2605|network |object |A network object. |
2606+-----------------------------+------------------+------------------------------------------------------------------------------+
2607|admin_state_up |boolean |The administrative state of the network, which is up (true) or down (false). |
2608+-----------------------------+------------------+------------------------------------------------------------------------------+
2609|availability_zone_hints |array |The availability zone candidate for the network. |
2610+-----------------------------+------------------+------------------------------------------------------------------------------+
2611|availability_zones |array |The availability zone for the network. |
2612+-----------------------------+------------------+------------------------------------------------------------------------------+
2613|dns_domain |String |A valid DNS domain. |
2614+-----------------------------+------------------+------------------------------------------------------------------------------+
2615|id |String |The ID of the network. |
2616+-----------------------------+------------------+------------------------------------------------------------------------------+
2617|mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2618+-----------------------------+------------------+------------------------------------------------------------------------------+
2619|name |String |Human-readable name of the network. |
2620+-----------------------------+------------------+------------------------------------------------------------------------------+
2621|port_security_enabled |boolean |The port security status of the network. |
2622+-----------------------------+------------------+------------------------------------------------------------------------------+
2623|project_id |String |The ID of the project. |
2624+-----------------------------+------------------+------------------------------------------------------------------------------+
2625|provider:network_type |String |The type of physical network that this network is mapped to. |
2626+-----------------------------+------------------+------------------------------------------------------------------------------+
2627|provider:physical_network |String |The physical network where this network is implemented. |
2628+-----------------------------+------------------+------------------------------------------------------------------------------+
2629|provider:segmentation_id |integer |The ID of the isolated segment on the physical network. |
2630+-----------------------------+------------------+------------------------------------------------------------------------------+
2631|qos_policy_id |String |The ID of the QoS policy. |
2632+-----------------------------+------------------+------------------------------------------------------------------------------+
2633|revision_number |integer |The revision number of the resource. |
2634+-----------------------------+------------------+------------------------------------------------------------------------------+
2635|router:external |boolean |Indicates whether this network can provide floating IPs via a router. |
2636+-----------------------------+------------------+------------------------------------------------------------------------------+
2637|segments |array |A list of provider segment objects. |
2638+-----------------------------+------------------+------------------------------------------------------------------------------+
2639|shared |boolean |Indicates whether this network is shared across all tenants. |
2640+-----------------------------+------------------+------------------------------------------------------------------------------+
2641|status |String |The network status. Values are ACTIVE, DOWN, BUILD or ERROR. |
2642+-----------------------------+------------------+------------------------------------------------------------------------------+
2643|subnets |array |The associated subnets. |
2644+-----------------------------+------------------+------------------------------------------------------------------------------+
2645|tenant_id |String |The ID of the project. |
2646+-----------------------------+------------------+------------------------------------------------------------------------------+
2647|vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. |
2648+-----------------------------+------------------+------------------------------------------------------------------------------+
2649|description |String |A human-readable description for the resource. |
2650+-----------------------------+------------------+------------------------------------------------------------------------------+
2651
2652Delete Network
2653+++++++++++++++
2654
2655https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
2656
2657+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2658|Interface Definition|Description |
2659+====================+=======================================================================================================================+
2660|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id} |
2661+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2662|Operation Type |DELETE |
2663+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2664|Content-Type |application/json |
2665+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2666
2667Request Body:
2668
2669+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2670|Attribute |Qualifier|Cardinality|Content |Description |
2671+============================+=========+===========+==========================+==============================================================+
2672|network_id |M |1 |Object |The ID of the network. |
2673+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2674
2675Create Subnet
2676+++++++++++++++
2677
2678https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
2679
2680+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2681|Interface Definition|Description |
2682+====================+=======================================================================================================================+
2683|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets |
2684+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2685|Operation Type |POST |
2686+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2687|Content-Type |application/json |
2688+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2689
2690Request Body:
2691
2692+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2693|Attribute |Qualifier|Cardinality|Content |Description |
2694+============================+=========+===========+==========================+=================================================================================================+
2695|subnet |M |1 |string |A subnet object. |
2696+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2697|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2698+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2699|project_id |O |1 |string |The ID of the project that owns the resource. |
2700+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2701|name |O |1 |string |Human-readable name of the resource. |
2702+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2703|enable_dhcp |O |1 |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2704+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2705|network_id |M |1 |string |The ID of the network to which the subnet belongs. |
2706+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2707|dns_nameservers |O |1 |array |List of dns name servers associated with the subnet. |
2708+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2709|allocation_pools |O |1 |array |Allocation pools with start and end IP addresses for this subnet. |
2710+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2711|host_routes |O |1 |array |Additional routes for the subnet. |
2712+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2713|ip_version |M |1 |integer |The IP protocol version. Value is 4 or 6. |
2714+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2715|gateway_ip |O |1 |string |Gateway IP of this subnet. |
2716+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2717|cidr |M |1 |string |The CIDR of the subnet. |
2718+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2719|description |O |1 |string |A human-readable description for the resource. |
2720+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2721|ipv6_address_mode |O |1 |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2722+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2723|ipv6_ra_mode |O |1 |string |The IPv6 router advertisement specifies whether the networking service |
2724+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2725|segment_id |O |1 |string |The ID of a network segment the subnet is associated with. |
2726+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2727|subnetpool_id |O |1 |string |The ID of the subnet pool associated with the subnet. |
2728+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2729|use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. |
2730+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2731
2732Response:
2733
2734+-----------------------------+------------------+------------------------------------------------------------------------------+
2735|Attribute |Content |Description |
2736+=============================+==================+==============================================================================+
2737|subnet |string |A subnet object. |
2738+-----------------------------+------------------+------------------------------------------------------------------------------+
2739|id |string |The ID of the subnet. |
2740+-----------------------------+------------------+------------------------------------------------------------------------------+
2741|tenant_id |string |The ID of the project. |
2742+-----------------------------+------------------+------------------------------------------------------------------------------+
2743|project_id |string |The ID of the project. |
2744+-----------------------------+------------------+------------------------------------------------------------------------------+
2745|name |String |Human-readable name of the resource. |
2746+-----------------------------+------------------+------------------------------------------------------------------------------+
2747|enable_dhcp |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2748+-----------------------------+------------------+------------------------------------------------------------------------------+
2749|network_id |String |The ID of the network to which the subnet belongs. |
2750+-----------------------------+------------------+------------------------------------------------------------------------------+
2751|dns_nameservers |array |List of dns name servers associated with the subnet. |
2752+-----------------------------+------------------+------------------------------------------------------------------------------+
2753|allocation_pools |array |Allocation pools with start and end IP addresses for this subnet. |
2754+-----------------------------+------------------+------------------------------------------------------------------------------+
2755|host_routes |array |Additional routes for the subnet. |
2756+-----------------------------+------------------+------------------------------------------------------------------------------+
2757|ip_version |integer |The IP protocol version. Value is 4 or 6. |
2758+-----------------------------+------------------+------------------------------------------------------------------------------+
2759|gateway_ip |string |Gateway IP of this subnet. |
2760+-----------------------------+------------------+------------------------------------------------------------------------------+
2761|cidr |string |The CIDR of the subnet. |
2762+-----------------------------+------------------+------------------------------------------------------------------------------+
2763|created_at |string |Time at which the subnet has been created. |
2764+-----------------------------+------------------+------------------------------------------------------------------------------+
2765|description |string |A human-readable description for the resource. |
2766+-----------------------------+------------------+------------------------------------------------------------------------------+
2767|ipv6_address_mode |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2768+-----------------------------+------------------+------------------------------------------------------------------------------+
2769|ipv6_ra_mode |string |The IPv6 router advertisement specifies whether the networking service |
2770+-----------------------------+------------------+------------------------------------------------------------------------------+
2771|revision_number |integer |The revision number of the resource. |
2772+-----------------------------+------------------+------------------------------------------------------------------------------+
2773|service_types |string |The service types associated with the subnet. |
2774+-----------------------------+------------------+------------------------------------------------------------------------------+
2775|subnetpool_id |string |The ID of the subnet pool associated with the subnet. |
2776+-----------------------------+------------------+------------------------------------------------------------------------------+
2777|segment_id |string |The ID of a network segment the subnet is associated with. |
2778+-----------------------------+------------------+------------------------------------------------------------------------------+
2779|updated_at |string |Time at which the subnet has been updated. |
2780+-----------------------------+------------------+------------------------------------------------------------------------------+
2781
2782Delete Subnet
2783+++++++++++++++
2784
2785https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
2786
2787+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2788|Interface Definition|Description |
2789+====================+=======================================================================================================================+
2790|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id} |
2791+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2792|Operation Type |DELETE |
2793+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2794|Content-Type |application/json |
2795+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2796
2797Request Body:
2798
2799+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2800|Attribute |Qualifier|Cardinality|Content |Description |
2801+============================+=========+===========+==========================+==============================================================+
2802|subnet_id |M |1 |String |The ID of the subnet. |
2803+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2804
2805Create Port
2806+++++++++++++++
2807
2808https://developer.openstack.org/api-ref/networking/v2/#create-port
2809
2810+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2811|Interface Definition|Description |
2812+====================+=======================================================================================================================+
2813|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports |
2814+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2815|Operation Type |POST |
2816+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2817|Content-Type |application/json |
2818+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2819
2820Request Body:
2821
2822+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2823|Attribute |Qualifier|Cardinality|Content |Description |
2824+============================+=========+===========+==========================+=================================================================================================+
2825|port |M |1 |object |A port object. |
2826+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2827|admin_state_up |O |1 |boolean |The administrative state of the resource. |
2828+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2829|allowed_address_pairs |O |1 |array |A set of zero or more allowed address pairs. |
2830+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2831|binding:host_id |O |1 |string |The ID of the host where the port resides. |
2832+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2833|binding:profile |O |1 |string |A dictionary that enables the application running on the specific host |
2834+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2835|binding:vnic_type |O |1 |string |The type of vNIC which this port should be attached to. |
2836+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2837|description |O |1 |string |A human-readable description for the resource. |
2838+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2839|device_id |O |1 |string |The ID of the device that uses this port. |
2840+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2841|device_owner |O |1 |string |The entity type that uses this port. |
2842+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2843|dns_domain |O |1 |string |A valid DNS domain. |
2844+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2845|dns_name |O |1 |string |A valid DNS name. |
2846+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2847|extra_dhcp_opts |O |1 |array |A set of zero or more extra DHCP option pairs. |
2848+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2849|fixed_ips |O |1 |array |The IP addresses for the port. |
2850+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2851|mac_address |O |1 |string |The MAC address of the port. |
2852+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2853|name |O |1 |string |Human-readable name of the resource. |
2854+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2855|network_id |M |1 |string |The ID of the attached network. |
2856+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2857|port_security_enabled |O |1 |boolean |The port security status. |
2858+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2859|project_id |O |1 |string |The ID of the project that owns the resource. |
2860+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2861|security_groups |O |1 |array |The IDs of security groups applied to the port. |
2862+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2863|tenant_id |O |1 |string |The ID of the project that owns the resource. |
2864+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2865
2866Response:
2867
2868+-----------------------------+------------------+------------------------------------------------------------------------------+
2869|Attribute |Content |Description |
2870+=============================+==================+==============================================================================+
2871|port |object |A port object. |
2872+-----------------------------+------------------+------------------------------------------------------------------------------+
2873|admin_state_up |boolean |The administrative state of the resource. |
2874+-----------------------------+------------------+------------------------------------------------------------------------------+
2875|allowed_address_pairs |array |A set of zero or more allowed address pairs. |
2876+-----------------------------+------------------+------------------------------------------------------------------------------+
2877|binding:host_id |string |The ID of the host where the port resides. |
2878+-----------------------------+------------------+------------------------------------------------------------------------------+
2879|binding:profile |String |A dictionary that enables the application running on the specific host |
2880+-----------------------------+------------------+------------------------------------------------------------------------------+
2881|binding:vif_details |object |A dictionary which contains additional information on the port. |
2882+-----------------------------+------------------+------------------------------------------------------------------------------+
2883|binding:vif_type |String |The type of which mechanism is used for the port. |
2884+-----------------------------+------------------+------------------------------------------------------------------------------+
2885|binding:vnic_type |string |The type of vNIC which this port should be attached to. |
2886+-----------------------------+------------------+------------------------------------------------------------------------------+
2887|created_at |string |Time at which port has been created. |
2888+-----------------------------+------------------+------------------------------------------------------------------------------+
2889|data_plane_status |string |Status of the underlying data plane of a port. |
2890+-----------------------------+------------------+------------------------------------------------------------------------------+
2891|description |string |A human-readable description for the resource. |
2892+-----------------------------+------------------+------------------------------------------------------------------------------+
2893|device_id |string |The ID of the device that uses this port. |
2894+-----------------------------+------------------+------------------------------------------------------------------------------+
2895|device_owner |string |The entity type that uses this port. |
2896+-----------------------------+------------------+------------------------------------------------------------------------------+
2897|dns_assignment |object |Data assigned to a port by the Networking internal DNS |
2898+-----------------------------+------------------+------------------------------------------------------------------------------+
2899|dns_domain |string |A valid DNS domain. |
2900+-----------------------------+------------------+------------------------------------------------------------------------------+
2901|dns_name |string |A valid DNS name. |
2902+-----------------------------+------------------+------------------------------------------------------------------------------+
2903|extra_dhcp_opts |array |A set of zero or more extra DHCP option pairs. |
2904+-----------------------------+------------------+------------------------------------------------------------------------------+
2905|fixed_ips |array |The IP addresses for the port. |
2906+-----------------------------+------------------+------------------------------------------------------------------------------+
2907|id |string |The ID of the resource. |
2908+-----------------------------+------------------+------------------------------------------------------------------------------+
2909|mac_address |string |The MAC address of the port. |
2910+-----------------------------+------------------+------------------------------------------------------------------------------+
2911|name |string |Human-readable name of the resource. |
2912+-----------------------------+------------------+------------------------------------------------------------------------------+
2913|network_id |string |The ID of the attached network. |
2914+-----------------------------+------------------+------------------------------------------------------------------------------+
2915|port_security_enabled |boolean |The port security status. |
2916+-----------------------------+------------------+------------------------------------------------------------------------------+
2917|project_id |string |The ID of the project. |
2918+-----------------------------+------------------+------------------------------------------------------------------------------+
2919|revision_number |integer |The revision number of the resource. |
2920+-----------------------------+------------------+------------------------------------------------------------------------------+
2921|security_groups |array |The IDs of security groups applied to the port. |
2922+-----------------------------+------------------+------------------------------------------------------------------------------+
2923|status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. |
2924+-----------------------------+------------------+------------------------------------------------------------------------------+
2925|tenant_id |string |The ID of the project. |
2926+-----------------------------+------------------+------------------------------------------------------------------------------+
2927|updated_at |string |Time at which port has been updated. |
2928+-----------------------------+------------------+------------------------------------------------------------------------------+
2929
2930Delete Port
2931+++++++++++++++
2932
2933https://developer.openstack.org/api-ref/network/v2/#delete-port
2934
2935+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2936|Interface Definition|Description |
2937+====================+=======================================================================================================================+
2938|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id} |
2939+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2940|Operation Type |DELETE |
2941+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2942|Content-Type |application/json |
2943+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2944
2945Request Body:
2946
2947+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2948|Attribute |Qualifier|Cardinality|Content |Description |
2949+============================+=========+===========+==========================+==============================================================+
2950|port_id |M |1 |String |The ID of the port. |
2951+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2952
2953Create Security Group
2954++++++++++++++++++++++
2955
2956https://developer.openstack.org/api-ref/network/v2/#create-security-group
2957
2958+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2959|Interface Definition|Description |
2960+====================+=======================================================================================================================+
2961|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups |
2962+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2963|Operation Type |POST |
2964+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2965|Content-Type |application/json |
2966+--------------------+-----------------------------------------------------------------------------------------------------------------------+
2967
2968Request Body:
2969
2970+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2971|Attribute |Qualifier|Cardinality|Content |Description |
2972+============================+=========+===========+==========================+==============================================================+
2973|security_group |M |1 |object |A security_group object. |
2974+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2975|tenant_id |M |1 |string |The ID of the project. |
2976+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2977|project_id |M |1 |string |The ID of the project. |
2978+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2979|description |O |1 |string |A human-readable description for the resource. |
2980+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2981|name |M |1 |string |Human-readable name of the resource. |
2982+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2983
2984Response:
2985
2986+-----------------------------+------------------+------------------------------------------------------------------------------+
2987|Attribute |Content |Description |
2988+=============================+==================+==============================================================================+
2989|security_group |object |A security_group object. |
2990+-----------------------------+------------------+------------------------------------------------------------------------------+
2991|id |string |The ID of the security group. |
2992+-----------------------------+------------------+------------------------------------------------------------------------------+
2993|tenant_id |string |The ID of the project. |
2994+-----------------------------+------------------+------------------------------------------------------------------------------+
2995|project_id |string |The ID of the project. |
2996+-----------------------------+------------------+------------------------------------------------------------------------------+
2997|revision_number |integer |The revision number of the resource. |
2998+-----------------------------+------------------+------------------------------------------------------------------------------+
2999|name |string |Human-readable name of the resource. |
3000+-----------------------------+------------------+------------------------------------------------------------------------------+
3001|description |string |A human-readable description for the resource. |
3002+-----------------------------+------------------+------------------------------------------------------------------------------+
3003|security_group_rules |array |A list of security_group_rule objects. |
3004+-----------------------------+------------------+------------------------------------------------------------------------------+
3005
3006Delete security group
3007++++++++++++++++++++++
3008
3009https://developer.openstack.org/api-ref/network/v2/#delete-security-group
3010
3011+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3012|Interface Definition|Description |
3013+====================+=======================================================================================================================+
3014|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id} |
3015+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3016|Operation Type |DELETE |
3017+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3018|Content-Type |application/json |
3019+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3020
3021Request Body:
3022
3023+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3024|Attribute |Qualifier|Cardinality|Content |Description |
3025+============================+=========+===========+==========================+==============================================================+
3026|security_group_id |M |1 |String |The ID of the security group. |
3027+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3028
3029Create Security Group Rule
3030++++++++++++++++++++++++++
3031
3032https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
3033
3034+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3035|Interface Definition|Description |
3036+====================+=======================================================================================================================+
3037|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules |
3038+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3039|Operation Type |POST |
3040+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3041|Content-Type |application/json |
3042+--------------------+-----------------------------------------------------------------------------------------------------------------------+
3043
3044Request Body:
3045
3046+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3047|Attribute |Qualifier|Cardinality|Content |Description |
3048+============================+=========+===========+==========================+================================================================================================+
3049|security_group_rule |M |1 |object |A security_group_rule object. |
3050+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3051|remote_group_id |O |1 |string |The remote group UUID to associate with this security group rule. |
3052+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3053|direction |M |1 |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3054+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3055|protocol |M |1 |string |The IP protocol can be represented by a string, an integer, or null. |
3056+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3057|ethertype |O |1 |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3058+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3059|port_range_max |O |1 |integer |The maximum port number in the range that is matched by the security group rule. |
3060+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3061|security_group_id |M |1 |string |The security group ID to associate with this security group rule. |
3062+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3063|port_range_min |O |1 |integer |The minimum port number in the range that is matched by the security group rule. |
3064+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3065|remote_ip_prefix |M |1 |string |The remote IP prefix to associate with this metering rule packet. |
3066+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3067|description |O |1 |string |A human-readable description for the resource. Default is an empty string. |
3068+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3069
3070Response:
3071
3072+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3073|Attribute |Content |Description |
3074+=============================+==================+=================================================================================================+
3075|security_group_rule |object |A security_group_rule object. |
3076+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3077|remote_group_id |string |The remote group UUID to associate with this security group rule. |
3078+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3079|direction |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3080+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3081|protocol |string |The IP protocol can be represented by a string, an integer, or null. |
3082+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3083|ethertype |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3084+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3085|port_range_max |integer |The maximum port number in the range that is matched by the security group rule. |
3086+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3087|security_group_id |string |The security group ID to associate with this security group rule. |
3088+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3089|tenant_id |string |The ID of the project. |
3090+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3091|project_id |string |The ID of the project. |
3092+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3093|port_range_min |integer |The minimum port number in the range that is matched by the security group rule. |
3094+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3095|remote_ip_prefix |string |The remote IP prefix to associate with this metering rule packet. |
3096+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3097|revision_number |integer |The revision number of the resource. |
3098+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3099|id |string |The ID of the security group rule. |
3100+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3101|description |string |A human-readable description for the resource. |
3102+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3103
3104Delete security group
3105++++++++++++++++++++++
3106
3107https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
3108
3109+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3110|Interface Definition|Description |
3111+====================+=================================================================================================================================+
3112|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id} |
3113+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3114|Operation Type |DELETE |
3115+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3116|Content-Type |application/json |
3117+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3118
3119Request Body:
3120
3121+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3122|Attribute |Qualifier|Cardinality|Content |Description |
3123+============================+=========+===========+==========================+==============================================================+
3124|security_group_rule_id |M |1 |String |The ID of the security group rule. |
3125+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3126
3127Policy API
3128----------
3129
3130Create a dictionary item
3131++++++++++++++++++++++++
3132
3133+--------------------+--------------------------+
3134|Interface Definition|Description |
3135+====================+==========================+
3136|URI |/createDictionaryItem |
3137+--------------------+--------------------------+
3138|Operation Type |PUT |
3139+--------------------+--------------------------+
3140
3141Request Parameters:
3142
3143+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3144|Attribute |Qualifier|Cardinality|Content|Description |
3145+===================+=========+===========+=======+=============================================================+
3146|dictionory |M |1 |String | |
3147+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3148|dictionaryJson |M |1 |String | |
3149+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3150|dictionaryType |M |1 |String | |
3151+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3152|requestId |M |1 |String | |
3153+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3154
3155Request Headers:
3156
3157+-------------------+---------+-----------------------------------------------------------------------------------------+
3158|Header Name |Qualifier|Description |
3159+===================+=========+=========================================================================================+
3160|ClientAuth |Y |encoded client authentication details |
3161+-------------------+---------+-----------------------------------------------------------------------------------------+
3162|X-ECOMP-RequestID |N |Request ID to track the requests |
3163+-------------------+---------+-----------------------------------------------------------------------------------------+
3164|Environment |Y |execution environments |
3165+-------------------+---------+-----------------------------------------------------------------------------------------+
3166|Authorization |Y |Base64 encoded username:password |
3167+-------------------+---------+-----------------------------------------------------------------------------------------+
3168
3169HTTP Response Code:
3170
3171+------------------+---------------------+
3172|HTTP CODE |Description |
3173+==================+=====================+
3174|200 |successful |
3175+------------------+---------------------+
3176|400 |Invalid Request |
3177+------------------+---------------------+
3178|401 |Unauthorized |
3179+------------------+---------------------+
3180|500 |Error |
3181+------------------+---------------------+
3182
3183Create Policy
3184+++++++++++++
3185
3186+--------------------+--------------------------+
3187|Interface Definition|Description |
3188+====================+==========================+
3189|URI |/createPolicy |
3190+--------------------+--------------------------+
3191|Operation Type |PUT |
3192+--------------------+--------------------------+
3193
3194Request Parameters:
3195
3196+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3197|Attribute |Qualifier|Cardinality|Content|Description |
3198+===================+=========+===========+=======+=============================================================+
3199|attributes |M |1 |Object |set of attributes in key value pair |
3200+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3201|configBody |M |1 |String | |
3202+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3203|configBodyType |M |1 |String | |
3204+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3205|configName |M |1 |String | |
3206+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3207|ecompName |M |1 |String | |
3208+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3209|policyClass |M |1 |String | |
3210+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3211|policyConfigType |M |1 |String | |
3212+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3213|policyDescription |M |1 |String | |
3214+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3215|policyName |M |1 |String | |
3216+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3217|requestID |M |1 |String |request ID |
3218+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3219
3220Request Headers:
3221
3222+-------------------+---------+-----------------------------------------------------------------------------------------+
3223|Header Name |Qualifier|Description |
3224+===================+=========+=========================================================================================+
3225|ClientAuth |Y |encoded client authentication details |
3226+-------------------+---------+-----------------------------------------------------------------------------------------+
3227|X-ECOMP-RequestID |N |Request ID to track the requests |
3228+-------------------+---------+-----------------------------------------------------------------------------------------+
3229|Environment |Y |execution environments |
3230+-------------------+---------+-----------------------------------------------------------------------------------------+
3231|Authorization |Y |Base64 encoded username:password |
3232+-------------------+---------+-----------------------------------------------------------------------------------------+
3233
3234HTTP Response Code:
3235
3236+------------------+---------------------+
3237|HTTP CODE |Description |
3238+==================+=====================+
3239|200 |successful |
3240+------------------+---------------------+
3241|400 |Invalid Request |
3242+------------------+---------------------+
3243|401 |Unauthorized |
3244+------------------+---------------------+
3245|500 |Error |
3246+------------------+---------------------+
3247
3248Delete Policy
3249+++++++++++++
3250
3251+--------------------+--------------------------+
3252|Interface Definition|Description |
3253+====================+==========================+
3254|URI |/deletePolicy |
3255+--------------------+--------------------------+
3256|Operation Type |DELETE |
3257+--------------------+--------------------------+
3258
3259Request Parameters:
3260
3261+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3262|Attribute |Qualifier|Cardinality|Content|Description |
3263+===================+=========+===========+=======+=============================================================+
3264|deleteCondition |M |1 |String | |
3265+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3266|pdpGroup |M |1 |String | |
3267+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3268|policyComponent |M |1 |String | |
3269+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3270|policyName |M |1 |String | |
3271+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3272|policyType |M |1 |String | |
3273+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3274|requestID |M |1 |String |request ID |
3275+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3276
3277Request Headers:
3278
3279+-------------------+---------+-----------------------------------------------------------------------------------------+
3280|Header Name |Qualifier|Description |
3281+===================+=========+=========================================================================================+
3282|ClientAuth |Y |encoded client authentication details |
3283+-------------------+---------+-----------------------------------------------------------------------------------------+
3284|X-ECOMP-RequestID |N |Request ID to track the requests |
3285+-------------------+---------+-----------------------------------------------------------------------------------------+
3286|Environment |Y |execution environments |
3287+-------------------+---------+-----------------------------------------------------------------------------------------+
3288|Authorization |Y |Base64 encoded username:password |
3289+-------------------+---------+-----------------------------------------------------------------------------------------+
3290
3291HTTP Response Code:
3292
3293+------------------+---------------------+
3294|HTTP CODE |Description |
3295+==================+=====================+
3296|200 |successful |
3297+------------------+---------------------+
3298|400 |Invalid Request |
3299+------------------+---------------------+
3300|401 |Unauthorized |
3301+------------------+---------------------+
3302|500 |Error |
3303+------------------+---------------------+
3304
3305Get Configuration
3306+++++++++++++++++
3307
3308+--------------------+--------------------------+
3309|Interface Definition|Description |
3310+====================+==========================+
3311|URI |/getConfig |
3312+--------------------+--------------------------+
3313|Operation Type |POST |
3314+--------------------+--------------------------+
3315
3316Request Parameters:
3317
3318+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3319|Attribute |Qualifier|Cardinality|Content|Description |
3320+===================+=========+===========+=======+=============================================================+
3321|configAttributes |M |1 |String | |
3322+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3323|configName |M |1 |String | |
3324+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3325|ecompName |M |1 |String | |
3326+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3327|policyName |M |1 |String | |
3328+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3329|unique |M |1 |Boolean| |
3330+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3331|requestID |M |1 |String |request ID |
3332+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3333
3334Request Headers:
3335
3336+-------------------+---------+-----------------------------------------------------------------------------------------+
3337|Header Name |Qualifier|Description |
3338+===================+=========+=========================================================================================+
3339|ClientAuth |Y |encoded client authentication details |
3340+-------------------+---------+-----------------------------------------------------------------------------------------+
3341|X-ECOMP-RequestID |N |Request ID to track the requests |
3342+-------------------+---------+-----------------------------------------------------------------------------------------+
3343|Environment |Y |execution environments |
3344+-------------------+---------+-----------------------------------------------------------------------------------------+
3345|Authorization |Y |Base64 encoded username:password |
3346+-------------------+---------+-----------------------------------------------------------------------------------------+
3347
3348HTTP Response Code:
3349
3350+------------------+---------------------+
3351|HTTP CODE |Description |
3352+==================+=====================+
3353|200 |successful |
3354+------------------+---------------------+
3355|400 |Invalid Request |
3356+------------------+---------------------+
3357|401 |Unauthorized |
3358+------------------+---------------------+
3359|500 |Error |
3360+------------------+---------------------+
3361
3362Get Decision
3363++++++++++++
3364
3365+--------------------+--------------------------+
3366|Interface Definition|Description |
3367+====================+==========================+
3368|URI |/getDecision |
3369+--------------------+--------------------------+
3370|Operation Type |POST |
3371+--------------------+--------------------------+
3372
3373Request Parameters:
3374
3375+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3376|Attribute |Qualifier|Cardinality|Content|Description |
3377+===================+=========+===========+=======+=============================================================+
3378|decisionAttributes |M |1 |Object | |
3379+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3380|ecompComponentName |M |1 |String | |
3381+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3382|requestID |M |1 |String |request ID |
3383+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3384
3385Request Headers:
3386
3387+-------------------+---------+-----------------------------------------------------------------------------------------+
3388|Header Name |Qualifier|Description |
3389+===================+=========+=========================================================================================+
3390|ClientAuth |Y |encoded client authentication details |
3391+-------------------+---------+-----------------------------------------------------------------------------------------+
3392|X-ECOMP-RequestID |N |Request ID to track the requests |
3393+-------------------+---------+-----------------------------------------------------------------------------------------+
3394|Environment |Y |execution environments |
3395+-------------------+---------+-----------------------------------------------------------------------------------------+
3396|Authorization |Y |Base64 encoded username:password |
3397+-------------------+---------+-----------------------------------------------------------------------------------------+
3398
3399HTTP Response Code:
3400
3401+------------------+---------------------+
3402|HTTP CODE |Description |
3403+==================+=====================+
3404|200 |successful |
3405+------------------+---------------------+
3406|400 |Invalid Request |
3407+------------------+---------------------+
3408|401 |Unauthorized |
3409+------------------+---------------------+
3410|500 |Error |
3411+------------------+---------------------+
3412
3413Response Parameters:
3414
3415+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3416|Attribute |Qualifier|Cardinality|Content|Description |
3417+===================+=========+===========+=======+=============================================================+
3418|decision |N |1 |String | |
3419+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3420|details |N |1 |String | |
3421+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3422
3423Get Dictionary Items
3424++++++++++++++++++++
3425
3426+--------------------+--------------------------+
3427|Interface Definition|Description |
3428+====================+==========================+
3429|URI |/getDictionaryItems |
3430+--------------------+--------------------------+
3431|Operation Type |POST |
3432+--------------------+--------------------------+
3433
3434Request Parameters:
3435
3436+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3437|Attribute |Qualifier|Cardinality|Content|Description |
3438+===================+=========+===========+=======+=============================================================+
3439|dictionary |N |1 |String | |
3440+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3441|dictionaryJson |N |1 |String | |
3442+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3443|dictionaryType |N |1 |String | |
3444+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3445|requestID |M |1 |String |request ID |
3446+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3447
3448Request Headers:
3449
3450+-------------------+---------+-----------------------------------------------------------------------------------------+
3451|Header Name |Qualifier|Description |
3452+===================+=========+=========================================================================================+
3453|ClientAuth |Y |encoded client authentication details |
3454+-------------------+---------+-----------------------------------------------------------------------------------------+
3455|X-ECOMP-RequestID |N |Request ID to track the requests |
3456+-------------------+---------+-----------------------------------------------------------------------------------------+
3457|Environment |Y |execution environments |
3458+-------------------+---------+-----------------------------------------------------------------------------------------+
3459|Authorization |Y |Base64 encoded username:password |
3460+-------------------+---------+-----------------------------------------------------------------------------------------+
3461
3462HTTP Response Code:
3463
3464+------------------+---------------------+
3465|HTTP CODE |Description |
3466+==================+=====================+
3467|200 |successful |
3468+------------------+---------------------+
3469|400 |Invalid Request |
3470+------------------+---------------------+
3471|401 |Unauthorized |
3472+------------------+---------------------+
3473|500 |Error |
3474+------------------+---------------------+
3475
3476Response Parameters:
3477
3478+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3479|Attribute |Qualifier|Cardinality|Content|Description |
3480+===================+=========+===========+=======+=============================================================+
3481|dictionaryData |N |1 |Object | |
3482+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3483|dictionaryJson |N |1 |Object | |
3484+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3485|responseCode |N |1 |Integer| |
3486+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3487|responseMessage |N |1 |Object | |
3488+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3489
3490Get Metrics
3491+++++++++++
3492
3493+--------------------+--------------------------+
3494|Interface Definition|Description |
3495+====================+==========================+
3496|URI |/getMetrics |
3497+--------------------+--------------------------+
3498|Operation Type |GET |
3499+--------------------+--------------------------+
3500
3501Request Headers:
3502
3503+-------------------+---------+-----------------------------------------------------------------------------------------+
3504|Header Name |Qualifier|Description |
3505+===================+=========+=========================================================================================+
3506|ClientAuth |Y |encoded client authentication details |
3507+-------------------+---------+-----------------------------------------------------------------------------------------+
3508|X-ECOMP-RequestID |N |Request ID to track the requests |
3509+-------------------+---------+-----------------------------------------------------------------------------------------+
3510|Environment |Y |execution environments |
3511+-------------------+---------+-----------------------------------------------------------------------------------------+
3512|Authorization |Y |Base64 encoded username:password |
3513+-------------------+---------+-----------------------------------------------------------------------------------------+
3514
3515HTTP Response Code:
3516
3517+------------------+---------------------+
3518|HTTP CODE |Description |
3519+==================+=====================+
3520|200 |successful |
3521+------------------+---------------------+
3522|400 |Invalid Request |
3523+------------------+---------------------+
3524|401 |Unauthorized |
3525+------------------+---------------------+
3526|500 |Error |
3527+------------------+---------------------+
3528
3529Response Parameters:
3530
3531+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3532|Attribute |Qualifier|Cardinality|Content|Description |
3533+===================+=========+===========+=======+=============================================================+
3534|metricsTotal |N |1 |Integer| |
3535+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3536|papMetrics |N |1 |Integer| |
3537+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3538|pdpMetrics |N |1 |Integer| |
3539+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3540|responseCode |N |1 |Object | |
3541+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3542|responseMessage |N |1 |String | |
3543+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3544
3545Get Notification
3546++++++++++++++++
3547
3548+--------------------+--------------------------+
3549|Interface Definition|Description |
3550+====================+==========================+
3551|URI |/getNotification |
3552+--------------------+--------------------------+
3553|Operation Type |POST |
3554+--------------------+--------------------------+
3555
3556Request Headers:
3557
3558+-------------------+---------+-----------------------------------------------------------------------------------------+
3559|Header Name |Qualifier|Description |
3560+===================+=========+=========================================================================================+
3561|ClientAuth |Y |encoded client authentication details |
3562+-------------------+---------+-----------------------------------------------------------------------------------------+
3563|X-ECOMP-RequestID |N |Request ID to track the requests |
3564+-------------------+---------+-----------------------------------------------------------------------------------------+
3565|Environment |Y |execution environments |
3566+-------------------+---------+-----------------------------------------------------------------------------------------+
3567|Authorization |Y |Base64 encoded username:password |
3568+-------------------+---------+-----------------------------------------------------------------------------------------+
3569
3570HTTP Response Code:
3571
3572+------------------+---------------------+
3573|HTTP CODE |Description |
3574+==================+=====================+
3575|200 |successful |
3576+------------------+---------------------+
3577|400 |Invalid Request |
3578+------------------+---------------------+
3579|401 |Unauthorized |
3580+------------------+---------------------+
3581|500 |Error |
3582+------------------+---------------------+
3583
3584Response Parameters:
3585
3586+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3587|Attribute |Qualifier|Cardinality|Content|Description |
3588+===================+=========+===========+=======+=============================================================+
3589|metricsTotal |N |1 |Integer| |
3590+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3591|papMetrics |N |1 |Integer| |
3592+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3593|pdpMetrics |N |1 |Integer| |
3594+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3595|responseCode |N |1 |Object | |
3596+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3597|responseMessage |N |1 |String | |
3598+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3599
3600List Configuration
3601++++++++++++++++++
3602
3603+--------------------+--------------------------+
3604|Interface Definition|Description |
3605+====================+==========================+
3606|URI |/listConfiguration |
3607+--------------------+--------------------------+
3608|Operation Type |POST |
3609+--------------------+--------------------------+
3610
3611Request Headers:
3612
3613+-------------------+---------+-----------------------------------------------------------------------------------------+
3614|Header Name |Qualifier|Description |
3615+===================+=========+=========================================================================================+
3616|ClientAuth |Y |encoded client authentication details |
3617+-------------------+---------+-----------------------------------------------------------------------------------------+
3618|X-ECOMP-RequestID |N |Request ID to track the requests |
3619+-------------------+---------+-----------------------------------------------------------------------------------------+
3620|Environment |Y |execution environments |
3621+-------------------+---------+-----------------------------------------------------------------------------------------+
3622|Authorization |Y |Base64 encoded username:password |
3623+-------------------+---------+-----------------------------------------------------------------------------------------+
3624
3625Request Parameters:
3626
3627+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3628|Attribute |Qualifier|Cardinality|Content|Description |
3629+===================+=========+===========+=======+=============================================================+
3630|configAttributes |N |1 |Object | |
3631+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3632|configName |N |1 |String | |
3633+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3634|ecompName |N |1 |String | |
3635+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3636|policyName |N |1 |String | |
3637+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3638|requestID |N |1 |String | |
3639+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3640|unique |N |1 |Boolean| |
3641+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3642
3643HTTP Response Code:
3644
3645+------------------+---------------------+
3646|HTTP CODE |Description |
3647+==================+=====================+
3648|200 |successful |
3649+------------------+---------------------+
3650|400 |Invalid Request |
3651+------------------+---------------------+
3652|401 |Unauthorized |
3653+------------------+---------------------+
3654|500 |Error |
3655+------------------+---------------------+
3656
3657Import policy
3658+++++++++++++
3659
3660+--------------------+--------------------------+
3661|Interface Definition|Description |
3662+====================+==========================+
3663|URI |/policyEngineImport |
3664+--------------------+--------------------------+
3665|Operation Type |POST |
3666+--------------------+--------------------------+
3667
3668Request Headers:
3669
3670+-------------------+---------+-----------------------------------------------------------------------------------------+
3671|Header Name |Qualifier|Description |
3672+===================+=========+=========================================================================================+
3673|ClientAuth |Y |encoded client authentication details |
3674+-------------------+---------+-----------------------------------------------------------------------------------------+
3675|X-ECOMP-RequestID |N |Request ID to track the requests |
3676+-------------------+---------+-----------------------------------------------------------------------------------------+
3677|Environment |Y |execution environments |
3678+-------------------+---------+-----------------------------------------------------------------------------------------+
3679|Authorization |Y |Base64 encoded username:password |
3680+-------------------+---------+-----------------------------------------------------------------------------------------+
3681
3682Request Parameters:
3683
3684+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3685|Attribute |Qualifier|Cardinality|Content|Description |
3686+===================+=========+===========+=======+=============================================================+
3687|importParameterJson|Y |1 |String | |
3688+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3689|file |Y |1 |File | |
3690+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3691
3692HTTP Response Code:
3693
3694+------------------+---------------------+
3695|HTTP CODE |Description |
3696+==================+=====================+
3697|200 |successful |
3698+------------------+---------------------+
3699|400 |Invalid Request |
3700+------------------+---------------------+
3701|401 |Unauthorized |
3702+------------------+---------------------+
3703|500 |Error |
3704+------------------+---------------------+
3705
3706Push Policy
3707+++++++++++
3708
3709+--------------------+--------------------------+
3710|Interface Definition|Description |
3711+====================+==========================+
3712|URI |/pushPolicy |
3713+--------------------+--------------------------+
3714|Operation Type |PUT |
3715+--------------------+--------------------------+
3716
3717Request Headers:
3718
3719+-------------------+---------+-----------------------------------------------------------------------------------------+
3720|Header Name |Qualifier|Description |
3721+===================+=========+=========================================================================================+
3722|ClientAuth |Y |encoded client authentication details |
3723+-------------------+---------+-----------------------------------------------------------------------------------------+
3724|X-ECOMP-RequestID |N |Request ID to track the requests |
3725+-------------------+---------+-----------------------------------------------------------------------------------------+
3726|Environment |Y |execution environments |
3727+-------------------+---------+-----------------------------------------------------------------------------------------+
3728|Authorization |Y |Base64 encoded username:password |
3729+-------------------+---------+-----------------------------------------------------------------------------------------+
3730
3731Request Parameters:
3732
3733+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3734|Attribute |Qualifier|Cardinality|Content|Description |
3735+===================+=========+===========+=======+=============================================================+
3736|pdpGroup |N |1 |String | |
3737+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3738|policyName |N |1 |String | |
3739+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3740|policyType |N |1 |String | |
3741+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3742
3743HTTP Response Code:
3744
3745+------------------+---------------------+
3746|HTTP CODE |Description |
3747+==================+=====================+
3748|200 |successful |
3749+------------------+---------------------+
3750|400 |Invalid Request |
3751+------------------+---------------------+
3752|401 |Unauthorized |
3753+------------------+---------------------+
3754|500 |Error |
3755+------------------+---------------------+
3756
3757Send Event
3758++++++++++
3759
3760+--------------------+--------------------------+
3761|Interface Definition|Description |
3762+====================+==========================+
3763|URI |/sendEvent |
3764+--------------------+--------------------------+
3765|Operation Type |POST |
3766+--------------------+--------------------------+
3767
3768Request Headers:
3769
3770+-------------------+---------+-----------------------------------------------------------------------------------------+
3771|Header Name |Qualifier|Description |
3772+===================+=========+=========================================================================================+
3773|ClientAuth |Y |encoded client authentication details |
3774+-------------------+---------+-----------------------------------------------------------------------------------------+
3775|X-ECOMP-RequestID |N |Request ID to track the requests |
3776+-------------------+---------+-----------------------------------------------------------------------------------------+
3777|Environment |Y |execution environments |
3778+-------------------+---------+-----------------------------------------------------------------------------------------+
3779|Authorization |Y |Base64 encoded username:password |
3780+-------------------+---------+-----------------------------------------------------------------------------------------+
3781
3782Request Parameters:
3783
3784+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3785|Attribute |Qualifier|Cardinality|Content|Description |
3786+===================+=========+===========+=======+=============================================================+
3787|eventAttributes |N |1 |Object | |
3788+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3789|requestID |N |1 |String | |
3790+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3791
3792HTTP Response Code:
3793
3794+------------------+---------------------+
3795|HTTP CODE |Description |
3796+==================+=====================+
3797|200 |successful |
3798+------------------+---------------------+
3799|400 |Invalid Request |
3800+------------------+---------------------+
3801|401 |Unauthorized |
3802+------------------+---------------------+
3803|500 |Error |
3804+------------------+---------------------+
3805
3806Send Heartbeat
3807++++++++++++++
3808
3809+--------------------+--------------------------+
3810|Interface Definition|Description |
3811+====================+==========================+
3812|URI |/sendEvent |
3813+--------------------+--------------------------+
3814|Operation Type |POST |
3815+--------------------+--------------------------+
3816
3817Request Headers:
3818
3819+-------------------+---------+-----------------------------------------------------------------------------------------+
3820|Header Name |Qualifier|Description |
3821+===================+=========+=========================================================================================+
3822|ClientAuth |Y |encoded client authentication details |
3823+-------------------+---------+-----------------------------------------------------------------------------------------+
3824|X-ECOMP-RequestID |N |Request ID to track the requests |
3825+-------------------+---------+-----------------------------------------------------------------------------------------+
3826|Environment |Y |execution environments |
3827+-------------------+---------+-----------------------------------------------------------------------------------------+
3828|Authorization |Y |Base64 encoded username:password |
3829+-------------------+---------+-----------------------------------------------------------------------------------------+
3830
3831Request Parameters:
3832
3833+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3834|Attribute |Qualifier|Cardinality|Content|Description |
3835+===================+=========+===========+=======+=============================================================+
3836|notificationTopic |Y |1 |String | |
3837+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3838
3839HTTP Response Code:
3840
3841+------------------+---------------------+
3842|HTTP CODE |Description |
3843+==================+=====================+
3844|200 |successful |
3845+------------------+---------------------+
3846|400 |Invalid Request |
3847+------------------+---------------------+
3848|401 |Unauthorized |
3849+------------------+---------------------+
3850|500 |Error |
3851+------------------+---------------------+
3852
3853Stop Notification
3854+++++++++++++++++
3855
3856+--------------------+--------------------------+
3857|Interface Definition|Description |
3858+====================+==========================+
3859|URI |/stopNotification |
3860+--------------------+--------------------------+
3861|Operation Type |POST |
3862+--------------------+--------------------------+
3863
3864Request Headers:
3865
3866+-------------------+---------+-----------------------------------------------------------------------------------------+
3867|Header Name |Qualifier|Description |
3868+===================+=========+=========================================================================================+
3869|ClientAuth |Y |encoded client authentication details |
3870+-------------------+---------+-----------------------------------------------------------------------------------------+
3871|X-ECOMP-RequestID |N |Request ID to track the requests |
3872+-------------------+---------+-----------------------------------------------------------------------------------------+
3873|Environment |Y |execution environments |
3874+-------------------+---------+-----------------------------------------------------------------------------------------+
3875|Authorization |Y |Base64 encoded username:password |
3876+-------------------+---------+-----------------------------------------------------------------------------------------+
3877
3878Request Parameters:
3879
3880+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3881|Attribute |Qualifier|Cardinality|Content|Description |
3882+===================+=========+===========+=======+=============================================================+
3883|notificationTopic |Y |1 |String | |
3884+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3885
3886HTTP Response Code:
3887
3888+------------------+---------------------+
3889|HTTP CODE |Description |
3890+==================+=====================+
3891|200 |successful |
3892+------------------+---------------------+
3893|400 |Invalid Request |
3894+------------------+---------------------+
3895|401 |Unauthorized |
3896+------------------+---------------------+
3897|500 |Error |
3898+------------------+---------------------+
3899
3900Update Dictionary
3901+++++++++++++++++
3902
3903+--------------------+--------------------------+
3904|Interface Definition|Description |
3905+====================+==========================+
3906|URI |/updateDictionaryItem |
3907+--------------------+--------------------------+
3908|Operation Type |PUT |
3909+--------------------+--------------------------+
3910
3911Request Headers:
3912
3913+-------------------+---------+-----------------------------------------------------------------------------------------+
3914|Header Name |Qualifier|Description |
3915+===================+=========+=========================================================================================+
3916|ClientAuth |Y |encoded client authentication details |
3917+-------------------+---------+-----------------------------------------------------------------------------------------+
3918|X-ECOMP-RequestID |N |Request ID to track the requests |
3919+-------------------+---------+-----------------------------------------------------------------------------------------+
3920|Environment |Y |execution environments |
3921+-------------------+---------+-----------------------------------------------------------------------------------------+
3922|Authorization |Y |Base64 encoded username:password |
3923+-------------------+---------+-----------------------------------------------------------------------------------------+
3924
3925Request Parameters:
3926
3927+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3928|Attribute |Qualifier|Cardinality|Content|Description |
3929+===================+=========+===========+=======+=============================================================+
3930|dictionary |N |1 |String | |
3931+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3932|dictionaryJson |N |1 |String | |
3933+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3934|dictionaryType |N |1 |String | |
3935+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3936|requestID |N |1 |String | |
3937+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3938
3939HTTP Response Code:
3940
3941+------------------+---------------------+
3942|HTTP CODE |Description |
3943+==================+=====================+
3944|200 |successful |
3945+------------------+---------------------+
3946|400 |Invalid Request |
3947+------------------+---------------------+
3948|401 |Unauthorized |
3949+------------------+---------------------+
3950|500 |Error |
3951+------------------+---------------------+
3952
3953Update Policy
3954+++++++++++++
3955
3956+--------------------+--------------------------+
3957|Interface Definition|Description |
3958+====================+==========================+
3959|URI |/updatePolicy |
3960+--------------------+--------------------------+
3961|Operation Type |PUT |
3962+--------------------+--------------------------+
3963
3964Request Headers:
3965
3966+-------------------+---------+-----------------------------------------------------------------------------------------+
3967|Header Name |Qualifier|Description |
3968+===================+=========+=========================================================================================+
3969|ClientAuth |Y |encoded client authentication details |
3970+-------------------+---------+-----------------------------------------------------------------------------------------+
3971|X-ECOMP-RequestID |N |Request ID to track the requests |
3972+-------------------+---------+-----------------------------------------------------------------------------------------+
3973|Environment |Y |execution environments |
3974+-------------------+---------+-----------------------------------------------------------------------------------------+
3975|Authorization |Y |Base64 encoded username:password |
3976+-------------------+---------+-----------------------------------------------------------------------------------------+
3977
3978Request Parameters:
3979
3980+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3981|Attribute |Qualifier|Cardinality|Content|Description |
3982+===================+=========+===========+=======+=============================================================+
3983|attributes |N |1 |Object | |
3984+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3985|configBody |N |1 |String | |
3986+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3987|configBodyType |N |1 |String | |
3988+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3989|configName |N |1 |String | |
3990+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3991|ecompName |N |1 |String | |
3992+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3993|policyClass |N |1 |String | |
3994+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3995|policyConfigType |N |1 |String | |
3996+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3997|policyDescription |N |1 |String | |
3998+-------------------+---------+-----------+-------+-------------------------------------------------------------+
3999|policyName |N |1 |String | |
4000+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4001|requestID |N |1 |String | |
4002+-------------------+---------+-----------+-------+-------------------------------------------------------------+
4003
4004HTTP Response Code:
4005
4006+------------------+---------------------+
4007|HTTP CODE |Description |
4008+==================+=====================+
4009|200 |successful |
4010+------------------+---------------------+
4011|400 |Invalid Request |
4012+------------------+---------------------+
4013|401 |Unauthorized |
4014+------------------+---------------------+
4015|500 |Error |
seshukm62de8672017-12-12 17:26:20 +0530[diff] [blame]4016+------------------+---------------------+