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.
5 SO Amsterdam Interfaces
8 .. image:: images/SO_R1_1.png
15 Create service instance
16 ++++++++++++++++++++++++
18 +--------------------+-------------------------------------+
19 |Interface Definition|Description |
20 +====================+=====================================+
21 |URI |{serverRoot}/serviceInstances/v4 |
22 +--------------------+-------------------------------------+
23 |Operation Type |POST |
24 +--------------------+-------------------------------------+
25 |Content-Type |application/json |
26 +--------------------+-------------------------------------+
30 +----------------+---------+-----------+--------------------------+-------------------------------------------+
31 |Attribute |Qualifier|Cardinality|Content |Description |
32 +================+=========+===========+==========================+===========================================+
33 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
34 +----------------+---------+-----------+--------------------------+-------------------------------------------+
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 +-------------------+--------------------------+-------------------------------------------------+
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 |modelCustomizationUuid |String |The Model Customization UUid |
80 +-------------------------+------------------+-------------------------------------------------+
81 |modelVersionId |String |The Model version id |
82 +-------------------------+------------------+-------------------------------------------------+
83 |modelUuid |String |The Model UUid |
84 +-------------------------+------------------+-------------------------------------------------+
85 |modelInvariantUuid |String |The Model Invariant UUid |
86 +-------------------------+------------------+-------------------------------------------------+
87 |modelInstanceName |String |The Model Instance name |
88 +-------------------------+------------------+-------------------------------------------------+
93 +-------------------------+------------------+-------------------------------------------------+
94 |Attribute |Content |Description |
95 +=========================+==================+=================================================+
96 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
97 +-------------------------+------------------+-------------------------------------------------+
98 |SubscriberName |String |Name of the Subscriber |
99 +-------------------------+------------------+-------------------------------------------------+
103 +-------------------------+------------------+-------------------------------------------------+
104 |Attribute |Content |Description |
105 +=========================+==================+=================================================+
106 |Source |String |source of the request |
107 +-------------------------+------------------+-------------------------------------------------+
108 |billingAccountNumber |String |billingAccountNumber of the request |
109 +-------------------------+------------------+-------------------------------------------------+
110 |callbackUrl |String |callbackUrl of the request |
111 +-------------------------+------------------+-------------------------------------------------+
112 |correlator |String |correlator of the request |
113 +-------------------------+------------------+-------------------------------------------------+
114 |orderNumber |String |orderNumber of the request |
115 +-------------------------+------------------+-------------------------------------------------+
116 |productFamilyId |String |productFamilyId of the request |
117 +-------------------------+------------------+-------------------------------------------------+
118 |orderVersion |String |orderVersion of the request |
119 +-------------------------+------------------+-------------------------------------------------+
120 |instanceName |String |instanceName of the request |
121 +-------------------------+------------------+-------------------------------------------------+
122 |suppressRollback |String |suppressRollback of the request |
123 +-------------------------+------------------+-------------------------------------------------+
124 |requestorId |String |requestorId of the request |
125 +-------------------------+------------------+-------------------------------------------------+
127 RequestParameters Object
129 +-------------------------+------------------+-------------------------------------------------+
130 |Attribute |Content |Description |
131 +=========================+==================+=================================================+
132 |SubscriptionServiceType |String |The service type of the Subscription |
133 +-------------------------+------------------+-------------------------------------------------+
134 |UserParams |Array |The product family Id. |
135 +-------------------------+------------------+-------------------------------------------------+
136 |aLaCarte |Boolean | aLaCarte |
137 +-------------------------+------------------+-------------------------------------------------+
138 |autoBuildVfModules |Boolean |autoBuildVfModules |
139 +-------------------------+------------------+-------------------------------------------------+
140 |cascadeDelete |Boolean |cascadeDelete |
141 +-------------------------+------------------+-------------------------------------------------+
142 |usePreload |Boolean |usePreload |
143 +-------------------------+------------------+-------------------------------------------------+
144 |rebuildVolumeGroups |Boolean |rebuildVolumeGroups |
145 +-------------------------+------------------+-------------------------------------------------+
146 |payload |String |payload |
147 +-------------------------+------------------+-------------------------------------------------+
148 |controllerType |String |controllerType |
149 +-------------------------+------------------+-------------------------------------------------+
153 +-------------------------+------------------+-------------------------------------------------+
154 |Attribute |Content |Description |
155 +=========================+==================+=================================================+
156 |name |String |Tag name of attribute |
157 +-------------------------+------------------+-------------------------------------------------+
158 |value |String |Value of the tag |
159 +-------------------------+------------------+-------------------------------------------------+
161 CloudConfiguration Object
163 +-------------------------+------------------+-------------------------------------------------+
164 |Attribute |Content |Description |
165 +=========================+==================+=================================================+
166 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
167 +-------------------------+------------------+-------------------------------------------------+
168 |tenantId |String |Name of the Subscriber |
169 +-------------------------+------------------+-------------------------------------------------+
170 |aicNodeClli |String |aicNodeClli property |
171 +-------------------------+------------------+-------------------------------------------------+
175 +-------------------------+------------------+-------------------------------------------------+
176 |Attribute |Content |Description |
177 +=========================+==================+=================================================+
178 |projectName |String |Name of the project |
179 +-------------------------+------------------+-------------------------------------------------+
183 +-------------------------+------------------+-------------------------------------------------+
184 |Attribute |Content |Description |
185 +=========================+==================+=================================================+
186 |owningEntityId |String |owningEntityId of the owingEntity |
187 +-------------------------+------------------+-------------------------------------------------+
188 |owningEntityName |String |owningEntityName of the owingEntity |
189 +-------------------------+------------------+-------------------------------------------------+
193 +-------------------------+------------------+-------------------------------------------------+
194 |Attribute |Content |Description |
195 +=========================+==================+=================================================+
196 |platformName |String |Platform Name |
197 +-------------------------+------------------+-------------------------------------------------+
199 LineOfBusiness Object
201 +-------------------------+------------------+-------------------------------------------------+
202 |Attribute |Content |Description |
203 +=========================+==================+=================================================+
204 |lineOfBusinessName |String |Line Of Business Name |
205 +-------------------------+------------------+-------------------------------------------------+
207 Delete service instance
208 ++++++++++++++++++++++++
210 +--------------------+---------------------------------------------------------+
211 |Interface Definition|Description |
212 +====================+=========================================================+
213 |URI |{serverRoot}/serviceInstances/v4/{serviceInstanceId} |
214 +--------------------+---------------------------------------------------------+
215 |Operation Type |DELETE |
216 +--------------------+---------------------------------------------------------+
217 |Content-Type |application/json |
218 +--------------------+---------------------------------------------------------+
222 +----------------+---------+-----------+--------------------------+-------------------------------------------+
223 |Attribute |Qualifier|Cardinality|Content |Description |
224 +================+=========+===========+==========================+===========================================+
225 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
226 +----------------+---------+-----------+--------------------------+-------------------------------------------+
228 RequestDetails Object
230 +-------------------+-------------------------+-------------------------------------------------+
231 |Attribute |Content |Description |
232 +===================+=========================+=================================================+
233 |modelInfo |modelInfo Object |Content of modelInfo object. |
234 +-------------------+-------------------------+-------------------------------------------------+
235 |requestInfo |requestInfo Object |Content of requestInfo object. |
236 +-------------------+-------------------------+-------------------------------------------------+
240 +-------------------------+------------------+-------------------------------------------------+
241 |Attribute |Content |Description |
242 +=========================+==================+=================================================+
243 |ModelType |String |Type of model |
244 +-------------------------+------------------+-------------------------------------------------+
245 |ModelInvariantId |String |The Model Invariant Id. |
246 +-------------------------+------------------+-------------------------------------------------+
247 |ModelName |String |Name of the Model |
248 +-------------------------+------------------+-------------------------------------------------+
249 |ModelVersion |String |Version of the model |
250 +-------------------------+------------------+-------------------------------------------------+
254 +-------------------------+------------------+-------------------------------------------------+
255 |Attribute |Content |Description |
256 +=========================+==================+=================================================+
257 |Source |String |source of the request |
258 +-------------------------+------------------+-------------------------------------------------+
261 ++++++++++++++++++++++++
263 +--------------------+-------------------------------------------------------------------------------------------+
264 |Interface Definition|Description |
265 +====================+===========================================================================================+
266 |URI |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
267 +--------------------+-------------------------------------------------------------------------------------------+
268 |Operation Type |POST |
269 +--------------------+-------------------------------------------------------------------------------------------+
270 |Content-Type |application/json |
271 +--------------------+-------------------------------------------------------------------------------------------+
275 +----------------+---------+-----------+--------------------------+-------------------------------------------+
276 |Attribute |Qualifier|Cardinality|Content |Description |
277 +================+=========+===========+==========================+===========================================+
278 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
279 +----------------+---------+-----------+--------------------------+-------------------------------------------+
281 RequestDetails Object
283 +-------------------+--------------------------+-------------------------------------------------+
284 |Attribute |Content |Description |
285 +===================+==========================+=================================================+
286 |modelInfo |modelInfo Object |Content of modelInfo object. |
287 +-------------------+--------------------------+-------------------------------------------------+
288 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
289 +-------------------+--------------------------+-------------------------------------------------+
290 |requestInfo |requestInfo Object |Content of requestInfo object. |
291 +-------------------+--------------------------+-------------------------------------------------+
292 |requestParameters |requestParameters Object |Content of requestParameters object. |
293 +-------------------+--------------------------+-------------------------------------------------+
294 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
295 +-------------------+--------------------------+-------------------------------------------------+
296 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
297 +-------------------+--------------------------+-------------------------------------------------+
298 |project |project Object |Content of project object. |
299 +-------------------+--------------------------+-------------------------------------------------+
300 |owningEntity |owningEntity Object |Content of owningEntity object. |
301 +-------------------+--------------------------+-------------------------------------------------+
302 |platform |platform Object |Content of platform object. |
303 +-------------------+--------------------------+-------------------------------------------------+
304 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
305 +-------------------+--------------------------+-------------------------------------------------+
309 +-------------------------+------------------+-------------------------------------------------+
310 |Attribute |Content |Description |
311 +=========================+==================+=================================================+
312 |ModelType |String |Type of model |
313 +-------------------------+------------------+-------------------------------------------------+
314 |ModelInvariantId |String |The Model Invariant Id. |
315 +-------------------------+------------------+-------------------------------------------------+
316 |ModelNameVersionId |String |The modelname Version Id |
317 +-------------------------+------------------+-------------------------------------------------+
318 |ModelName |String |Name of the Model |
319 +-------------------------+------------------+-------------------------------------------------+
320 |ModelVersion |String |Version of the model |
321 +-------------------------+------------------+-------------------------------------------------+
322 |ModelCustomization Name |String |The Model Customization name |
323 +-------------------------+------------------+-------------------------------------------------+
324 |modelCustomizationUuid |String |The Model Customization UUid |
325 +-------------------------+------------------+-------------------------------------------------+
326 |modelVersionId |String |The Model version id |
327 +-------------------------+------------------+-------------------------------------------------+
328 |modelUuid |String |The Model UUid |
329 +-------------------------+------------------+-------------------------------------------------+
330 |modelInvariantUuid |String |The Model Invariant UUid |
331 +-------------------------+------------------+-------------------------------------------------+
332 |modelInstanceName |String |The Model Instance name |
333 +-------------------------+------------------+-------------------------------------------------+
335 CloudConfiguration Object
337 +-------------------------+------------------+-------------------------------------------------+
338 |Attribute |Content |Description |
339 +=========================+==================+=================================================+
340 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
341 +-------------------------+------------------+-------------------------------------------------+
342 |tenantId |String |Name of the Subscriber |
343 +-------------------------+------------------+-------------------------------------------------+
344 |aicNodeClli |String |aicNodeClli property |
345 +-------------------------+------------------+-------------------------------------------------+
349 +-------------------------+------------------+-------------------------------------------------+
350 |Attribute |Content |Description |
351 +=========================+==================+=================================================+
352 |Source |String |source of the request |
353 +-------------------------+------------------+-------------------------------------------------+
354 |billingAccountNumber |String |billingAccountNumber of the request |
355 +-------------------------+------------------+-------------------------------------------------+
356 |callbackUrl |String |callbackUrl of the request |
357 +-------------------------+------------------+-------------------------------------------------+
358 |correlator |String |correlator of the request |
359 +-------------------------+------------------+-------------------------------------------------+
360 |orderNumber |String |orderNumber of the request |
361 +-------------------------+------------------+-------------------------------------------------+
362 |productFamilyId |String |productFamilyId of the request |
363 +-------------------------+------------------+-------------------------------------------------+
364 |orderVersion |String |orderVersion of the request |
365 +-------------------------+------------------+-------------------------------------------------+
366 |instanceName |String |instanceName of the request |
367 +-------------------------+------------------+-------------------------------------------------+
368 |suppressRollback |String |suppressRollback of the request |
369 +-------------------------+------------------+-------------------------------------------------+
370 |requestorId |String |requestorId of the request |
371 +-------------------------+------------------+-------------------------------------------------+
375 +-------------------------+------------------+-------------------------------------------------+
376 |Attribute |Content |Description |
377 +=========================+==================+=================================================+
378 |relatedInstance |Object |relatedInstance Object |
379 +-------------------------+------------------+-------------------------------------------------+
383 +-------------------------+------------------+-------------------------------------------------+
384 |Attribute |Content |Description |
385 +=========================+==================+=================================================+
386 |instanceId |String |instanceId |
387 +-------------------------+------------------+-------------------------------------------------+
388 |modelInfo |Object |Content of modelInfo object. |
389 +-------------------------+------------------+-------------------------------------------------+
392 ++++++++++++++++++++++++
394 +--------------------+---------------------------------------------------------------------------------------------------------------------+
395 |Interface Definition|Description |
396 +====================+=====================================================================================================================+
397 |URI |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
398 +--------------------+---------------------------------------------------------------------------------------------------------------------+
399 |Operation Type |DELETE |
400 +--------------------+---------------------------------------------------------------------------------------------------------------------+
401 |Content-Type |application/json |
402 +--------------------+---------------------------------------------------------------------------------------------------------------------+
406 +----------------+---------+-----------+--------------------------+-------------------------------------------+
407 |Attribute |Qualifier|Cardinality|Content |Description |
408 +================+=========+===========+==========================+===========================================+
409 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
410 +----------------+---------+-----------+--------------------------+-------------------------------------------+
412 RequestDetails Object
414 +---------------------+-------------------------+-------------------------------------------------+
415 |Attribute |Content |Description |
416 +=====================+=========================+=================================================+
417 |modelInfo |modelInfo Object |Content of modelInfo object. |
418 +---------------------+-------------------------+-------------------------------------------------+
419 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
420 +---------------------+-------------------------+-------------------------------------------------+
421 |requestInfo |requestInfo Object |Content of requestInfo object. |
422 +---------------------+-------------------------+-------------------------------------------------+
426 +-------------------------+------------------+-------------------------------------------------+
427 |Attribute |Content |Description |
428 +=========================+==================+=================================================+
429 |ModelType |String |Type of model |
430 +-------------------------+------------------+-------------------------------------------------+
431 |ModelName |String |Name of the Model |
432 +-------------------------+------------------+-------------------------------------------------+
434 CloudConfiguration Object
436 +-------------------------+------------------+-------------------------------------------------+
437 |Attribute |Content |Description |
438 +=========================+==================+=================================================+
439 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
440 +-------------------------+------------------+-------------------------------------------------+
441 |tenantId |String |Name of the Subscriber |
442 +-------------------------+------------------+-------------------------------------------------+
446 +-------------------------+------------------+-------------------------------------------------+
447 |Attribute |Content |Description |
448 +=========================+==================+=================================================+
449 |Source |String |source of the request |
450 +-------------------------+------------------+-------------------------------------------------+
455 +--------------------+----------------------------------------------------------------------------------------+
456 |Interface Definition|Description |
457 +====================+========================================================================================+
458 |URI |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
459 +--------------------+----------------------------------------------------------------------------------------+
460 |Operation Type |POST |
461 +--------------------+----------------------------------------------------------------------------------------+
462 |Content-Type |application/json |
463 +--------------------+----------------------------------------------------------------------------------------+
467 +----------------+---------+-----------+--------------------------+-------------------------------------------+
468 |Attribute |Qualifier|Cardinality|Content |Description |
469 +================+=========+===========+==========================+===========================================+
470 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
471 +----------------+---------+-----------+--------------------------+-------------------------------------------+
473 RequestDetails Object
475 +---------------------+-------------------------+-------------------------------------------------+
476 |Attribute |Content |Description |
477 +=====================+=========================+=================================================+
478 |modelInfo |modelInfo Object |Content of modelInfo object. |
479 +---------------------+-------------------------+-------------------------------------------------+
480 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
481 +---------------------+-------------------------+-------------------------------------------------+
482 |requestInfo |requestInfo Object |Content of requestInfo object. |
483 +---------------------+-------------------------+-------------------------------------------------+
484 |relatedInstanceList |List |Content of relatedInstanceList. |
485 +---------------------+-------------------------+-------------------------------------------------+
489 +-------------------------+------------------+-------------------------------------------------+
490 |Attribute |Content |Description |
491 +=========================+==================+=================================================+
492 |ModelType |String |Type of model |
493 +-------------------------+------------------+-------------------------------------------------+
494 |ModelInvariantId |String |The Model Invariant Id. |
495 +-------------------------+------------------+-------------------------------------------------+
496 |ModelNameVersionId |String |The modelname Version Id |
497 +-------------------------+------------------+-------------------------------------------------+
498 |ModelName |String |Name of the Model |
499 +-------------------------+------------------+-------------------------------------------------+
500 |ModelVersion |String |Version of the model |
501 +-------------------------+------------------+-------------------------------------------------+
502 |ModelCustomization Name |String |The Model Customization name |
503 +-------------------------+------------------+-------------------------------------------------+
505 CloudConfiguration Object
507 +-------------------------+------------------+-------------------------------------------------+
508 |Attribute |Content |Description |
509 +=========================+==================+=================================================+
510 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
511 +-------------------------+------------------+-------------------------------------------------+
512 |tenantId |String |Name of the Subscriber |
513 +-------------------------+------------------+-------------------------------------------------+
517 +-------------------------+------------------+-------------------------------------------------+
518 |Attribute |Content |Description |
519 +=========================+==================+=================================================+
520 |InstanceName |String |The instance Name |
521 +-------------------------+------------------+-------------------------------------------------+
522 |Source |String |source of the request |
523 +-------------------------+------------------+-------------------------------------------------+
524 |SuppressRollback |Boolean |SuppressRollback |
525 +-------------------------+------------------+-------------------------------------------------+
529 +-------------------------+------------------+-------------------------------------------------+
530 |Attribute |Content |Description |
531 +=========================+==================+=================================================+
532 |relatedInstance |Object |relatedInstance Object |
533 +-------------------------+------------------+-------------------------------------------------+
537 +-------------------------+------------------+-------------------------------------------------+
538 |Attribute |Content |Description |
539 +=========================+==================+=================================================+
540 |instanceId |String |instanceId |
541 +-------------------------+------------------+-------------------------------------------------+
542 |modelInfo |Object |Content of modelInfo object. |
543 +-------------------------+------------------+-------------------------------------------------+
544 |instanceName |String |Name of the instance |
545 +-------------------------+------------------+-------------------------------------------------+
548 ++++++++++++++++++++++++
550 +--------------------+--------------------------------------------------------------------------------------------------------------+
551 |Interface Definition|Description |
552 +====================+==============================================================================================================+
553 |URI |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
554 +--------------------+--------------------------------------------------------------------------------------------------------------+
555 |Operation Type |DELETE |
556 +--------------------+--------------------------------------------------------------------------------------------------------------+
557 |Content-Type |application/json |
558 +--------------------+--------------------------------------------------------------------------------------------------------------+
562 +----------------+---------+-----------+--------------------------+-------------------------------------------+
563 |Attribute |Qualifier|Cardinality|Content |Description |
564 +================+=========+===========+==========================+===========================================+
565 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
566 +----------------+---------+-----------+--------------------------+-------------------------------------------+
568 RequestDetails Object
570 +---------------------+-------------------------+-------------------------------------------------+
571 |Attribute |Content |Description |
572 +=====================+=========================+=================================================+
573 |modelInfo |modelInfo Object |Content of modelInfo object. |
574 +---------------------+-------------------------+-------------------------------------------------+
575 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
576 +---------------------+-------------------------+-------------------------------------------------+
577 |requestInfo |requestInfo Object |Content of requestInfo object. |
578 +---------------------+-------------------------+-------------------------------------------------+
582 +-------------------------+------------------+-------------------------------------------------+
583 |Attribute |Content |Description |
584 +=========================+==================+=================================================+
585 |ModelType |String |Type of model |
586 +-------------------------+------------------+-------------------------------------------------+
587 |ModelInvariantId |String |The Model Invariant Id. |
588 +-------------------------+------------------+-------------------------------------------------+
589 |ModelNameVersionId |String |The modelname Version Id |
590 +-------------------------+------------------+-------------------------------------------------+
591 |ModelName |String |Name of the Model |
592 +-------------------------+------------------+-------------------------------------------------+
593 |ModelVersion |String |Version of the model |
594 +-------------------------+------------------+-------------------------------------------------+
595 |ModelCustomization Name |String |The Model Customization name |
596 +-------------------------+------------------+-------------------------------------------------+
598 CloudConfiguration Object
600 +-------------------------+------------------+-------------------------------------------------+
601 |Attribute |Content |Description |
602 +=========================+==================+=================================================+
603 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
604 +-------------------------+------------------+-------------------------------------------------+
605 |tenantId |String |Name of the Subscriber |
606 +-------------------------+------------------+-------------------------------------------------+
610 +-------------------------+------------------+-------------------------------------------------+
611 |Attribute |Content |Description |
612 +=========================+==================+=================================================+
613 |Source |String |source of the request |
614 +-------------------------+------------------+-------------------------------------------------+
619 +--------------------+--------------------------------------------------------------+
620 |Interface Definition|Description |
621 +====================+==============================================================+
622 |URI |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs |
623 +--------------------+--------------------------------------------------------------+
624 |Operation Type |POST |
625 +--------------------+--------------------------------------------------------------+
626 |Content-Type |application/json |
627 +--------------------+--------------------------------------------------------------+
631 +----------------+---------+-----------+--------------------------+-------------------------------------------+
632 |Attribute |Qualifier|Cardinality|Content |Description |
633 +================+=========+===========+==========================+===========================================+
634 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
635 +----------------+---------+-----------+--------------------------+-------------------------------------------+
637 RequestDetails Object
639 +-------------------+--------------------------+-------------------------------------------------+
640 |Attribute |Content |Description |
641 +===================+==========================+=================================================+
642 |modelInfo |modelInfo Object |Content of modelInfo object. |
643 +-------------------+--------------------------+-------------------------------------------------+
644 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
645 +-------------------+--------------------------+-------------------------------------------------+
646 |requestInfo |requestInfo Object |Content of requestInfo object. |
647 +-------------------+--------------------------+-------------------------------------------------+
648 |requestParameters |requestParameters Object |Content of requestParameters object. |
649 +-------------------+--------------------------+-------------------------------------------------+
650 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
651 +-------------------+--------------------------+-------------------------------------------------+
652 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
653 +-------------------+--------------------------+-------------------------------------------------+
654 |project |project Object |Content of project object. |
655 +-------------------+--------------------------+-------------------------------------------------+
656 |owningEntity |owningEntity Object |Content of owningEntity object. |
657 +-------------------+--------------------------+-------------------------------------------------+
658 |platform |platform Object |Content of platform object. |
659 +-------------------+--------------------------+-------------------------------------------------+
660 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
661 +-------------------+--------------------------+-------------------------------------------------+
665 +-------------------------+------------------+-------------------------------------------------+
666 |Attribute |Content |Description |
667 +=========================+==================+=================================================+
668 |ModelType |String |Type of model |
669 +-------------------------+------------------+-------------------------------------------------+
670 |ModelInvariantId |String |The Model Invariant Id. |
671 +-------------------------+------------------+-------------------------------------------------+
672 |ModelNameVersionId |String |The modelname Version Id |
673 +-------------------------+------------------+-------------------------------------------------+
674 |ModelName |String |Name of the Model |
675 +-------------------------+------------------+-------------------------------------------------+
676 |ModelVersion |String |Version of the model |
677 +-------------------------+------------------+-------------------------------------------------+
678 |ModelCustomization Name |String |The Model Customization name |
679 +-------------------------+------------------+-------------------------------------------------+
680 |modelCustomizationUuid |String |The Model Customization UUid |
681 +-------------------------+------------------+-------------------------------------------------+
682 |modelVersionId |String |The Model version id |
683 +-------------------------+------------------+-------------------------------------------------+
684 |modelUuid |String |The Model UUid |
685 +-------------------------+------------------+-------------------------------------------------+
686 |modelInvariantUuid |String |The Model Invariant UUid |
687 +-------------------------+------------------+-------------------------------------------------+
688 |modelInstanceName |String |The Model Instance name |
689 +-------------------------+------------------+-------------------------------------------------+
691 CloudConfiguration Object
693 +-------------------------+------------------+-------------------------------------------------+
694 |Attribute |Content |Description |
695 +=========================+==================+=================================================+
696 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
697 +-------------------------+------------------+-------------------------------------------------+
698 |tenantId |String |Name of the Subscriber |
699 +-------------------------+------------------+-------------------------------------------------+
703 +-------------------------+------------------+-------------------------------------------------+
704 |Attribute |Content |Description |
705 +=========================+==================+=================================================+
706 |Source |String |source of the request |
707 +-------------------------+------------------+-------------------------------------------------+
708 |billingAccountNumber |String |billingAccountNumber of the request |
709 +-------------------------+------------------+-------------------------------------------------+
710 |callbackUrl |String |callbackUrl of the request |
711 +-------------------------+------------------+-------------------------------------------------+
712 |correlator |String |correlator of the request |
713 +-------------------------+------------------+-------------------------------------------------+
714 |orderNumber |String |orderNumber of the request |
715 +-------------------------+------------------+-------------------------------------------------+
716 |productFamilyId |String |productFamilyId of the request |
717 +-------------------------+------------------+-------------------------------------------------+
718 |orderVersion |String |orderVersion of the request |
719 +-------------------------+------------------+-------------------------------------------------+
720 |instanceName |String |instanceName of the request |
721 +-------------------------+------------------+-------------------------------------------------+
722 |suppressRollback |String |suppressRollback of the request |
723 +-------------------------+------------------+-------------------------------------------------+
724 |requestorId |String |requestorId of the request |
725 +-------------------------+------------------+-------------------------------------------------+
729 +-------------------------+------------------+-------------------------------------------------+
730 |Attribute |Content |Description |
731 +=========================+==================+=================================================+
732 |relatedInstance |Object |relatedInstance Object |
733 +-------------------------+------------------+-------------------------------------------------+
737 +-------------------------+------------------+-------------------------------------------------+
738 |Attribute |Content |Description |
739 +=========================+==================+=================================================+
740 |instanceId |String |instanceId |
741 +-------------------------+------------------+-------------------------------------------------+
742 |modelInfo |Object |Content of modelInfo object. |
743 +-------------------------+------------------+-------------------------------------------------+
745 RequestParameters Object
747 +-------------------------+------------------+-------------------------------------------------+
748 |Attribute |Content |Description |
749 +=========================+==================+=================================================+
750 |UserParams |Array |The product family Id. |
751 +-------------------------+------------------+-------------------------------------------------+
755 +-------------------------+------------------+-------------------------------------------------+
756 |Attribute |Content |Description |
757 +=========================+==================+=================================================+
758 |name |String |Tag name of attribute |
759 +-------------------------+------------------+-------------------------------------------------+
760 |value |String |Value of the tag |
761 +-------------------------+------------------+-------------------------------------------------+
766 +--------------------+------------------------------------------------------------------------------+
767 |Interface Definition|Description |
768 +====================+==============================================================================+
769 |URI |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId} |
770 +--------------------+------------------------------------------------------------------------------+
771 |Operation Type |DELETE |
772 +--------------------+------------------------------------------------------------------------------+
773 |Content-Type |application/json |
774 +--------------------+------------------------------------------------------------------------------+
778 +----------------+---------+-----------+--------------------------+-------------------------------------------+
779 |Attribute |Qualifier|Cardinality|Content |Description |
780 +================+=========+===========+==========================+===========================================+
781 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
782 +----------------+---------+-----------+--------------------------+-------------------------------------------+
784 RequestDetails Object
786 +---------------------+-------------------------+-------------------------------------------------+
787 |Attribute |Content |Description |
788 +=====================+=========================+=================================================+
789 |modelInfo |modelInfo Object |Content of modelInfo object. |
790 +---------------------+-------------------------+-------------------------------------------------+
791 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
792 +---------------------+-------------------------+-------------------------------------------------+
793 |requestInfo |requestInfo Object |Content of requestInfo object. |
794 +---------------------+-------------------------+-------------------------------------------------+
795 |requestParameters |requestParameters Object |Content of requestParameters object. |
796 +---------------------+-------------------------+-------------------------------------------------+
800 +-------------------------+------------------+-------------------------------------------------+
801 |Attribute |Content |Description |
802 +=========================+==================+=================================================+
803 |ModelType |String |Type of model |
804 +-------------------------+------------------+-------------------------------------------------+
805 |ModelName |String |Name of the Model |
806 +-------------------------+------------------+-------------------------------------------------+
808 CloudConfiguration Object
810 +-------------------------+------------------+-------------------------------------------------+
811 |Attribute |Content |Description |
812 +=========================+==================+=================================================+
813 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
814 +-------------------------+------------------+-------------------------------------------------+
815 |tenantId |String |Name of the Subscriber |
816 +-------------------------+------------------+-------------------------------------------------+
820 +-------------------------+------------------+-------------------------------------------------+
821 |Attribute |Content |Description |
822 +=========================+==================+=================================================+
823 |Source |String |source of the request |
824 +-------------------------+------------------+-------------------------------------------------+
826 RequestParameters Object
828 +-------------------------+------------------+-------------------------------------------------+
829 |Attribute |Content |Description |
830 +=========================+==================+=================================================+
831 |UserParams |Array |The product family Id. |
832 +-------------------------+------------------+-------------------------------------------------+
836 +-------------------------+------------------+-------------------------------------------------+
837 |Attribute |Content |Description |
838 +=========================+==================+=================================================+
839 |name |String |Tag name of attribute |
840 +-------------------------+------------------+-------------------------------------------------+
841 |value |String |Value of the tag |
842 +-------------------------+------------------+-------------------------------------------------+
844 GET Orchestration Request
845 ++++++++++++++++++++++++++
847 +--------------------+--------------------------------------------------------------+
848 |Interface Definition|Description |
849 +====================+==============================================================+
850 |URI |{serverRoot}/orchestrationRequests/v4/{request-id} |
851 +--------------------+--------------------------------------------------------------+
852 |Operation Type |GET |
853 +--------------------+--------------------------------------------------------------+
854 |Content-Type |application/json |
855 +--------------------+--------------------------------------------------------------+
859 +----------------+---------+-----------+--------------------------+-------------------------------------------+
860 |Attribute |Qualifier|Cardinality|Content |Description |
861 +================+=========+===========+==========================+===========================================+
862 |request |M |1 |request Object |Content of request object. |
863 +----------------+---------+-----------+--------------------------+-------------------------------------------+
867 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
868 |Attribute |Qualifier|Cardinality|Content |Description |
869 +===================+=========+===========+==========================+===========================================+
870 |requestId |M |1 |String |Request Id |
871 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
872 |startTime |M |1 |request Object |Start time. |
873 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
874 |requestScope |M |1 |request Object |Scope of the request. |
875 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
876 |requestType |M |1 |request Object |Type of the request. |
877 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
878 |requestDetails |M |1 |requestDetails Object |Type of the request. |
879 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
880 |requestStatus |M |1 |requestStatus Object |Type of the request. |
881 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
883 RequestDetails Object
885 +-------------------+--------------------------+-------------------------------------------------+
886 |Attribute |Content |Description |
887 +===================+==========================+=================================================+
888 |modelInfo |modelInfo Object |Content of modelInfo object. |
889 +-------------------+--------------------------+-------------------------------------------------+
890 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
891 +-------------------+--------------------------+-------------------------------------------------+
892 |requestInfo |requestInfo Object |Content of requestInfo object. |
893 +-------------------+--------------------------+-------------------------------------------------+
894 |requestParameters |requestParameters Object |Content of requestParameters object. |
895 +-------------------+--------------------------+-------------------------------------------------+
896 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
897 +-------------------+--------------------------+-------------------------------------------------+
898 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
899 +-------------------+--------------------------+-------------------------------------------------+
900 |project |project Object |Content of project object. |
901 +-------------------+--------------------------+-------------------------------------------------+
902 |owningEntity |owningEntity Object |Content of owningEntity object. |
903 +-------------------+--------------------------+-------------------------------------------------+
904 |platform |platform Object |Content of platform object. |
905 +-------------------+--------------------------+-------------------------------------------------+
906 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
907 +-------------------+--------------------------+-------------------------------------------------+
911 +-------------------------+------------------+-------------------------------------------------+
912 |Attribute |Content |Description |
913 +=========================+==================+=================================================+
914 |ModelType |String |Type of model |
915 +-------------------------+------------------+-------------------------------------------------+
916 |ModelInvariantId |String |The Model Invariant Id. |
917 +-------------------------+------------------+-------------------------------------------------+
918 |ModelNameVersionId |String |The modelname Version Id |
919 +-------------------------+------------------+-------------------------------------------------+
920 |ModelName |String |Name of the Model |
921 +-------------------------+------------------+-------------------------------------------------+
922 |ModelVersion |String |Version of the model |
923 +-------------------------+------------------+-------------------------------------------------+
924 |ModelCustomization Name |String |The Model Customization name |
925 +-------------------------+------------------+-------------------------------------------------+
926 |modelCustomizationUuid |String |The Model Customization UUid |
927 +-------------------------+------------------+-------------------------------------------------+
928 |modelVersionId |String |The Model version id |
929 +-------------------------+------------------+-------------------------------------------------+
930 |modelUuid |String |The Model UUid |
931 +-------------------------+------------------+-------------------------------------------------+
932 |modelInvariantUuid |String |The Model Invariant UUid |
933 +-------------------------+------------------+-------------------------------------------------+
934 |modelInstanceName |String |The Model Instance name |
935 +-------------------------+------------------+-------------------------------------------------+
937 SubscriberInfo Object
939 +-------------------------+------------------+-------------------------------------------------+
940 |Attribute |Content |Description |
941 +=========================+==================+=================================================+
942 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
943 +-------------------------+------------------+-------------------------------------------------+
944 |SubscriberName |String |Name of the Subscriber |
945 +-------------------------+------------------+-------------------------------------------------+
949 +-------------------------+------------------+-------------------------------------------------+
950 |Attribute |Content |Description |
951 +=========================+==================+=================================================+
952 |Source |String |source of the request |
953 +-------------------------+------------------+-------------------------------------------------+
954 |billingAccountNumber |String |billingAccountNumber of the request |
955 +-------------------------+------------------+-------------------------------------------------+
956 |callbackUrl |String |callbackUrl of the request |
957 +-------------------------+------------------+-------------------------------------------------+
958 |correlator |String |correlator of the request |
959 +-------------------------+------------------+-------------------------------------------------+
960 |orderNumber |String |orderNumber of the request |
961 +-------------------------+------------------+-------------------------------------------------+
962 |productFamilyId |String |productFamilyId of the request |
963 +-------------------------+------------------+-------------------------------------------------+
964 |orderVersion |String |orderVersion of the request |
965 +-------------------------+------------------+-------------------------------------------------+
966 |instanceName |String |instanceName of the request |
967 +-------------------------+------------------+-------------------------------------------------+
968 |suppressRollback |String |suppressRollback of the request |
969 +-------------------------+------------------+-------------------------------------------------+
970 |requestorId |String |requestorId of the request |
971 +-------------------------+------------------+-------------------------------------------------+
973 RequestParameters Object
975 +-------------------------+------------------+-------------------------------------------------+
976 |Attribute |Content |Description |
977 +=========================+==================+=================================================+
978 |SubscriptionServiceType |String |The service type of the Subscription |
979 +-------------------------+------------------+-------------------------------------------------+
983 +-------------------------+------------------+-------------------------------------------------+
984 |Attribute |Content |Description |
985 +=========================+==================+=================================================+
986 |finishTime |String |Time |
987 +-------------------------+------------------+-------------------------------------------------+
988 |requestState |String |state of the request |
989 +-------------------------+------------------+-------------------------------------------------+
990 |statusMessage |String |statusMessage |
991 +-------------------------+------------------+-------------------------------------------------+
992 |percentProgress |String |percentage of progress |
993 +-------------------------+------------------+-------------------------------------------------+
995 GET Orchestration Requests
996 ++++++++++++++++++++++++++
998 +--------------------+--------------------------------------------------------------+
999 |Interface Definition|Description |
1000 +====================+==============================================================+
1001 |URI |{serverRoot}/orchestrationRequests/v4 |
1002 +--------------------+--------------------------------------------------------------+
1003 |Operation Type |GET |
1004 +--------------------+--------------------------------------------------------------+
1005 |Content-Type |application/json |
1006 +--------------------+--------------------------------------------------------------+
1010 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1011 |Attribute |Qualifier|Cardinality|Content |Description |
1012 +================+=========+===========+==========================+===========================================+
1013 |requestList |M |1 |Array |Content of request List. |
1014 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1018 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1019 |Attribute |Qualifier|Cardinality|Content |Description |
1020 +================+=========+===========+==========================+===========================================+
1021 |request |M |1 |request Object |Content of request object. |
1022 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1026 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1027 |Attribute |Qualifier|Cardinality|Content |Description |
1028 +===================+=========+===========+==========================+===========================================+
1029 |requestId |M |1 |String |Request Id. |
1030 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1031 |startTime |M |1 |request Object |Start time. |
1032 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1033 |requestScope |M |1 |request Object |Scope of the request. |
1034 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1035 |requestType |M |1 |request Object |Type of the request. |
1036 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1037 |requestDetails |M |1 |requestDetails Object |Type of the request. |
1038 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1039 |requestStatus |M |1 |requestStatus Object |Type of the request. |
1040 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1042 RequestDetails Object
1044 +-------------------+--------------------------+-------------------------------------------------+
1045 |Attribute |Content |Description |
1046 +===================+==========================+=================================================+
1047 |modelInfo |modelInfo Object |Content of modelInfo object. |
1048 +-------------------+--------------------------+-------------------------------------------------+
1049 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
1050 +-------------------+--------------------------+-------------------------------------------------+
1051 |requestInfo |requestInfo Object |Content of requestInfo object. |
1052 +-------------------+--------------------------+-------------------------------------------------+
1053 |requestParameters |requestParameters Object |Content of requestParameters object. |
1054 +-------------------+--------------------------+-------------------------------------------------+
1055 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
1056 +-------------------+--------------------------+-------------------------------------------------+
1057 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
1058 +-------------------+--------------------------+-------------------------------------------------+
1059 |project |project Object |Content of project object. |
1060 +-------------------+--------------------------+-------------------------------------------------+
1061 |owningEntity |owningEntity Object |Content of owningEntity object. |
1062 +-------------------+--------------------------+-------------------------------------------------+
1063 |platform |platform Object |Content of platform object. |
1064 +-------------------+--------------------------+-------------------------------------------------+
1065 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
1066 +-------------------+--------------------------+-------------------------------------------------+
1070 +-------------------------+------------------+-------------------------------------------------+
1071 |Attribute |Content |Description |
1072 +=========================+==================+=================================================+
1073 |ModelType |String |Type of model |
1074 +-------------------------+------------------+-------------------------------------------------+
1075 |ModelInvariantId |String |The Model Invariant Id. |
1076 +-------------------------+------------------+-------------------------------------------------+
1077 |ModelNameVersionId |String |The modelname Version Id |
1078 +-------------------------+------------------+-------------------------------------------------+
1079 |ModelName |String |Name of the Model |
1080 +-------------------------+------------------+-------------------------------------------------+
1081 |ModelVersion |String |Version of the model |
1082 +-------------------------+------------------+-------------------------------------------------+
1083 |ModelCustomization Name |String |The Model Customization name |
1084 +-------------------------+------------------+-------------------------------------------------+
1085 |modelCustomizationUuid |String |The Model Customization UUid |
1086 +-------------------------+------------------+-------------------------------------------------+
1087 |modelVersionId |String |The Model version id |
1088 +-------------------------+------------------+-------------------------------------------------+
1089 |modelUuid |String |The Model UUid |
1090 +-------------------------+------------------+-------------------------------------------------+
1091 |modelInvariantUuid |String |The Model Invariant UUid |
1092 +-------------------------+------------------+-------------------------------------------------+
1093 |modelInstanceName |String |The Model Instance name |
1094 +-------------------------+------------------+-------------------------------------------------+
1096 SubscriberInfo Object
1098 +-------------------------+------------------+-------------------------------------------------+
1099 |Attribute |Content |Description |
1100 +=========================+==================+=================================================+
1101 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
1102 +-------------------------+------------------+-------------------------------------------------+
1103 |SubscriberName |String |Name of the Subscriber |
1104 +-------------------------+------------------+-------------------------------------------------+
1108 +-------------------------+------------------+-------------------------------------------------+
1109 |Attribute |Content |Description |
1110 +=========================+==================+=================================================+
1111 |Source |String |source of the request |
1112 +-------------------------+------------------+-------------------------------------------------+
1113 |billingAccountNumber |String |billingAccountNumber of the request |
1114 +-------------------------+------------------+-------------------------------------------------+
1115 |callbackUrl |String |callbackUrl of the request |
1116 +-------------------------+------------------+-------------------------------------------------+
1117 |correlator |String |correlator of the request |
1118 +-------------------------+------------------+-------------------------------------------------+
1119 |orderNumber |String |orderNumber of the request |
1120 +-------------------------+------------------+-------------------------------------------------+
1121 |productFamilyId |String |productFamilyId of the request |
1122 +-------------------------+------------------+-------------------------------------------------+
1123 |orderVersion |String |orderVersion of the request |
1124 +-------------------------+------------------+-------------------------------------------------+
1125 |instanceName |String |instanceName of the request |
1126 +-------------------------+------------------+-------------------------------------------------+
1127 |suppressRollback |String |suppressRollback of the request |
1128 +-------------------------+------------------+-------------------------------------------------+
1129 |requestorId |String |requestorId of the request |
1130 +-------------------------+------------------+-------------------------------------------------+
1132 RequestParameters Object
1134 +-------------------------+------------------+-------------------------------------------------+
1135 |Attribute |Content |Description |
1136 +=========================+==================+=================================================+
1137 |SubscriptionServiceType |String |The service type of the Subscription |
1138 +-------------------------+------------------+-------------------------------------------------+
1140 RequestStatus Object
1142 +-------------------------+------------------+-------------------------------------------------+
1143 |Attribute |Content |Description |
1144 +=========================+==================+=================================================+
1145 |finishTime |String |Time |
1146 +-------------------------+------------------+-------------------------------------------------+
1147 |requestState |String |state of the request |
1148 +-------------------------+------------------+-------------------------------------------------+
1149 |statusMessage |String |statusMessage |
1150 +-------------------------+------------------+-------------------------------------------------+
1151 |percentProgress |String |percentage of progress |
1152 +-------------------------+------------------+-------------------------------------------------+
1157 Get List of Existing Catalog Assets
1158 +++++++++++++++++++++++++++++++++++
1160 +--------------------+--------------------------+
1161 |Interface Definition|Description |
1162 +====================+==========================+
1163 |URI |sdc/v1/catalog/{assetType}|
1164 +--------------------+--------------------------+
1165 |Operation Type |GET |
1166 +--------------------+--------------------------+
1170 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1171 |Attribute |Qualifier|Cardinality|Content|Description |
1172 +===================+=========+===========+=======+=============================================================+
1173 |assetType |M |1 |String |The requested asset type.valid values are resources/services.|
1174 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1175 |service-type |M |1 |String |Service Type |
1176 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1177 |service-instance-id|M |1 |String |Service Instance ID |
1178 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1182 +-------------------+---------+-----------------------------------------------------------------------------------------+
1183 |Header Name |Qualifier|Description |
1184 +===================+=========+=========================================================================================+
1185 |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1186 +-------------------+---------+-----------------------------------------------------------------------------------------+
1187 |X-ECOMP-InstanceID |Y |Instance ID |
1188 +-------------------+---------+-----------------------------------------------------------------------------------------+
1189 |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1190 +-------------------+---------+-----------------------------------------------------------------------------------------+
1191 |Authorization |Y |Base64 encoded username:password |
1192 +-------------------+---------+-----------------------------------------------------------------------------------------+
1196 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1197 |Attribute |Qualifier|Cardinality|Content|Description |
1198 +==================+=========+===========+=======+======================================================================================+
1199 |uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1200 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1201 |invariantUUID |M |1 |String |UUID generated by SDC per each asset. |
1202 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1203 |name |M |1 |String |The name of the asset |
1204 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1205 |version |M |1 |String |The asset version in SDC catalog. |
1206 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1207 |toscaModelURL |M |1 |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
1208 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1209 |category |M |1 |String |Category of the asset. |
1210 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1211 |subcategory |M |1 |String |Sub-category of the asset |
1212 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1213 |resourceType |M |1 |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF. |
1214 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1215 |lifecycleState |M |1 |String |The lifecycle state of the asset |
1216 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1217 |lastUpdaterUserId |M |1 |String |UserID of the SDC designer who was the last to update the asset for this major version|
1218 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1220 Get Specific Asset Detailed Metadata
1221 ++++++++++++++++++++++++++++++++++++
1223 +--------------------+-------------------------------------------+
1224 |Interface Definition|Description |
1225 +====================+===========================================+
1226 |URI |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
1227 +--------------------+-------------------------------------------+
1228 |Operation Type |GET |
1229 +--------------------+-------------------------------------------+
1233 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1234 |Attribute |Qualifier|Cardinality|Content|Description |
1235 +===================+=========+===========+=======+=====================================================================================+
1236 |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1237 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1238 |uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
1239 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1243 +-------------------+---------+-----------------------------------------------------------------------------------------+
1244 |Header Name |Qualifier|Description |
1245 +===================+=========+=========================================================================================+
1246 |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1247 +-------------------+---------+-----------------------------------------------------------------------------------------+
1248 |X-ECOMP-InstanceID |Y |Instance ID |
1249 +-------------------+---------+-----------------------------------------------------------------------------------------+
1250 |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1251 +-------------------+---------+-----------------------------------------------------------------------------------------+
1252 |Authorization |Y |Base64 encoded username:password |
1253 +-------------------+---------+-----------------------------------------------------------------------------------------+
1257 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1258 |Attribute |Qualifier|Content|Description |
1259 +====================+=========+=======+======================================================================================+
1260 |uuid |M |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1261 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1262 |invariantUUID |M |String |UUID generated by SDC per each asset. |
1263 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1264 |name |M |String |The name of the asset |
1265 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1266 |version |M |String |The asset version in SDC catalog. |
1267 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1268 |toscaModelURL |M |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
1269 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1270 |description |M |String |Short description of the resource |
1271 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1272 |lastUpdaterUserId |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1273 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1274 |lastUpdaterFullName |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
1275 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1276 |category |M |String |Category of the asset |
1277 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1278 |subCategory |M |String |Sub-category of the asset. |
1279 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1280 |toscaResourceName |M |String |The full name of the asset |
1281 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1282 |resourceType |M |String |The type of resource. |
1283 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1284 |lifecycleState |M |String |The lifecycle state of the asset |
1285 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1286 |resources |N |Object |Category of the asset |
1287 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1288 |artifacts |M |Object |Category of the asset |
1289 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1293 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1294 |Attribute |Qualifier|Content|Description | |
1295 +=====================+=========+=======+===================================================================================================================+
1296 |resourceInstanceName |M |String |Logical Resource Instance Name.Unique Identifier of the instance of the specific resource in the service context.|
1297 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1298 |resourceName |M |String |Resource Name |
1299 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1300 |resourceInvariantUUID|M |String |The invariant UUID of the resource |
1301 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1302 |resourceVersion |M |String |Resource Version |
1303 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1304 |resoucreType |M |String |Resource Type |
1305 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1306 |resourceUUID |M |String |Global UUID of the resource that specific artifact belongs to |
1307 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1308 |artifacts |M |Object |Array of resource instance deployment artifacts. |
1309 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1311 Artifact Metadata Object:
1313 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1314 |Attribute |Qualifier|Content |Description |
1315 +=====================+=========+========+===================================================================================================================+
1316 |artifactName |M |String |Artifact File name |
1317 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1318 |artifactLabel |M |String |Identifier of the artifact within the VF / Service. |
1319 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1320 |artifactType |M |String |Artifact Type |
1321 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1322 |artifactGroupType |M |String |Whether the artifact is informational or deployment. |
1323 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1324 |artifactURL |M |String |Relative artifact’s URL. |
1325 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1326 |artifactDescription |M |String |Artifact Description |
1327 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1328 |artifactTimeout |N |Integer |Artifact Description |
1329 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1330 |artifactChecksum |M |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1331 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1332 |artifactUUID |M |String |Global UUID generated by SDC each time when artifact payload is updated. |
1333 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1334 |artifactVersion |M |String |Service Version |
1335 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1336 |generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1337 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1339 Download (CSAR of) Specific Asset
1340 +++++++++++++++++++++++++++++++++
1342 +--------------------+-----------------------------------------------------------+
1343 |Interface Definition|Description |
1344 +====================+===========================================================+
1345 |URI |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
1346 +--------------------+-----------------------------------------------------------+
1347 |Operation Type |GET |
1348 +--------------------+-----------------------------------------------------------+
1352 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1353 |Attribute |Qualifier|Cardinality|Content|Description |
1354 +===================+=========+===========+=======+=====================================================================================+
1355 |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1356 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1357 |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1358 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1359 |artifactUUID |M |1 |String |The artifactUUID of the asset as published in the metadata |
1360 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1364 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1365 |Header name |Qualifier|Description |
1366 +====================+=========+==========================================================================================================================+
1367 |Content-Type |M |Specifies the downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
1368 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1369 |Content-Length |M |Streamed artifact payload size |
1370 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1371 |Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . |
1372 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1377 +--------------------+-----------------------------------------------------------------------------------------------+
1378 |Interface Definition|Description |
1379 +====================+===============================================================================================+
1380 |URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
1381 +--------------------+-----------------------------------------------------------------------------------------------+
1382 |Operation Type |POST |
1383 +--------------------+-----------------------------------------------------------------------------------------------+
1387 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1388 |Attribute |Qualifier|Cardinality|Content|Description |
1389 +==============================+=========+===========+=======+=====================================================================================+
1390 |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1391 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1392 |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1393 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1394 |resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1395 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1400 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1401 |Attribute |Qualifier|Cardinality|Content|Description |
1402 +==============================+=========+===========+=======+=====================================================================================+
1403 |payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1404 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1405 |artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1406 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1407 |artifactName |M |1 |String |The name of the artifact |
1408 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1409 |artifactType |M |1 |String |The type of the artifact |
1410 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1411 |artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1412 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1413 |description |M |1 |String |Description of the artifact |
1414 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1418 +-------------------+---------+-----------------------------------------------------------------------------------------+
1419 |Header Name |Qualifier|Description |
1420 +===================+=========+=========================================================================================+
1421 |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1422 +-------------------+---------+-----------------------------------------------------------------------------------------+
1423 |X-ECOMP-InstanceID |Y |Instance ID |
1424 +-------------------+---------+-----------------------------------------------------------------------------------------+
1425 |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1426 +-------------------+---------+-----------------------------------------------------------------------------------------+
1427 |Authorization |Y |Base64 encoded username:password |
1428 +-------------------+---------+-----------------------------------------------------------------------------------------+
1429 |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1430 +-------------------+---------+-----------------------------------------------------------------------------------------+
1431 |Content-Type |Y |Valid value is : application/json |
1432 +-------------------+---------+-----------------------------------------------------------------------------------------+
1433 |Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1434 +-------------------+---------+-----------------------------------------------------------------------------------------+
1438 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1439 |Attribute |Qualifier|Content|Description |
1440 +====================+=========+=======+===================================================================================================+
1441 |artifactName |M |String |Artifact File name |
1442 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1443 |artifactType |M |String |Artifact Type |
1444 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1445 |artifactURL |M |String |Relative artifact’s URL. |
1446 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1447 |artifactDescription |M |String |Artifact Description. |
1448 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1449 |artifactTimeout |N |String |Will be populated only if its value is not 0. |
1450 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1451 |artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1452 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1453 |artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1454 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1455 |artifactVersion |Y |String |Service Version . |
1456 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1457 |generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1458 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1463 +--------------------+--------------------------------------------------------------------------------------------------------------+
1464 |Interface Definition|Description |
1465 +====================+==============================================================================================================+
1466 |URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1467 +--------------------+--------------------------------------------------------------------------------------------------------------+
1468 |Operation Type |POST |
1469 +--------------------+--------------------------------------------------------------------------------------------------------------+
1473 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1474 |Attribute |Qualifier|Cardinality|Content|Description |
1475 +==============================+=========+===========+=======+=====================================================================================+
1476 |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1477 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1478 |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1479 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1480 |artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1481 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1482 |resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1483 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1487 +-------------------+---------+-----------------------------------------------------------------------------------------+
1488 |Header Name |Qualifier|Description |
1489 +===================+=========+=========================================================================================+
1490 |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1491 +-------------------+---------+-----------------------------------------------------------------------------------------+
1492 |X-ECOMP-InstanceID |Y |Instance ID |
1493 +-------------------+---------+-----------------------------------------------------------------------------------------+
1494 |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1495 +-------------------+---------+-----------------------------------------------------------------------------------------+
1496 |Authorization |Y |Base64 encoded username:password |
1497 +-------------------+---------+-----------------------------------------------------------------------------------------+
1498 |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1499 +-------------------+---------+-----------------------------------------------------------------------------------------+
1500 |Content-Type |Y |Valid value is : application/json |
1501 +-------------------+---------+-----------------------------------------------------------------------------------------+
1502 |Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
1503 +-------------------+---------+-----------------------------------------------------------------------------------------+
1507 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1508 |Attribute |Qualifier|Cardinality|Content|Description |
1509 +==============================+=========+===========+=======+=====================================================================================+
1510 |payloadData |M |1 |String |The data of the artifact after Base64 encoding |
1511 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1512 |artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
1513 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1514 |artifactName |M |1 |String |The name of the artifact |
1515 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1516 |artifactType |M |1 |String |The type of the artifact |
1517 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1518 |artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
1519 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1520 |description |M |1 |String |Description of the artifact |
1521 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1525 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1526 |Attribute |Qualifier|Content|Description |
1527 +====================+=========+=======+===================================================================================================+
1528 |artifactName |M |String |Artifact File name |
1529 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1530 |artifactType |M |String |Artifact Type |
1531 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1532 |artifactURL |M |String |Relative artifact’s URL. |
1533 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1534 |artifactDescription |M |String |Artifact Description. |
1535 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1536 |artifactTimeout |N |String |Will be populated only if its value is not 0. |
1537 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1538 |artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
1539 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1540 |artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1541 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1542 |artifactVersion |Y |String |Service Version . |
1543 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1544 |generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
1545 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1550 +--------------------+--------------------------------------------------------------------------------------------------------------+
1551 |Interface Definition|Description |
1552 +====================+==============================================================================================================+
1553 |URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1554 +--------------------+--------------------------------------------------------------------------------------------------------------+
1555 |Operation Type |DELETE |
1556 +--------------------+--------------------------------------------------------------------------------------------------------------+
1560 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1561 |Attribute |Qualifier|Cardinality|Content|Description |
1562 +==============================+=========+===========+=======+=====================================================================================+
1563 |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1564 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1565 |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1566 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1567 |artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
1568 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1569 |resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
1570 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1574 +-------------------+---------+-----------------------------------------------------------------------------------------+
1575 |Header Name |Qualifier|Description |
1576 +===================+=========+=========================================================================================+
1577 |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1578 +-------------------+---------+-----------------------------------------------------------------------------------------+
1579 |X-ECOMP-InstanceID |Y |Instance ID |
1580 +-------------------+---------+-----------------------------------------------------------------------------------------+
1581 |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1582 +-------------------+---------+-----------------------------------------------------------------------------------------+
1583 |Authorization |Y |Base64 encoded username:password |
1584 +-------------------+---------+-----------------------------------------------------------------------------------------+
1585 |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1586 +-------------------+---------+-----------------------------------------------------------------------------------------+
1590 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1591 |Attribute |Qualifier|Content|Description |
1592 +====================+=========+=======+===================================================================================================+
1593 |artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
1594 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1599 +--------------------+--------------------------------------------------------------------------------------------------------------+
1600 |Interface Definition|Description |
1601 +====================+==============================================================================================================+
1602 |URI |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation} |
1603 +--------------------+--------------------------------------------------------------------------------------------------------------+
1604 |Operation Type |POST |
1605 +--------------------+--------------------------------------------------------------------------------------------------------------+
1609 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1610 |Attribute |Qualifier|Cardinality|Content|Description |
1611 +==============================+=========+===========+=======+=====================================================================================================+
1612 |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
1613 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1614 |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
1615 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1616 |lifecycleOperation |M |1 |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout / Certify |
1617 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1621 +-------------------+---------+-----------------------------------------------------------------------------------------+
1622 |Header Name |Qualifier|Description |
1623 +===================+=========+=========================================================================================+
1624 |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1625 +-------------------+---------+-----------------------------------------------------------------------------------------+
1626 |X-ECOMP-InstanceID |Y |Instance ID |
1627 +-------------------+---------+-----------------------------------------------------------------------------------------+
1628 |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1629 +-------------------+---------+-----------------------------------------------------------------------------------------+
1630 |Authorization |Y |Base64 encoded username:password |
1631 +-------------------+---------+-----------------------------------------------------------------------------------------+
1632 |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1633 +-------------------+---------+-----------------------------------------------------------------------------------------+
1637 +-------------------+---------+-----------------------------------------------------------------------------------------+
1638 |Attribute |Qualifier|Description |
1639 +===================+=========+=========================================================================================+
1640 |userRemarks |N |Short description (free text) about the asset version being changed |
1641 +-------------------+---------+-----------------------------------------------------------------------------------------+
1645 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1646 |Attribute |Qualifier|Content|Description |
1647 +====================+=========+=======+===================================================================================================+
1648 |uuid |Y |String |UUID generated by SDC per each major version of the asset |
1649 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1650 |invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1651 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1652 |name |Y |String |The name of the asset. |
1653 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1654 |version |Y |String |The asset version in SDC catalog |
1655 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1656 |category |Y |String |Category of the asset. |
1657 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1658 |subcategory |Y |String |Sub-category of the asset. |
1659 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1660 |resourceType |Y |String |The type of resource. |
1661 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1662 |lifecycleState |Y |String |The lifecycle state of the asset. |
1663 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1664 |lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1665 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1670 +--------------------+--------------------------------------------------------------------------------------------------------------+
1671 |Interface Definition|Description |
1672 +====================+==============================================================================================================+
1673 |URI |/sdc/v1/catalog/resources |
1674 +--------------------+--------------------------------------------------------------------------------------------------------------+
1675 |Operation Type |POST |
1676 +--------------------+--------------------------------------------------------------------------------------------------------------+
1680 +-------------------+---------+-----------------------------------------------------------------------------------------+
1681 |Header Name |Qualifier|Description |
1682 +===================+=========+=========================================================================================+
1683 |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1684 +-------------------+---------+-----------------------------------------------------------------------------------------+
1685 |X-ECOMP-InstanceID |Y |Instance ID |
1686 +-------------------+---------+-----------------------------------------------------------------------------------------+
1687 |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
1688 +-------------------+---------+-----------------------------------------------------------------------------------------+
1689 |Authorization |Y |Base64 encoded username:password |
1690 +-------------------+---------+-----------------------------------------------------------------------------------------+
1691 |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
1692 +-------------------+---------+-----------------------------------------------------------------------------------------+
1693 |Content-Type |Y |Valid value is : application/json |
1694 +-------------------+---------+-----------------------------------------------------------------------------------------+
1698 +-------------------+---------+-----------------------------------------------------------------------------------------+
1699 |Attribute |Qualifier|Description |
1700 +===================+=========+=========================================================================================+
1701 |name |Y |The name of the resource |
1702 +-------------------+---------+-----------------------------------------------------------------------------------------+
1703 |description |Y |Short description of the resource |
1704 +-------------------+---------+-----------------------------------------------------------------------------------------+
1705 |resourceType |Y |“VFCMT” / “VF” / “PNF” |
1706 +-------------------+---------+-----------------------------------------------------------------------------------------+
1707 |category |Y |VFCMT category is “Template”. |
1708 +-------------------+---------+-----------------------------------------------------------------------------------------+
1709 |subcategory |Y |VFCMT subcategory is “Monitoring Template”. |
1710 +-------------------+---------+-----------------------------------------------------------------------------------------+
1711 |vendorName |Y |Vendor Name |
1712 +-------------------+---------+-----------------------------------------------------------------------------------------+
1713 |vendorRelease |Y |Vendor Release |
1714 +-------------------+---------+-----------------------------------------------------------------------------------------+
1715 |tags |Y |The tags are used for search options. |
1716 +-------------------+---------+-----------------------------------------------------------------------------------------+
1717 |icon |Y |The icon should be pre-defined in SDC. |
1718 +-------------------+---------+-----------------------------------------------------------------------------------------+
1719 |contactId |Y |The user ID of user responsible for this VFCMT. |
1720 +-------------------+---------+-----------------------------------------------------------------------------------------+
1724 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1725 |Attribute |Qualifier|Content|Description |
1726 +====================+=========+=======+===================================================================================================+
1727 |uuid |Y |String |UUID generated by SDC per each major version of the asset |
1728 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1729 |invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
1730 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1731 |name |Y |String |The name of the asset. |
1732 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1733 |version |Y |String |The asset version in SDC catalog |
1734 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1735 |category |Y |String |Category of the asset. |
1736 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1737 |subcategory |Y |String |Sub-category of the asset. |
1738 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1739 |resourceType |Y |String |The type of resource. |
1740 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1741 |lifecycleState |Y |String |The lifecycle state of the asset. |
1742 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1743 |lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
1744 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1748 Create E2E service instance
1749 ++++++++++++++++++++++++++++
1751 +--------------------+-------------------------------------+
1752 |Interface Definition|Description |
1753 +====================+=====================================+
1754 |URI |{serverRoot}/e2eServiceInstances/v3 |
1755 +--------------------+-------------------------------------+
1756 |Operation Type |POST |
1757 +--------------------+-------------------------------------+
1758 |Content-Type |application/json |
1759 +--------------------+-------------------------------------+
1763 +---------+---------+-----------+--------------------------+-----------------------------+
1764 |Attribute|Qualifier|Cardinality|Content |Description |
1765 +=========+=========+===========+==========================+=============================+
1766 |service |M |1 |Service Object |Content of service object. |
1767 +---------+---------+-----------+--------------------------+-----------------------------+
1771 +------------------------------+-----------------+------------------------------------+
1772 |Attribute |Content |Description |
1773 +==============================+=================+====================================+
1774 |modelName |String |Service instance name. |
1775 +------------------------------+-----------------+------------------------------------+
1776 |description |String |Service instance description |
1777 +------------------------------+-----------------+------------------------------------+
1778 |modelUUID |String |Model UUID |
1779 +------------------------------+-----------------+------------------------------------+
1780 |modelInvariantUUID |String |Model Invariant UUID |
1781 +------------------------------+-----------------+------------------------------------+
1782 |created |Timestamp |Cretaed Timestamp |
1783 +------------------------------+-----------------+------------------------------------+
1784 |toscaCsarArtifactUUID |String |tosca Csar Artifact UUID |
1785 +------------------------------+-----------------+------------------------------------+
1786 |modelVersion |String |Model Version |
1787 +------------------------------+-----------------+------------------------------------+
1788 |category |String |category |
1789 +------------------------------+-----------------+------------------------------------+
1790 |serviceType |String |service Type |
1791 +------------------------------+-----------------+------------------------------------+
1792 |serviceRole |String |service Role |
1793 +------------------------------+-----------------+------------------------------------+
1794 |environmentContext |String |environment Context |
1795 +------------------------------+-----------------+------------------------------------+
1796 |workloadContext |String |workload Context |
1797 +------------------------------+-----------------+------------------------------------+
1798 |recipes |Object |recipes |
1799 +------------------------------+-----------------+------------------------------------+
1800 |serviceResourceCustomizations |Object |serviceResourceCustomizations |
1801 +------------------------------+-----------------+------------------------------------+
1805 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1806 |Attribute |Qualifier|Cardinality|Content|Description |
1807 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1808 |serviceId |M |1 |String |Service instance ID. |
1809 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1810 |operationId |M |1 |String |Service Operation ID. |
1811 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1813 Delete E2E service instance
1814 ++++++++++++++++++++++++++++
1816 +--------------------+-----------------------------------------------+
1817 |Interface Definition|Description |
1818 +====================+===============================================+
1819 |URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
1820 +--------------------+-----------------------------------------------+
1821 |Operation Type |DELETE |
1822 +--------------------+-----------------------------------------------+
1826 +-------------------+---------+-----------+-------+----------------------------------------+
1827 |Attribute |Qualifier|Cardinality|Content|Description |
1828 +===================+=========+===========+=======+========================================+
1829 |globalSubscriberId |M |1 |String |The subscriber id. It is defined in AAI |
1830 +-------------------+---------+-----------+-------+----------------------------------------+
1831 |serviceType |M |1 |String |The service type. It is defined in AAI |
1832 +-------------------+---------+-----------+-------+----------------------------------------+
1836 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1837 |Attribute |Qualifier|Cardinality|Content|Description |
1838 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1839 |operationId |M |1 |String |The operation id. |
1840 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1842 Query E2E service operation result
1843 ++++++++++++++++++++++++++
1845 +--------------------+------------------------------------------------------------------------+
1846 |Interface Definition|Description |
1847 +====================+========================================================================+
1848 |URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
1849 +--------------------+------------------------------------------------------------------------+
1850 |Operation Type |GET |
1851 +--------------------+------------------------------------------------------------------------+
1855 +--------------+---------+-----------+-------+--------------+
1856 |Attribute |Qualifier|Cardinality|Content|Description |
1857 +==============+=========+===========+=======+==============+
1858 |serviceId |M |1 |Service instance ID. |
1859 +--------------+---------+-----------+-------+--------------+
1860 |operationId |M |1 |Service Operation ID. |
1861 +--------------+---------+-----------+-------+--------------+
1865 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1866 |Attribute |Qualifier|Cardinality|Content|Description |
1867 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1868 |operation |M |1 |String |Operation object identify. |
1869 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1870 |operationId |M |1 |String |Operation ID. |
1871 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1872 |operation |M |1 |String |Operation type, create|delete. |
1873 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1874 |result |M |1 |String |Operation result: finished, error, processing. |
1875 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1876 |reason |M |1 |String |If failing, need to write fail reason. |
1877 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1878 |userId |M |1 |String |Operation user ID. |
1879 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1880 |operationContent |M |1 |String |The status detail of current operation which is being executing. |
1881 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1882 |progress |M |1 |String |Current operation progress. |
1883 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1884 |operateAt |M |1 |String |Time that it starts to execute operation. |
1885 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1886 |finishedAt |M |1 |String |Time that it finished executing operation. |
1887 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1892 create or update an existing service-instance
1893 +++++++++++++++++++++++++++++++++++++++++++++
1895 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1896 |Interface Definition|Description |
1897 +====================+====================================================================================================================================================================+
1898 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1899 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1900 |Operation Type |PUT |
1901 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1905 +-------------------+---------+-----------+-------+-----------------------+
1906 |Attribute |Qualifier|Cardinality|Content|Description |
1907 +===================+=========+===========+=======+=======================+
1908 |global-customer-id |M |1 |String |Global Customer ID |
1909 +-------------------+---------+-----------+-------+-----------------------+
1910 |service-type |M |1 |String |Service Type |
1911 +-------------------+---------+-----------+-------+-----------------------+
1912 |service-instance-id|M |1 |String |Service Instance ID |
1913 +-------------------+---------+-----------+-------+-----------------------+
1917 +---------+---------+-----------+-------+-------------------+
1918 |Attribute|Qualifier|Cardinality|Content|Description |
1919 +---------+---------+-----------+-------+-------------------+
1920 |HTTP code|M |1 |Integer|HTTP response code |
1921 +---------+---------+-----------+-------+-------------------+
1923 delete an existing service-instance
1924 +++++++++++++++++++++++++++++++++++
1926 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1927 |Interface Definition|Description |
1928 +====================+====================================================================================================================================================================+
1929 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1930 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1931 |Operation Type |DELETE |
1932 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1936 +-------------------+---------+-----------+-------+-----------------------+
1937 |Attribute |Qualifier|Cardinality|Content|Description |
1938 +===================+=========+===========+=======+=======================+
1939 |global-customer-id |M |1 |String |Global Customer ID |
1940 +-------------------+---------+-----------+-------+-----------------------+
1941 |service-type |M |1 |String |Service Type |
1942 +-------------------+---------+-----------+-------+-----------------------+
1943 |service-instance-id|M |1 |String |Service Instance ID |
1944 +-------------------+---------+-----------+-------+-----------------------+
1948 +---------+---------+-----------+-------+-------------------+
1949 |Attribute|Qualifier|Cardinality|Content|Description |
1950 +---------+---------+-----------+-------+-------------------+
1951 |HTTP code|M |1 |Integer|HTTP response code |
1952 +---------+---------+-----------+-------+-------------------+
1954 get service-instances
1955 +++++++++++++++++++++
1957 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1958 |Interface Definition|Description |
1959 +====================+=============================================================================================================================+
1960 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
1961 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1962 |Operation Type |GET |
1963 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1967 +-------------------+---------+-----------+-------+-----------------------+
1968 |Attribute |Qualifier|Cardinality|Content|Description |
1969 +===================+=========+===========+=======+=======================+
1970 |global-customer-id |M |1 |String |Global Customer ID |
1971 +-------------------+---------+-----------+-------+-----------------------+
1972 |service-type |M |1 |String |Service Type |
1973 +-------------------+---------+-----------+-------+-----------------------+
1974 |subscriber-name |O |1 |String |Subscriber name |
1975 +-------------------+---------+-----------+-------+-----------------------+
1976 |subscriber-type |O |1 |String |Subscriber type |
1977 +-------------------+---------+-----------+-------+-----------------------+
1981 +-----------------+---------+-----------+----------------+-------------------+
1982 |Attribute |Qualifier|Cardinality|Content |Description |
1983 +-----------------+---------+-----------+----------------+-------------------+
1984 |service-instances|M |1 |ServiceInstances|Service Instances |
1985 +-----------------+---------+-----------+----------------+-------------------+
1987 get service-instance
1988 ++++++++++++++++++++
1990 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1991 |Interface Definition|Description |
1992 +====================+====================================================================================================================================================================+
1993 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1994 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1995 |Operation Type |GET |
1996 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2000 +-------------------+---------+-----------+-------+-----------------------+
2001 |Attribute |Qualifier|Cardinality|Content|Description |
2002 +===================+=========+===========+=======+=======================+
2003 |global-customer-id |M |1 |String |Global Customer ID |
2004 +-------------------+---------+-----------+-------+-----------------------+
2005 |service-type |M |1 |String |Service Type |
2006 +-------------------+---------+-----------+-------+-----------------------+
2007 |service-instance-id|M |1 |String |Service instance ID |
2008 +-------------------+---------+-----------+-------+-----------------------+
2012 +-----------------+---------+-----------+----------------+-------------------+
2013 |Attribute |Qualifier|Cardinality|Content |Description |
2014 +-----------------+---------+-----------+----------------+-------------------+
2015 |service-instance |M |1 |ServiceInstance |Service Instance |
2016 +-----------------+---------+-----------+----------------+-------------------+
2018 see node definition for valid relationships
2019 +++++++++++++++++++++++++++++++++++++++++++
2021 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2022 |Interface Definition|Description |
2023 +====================+===================================================================================================================================================================================================+
2024 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2025 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2026 |Operation Type |PUT |
2027 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2031 +-------------------+---------+-----------+-------+-----------------------+
2032 |Attribute |Qualifier|Cardinality|Content|Description |
2033 +===================+=========+===========+=======+=======================+
2034 |global-customer-id |M |1 |String |Global Customer ID |
2035 +-------------------+---------+-----------+-------+-----------------------+
2036 |service-type |M |1 |String |Service Type |
2037 +-------------------+---------+-----------+-------+-----------------------+
2038 |service-instance-id|M |1 |String |Service instance ID |
2039 +-------------------+---------+-----------+-------+-----------------------+
2043 +---------+---------+-----------+-------+-------------------+
2044 |Attribute|Qualifier|Cardinality|Content|Description |
2045 +---------+---------+-----------+-------+-------------------+
2046 |HTTP code|M |1 |Integer|HTTP response code |
2047 +---------+---------+-----------+-------+-------------------+
2049 delete an existing relationship
2050 +++++++++++++++++++++++++++++++
2052 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2053 |Interface Definition|Description |
2054 +====================+===================================================================================================================================================================================================+
2055 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2056 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2057 |Operation Type |DELETE |
2058 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2062 +-------------------+---------+-----------+-------+-----------------------+
2063 |Attribute |Qualifier|Cardinality|Content|Description |
2064 +===================+=========+===========+=======+=======================+
2065 |global-customer-id |M |1 |String |Global Customer ID |
2066 +-------------------+---------+-----------+-------+-----------------------+
2067 |service-type |M |1 |String |Service Type |
2068 +-------------------+---------+-----------+-------+-----------------------+
2069 |service-instance-id|M |1 |String |Service instance ID |
2070 +-------------------+---------+-----------+-------+-----------------------+
2074 +---------+---------+-----------+-------+-------------------+
2075 |Attribute|Qualifier|Cardinality|Content|Description |
2076 +---------+---------+-----------+-------+-------------------+
2077 |HTTP code|M |1 |Integer|HTTP response code |
2078 +---------+---------+-----------+-------+-------------------+
2087 +--------------------+-------------------+
2088 |Interface Definition|Description |
2089 +====================+===================+
2091 +--------------------+-------------------+
2092 |Operation Type |POST |
2093 +--------------------+-------------------+
2094 |Content-Type |application/json |
2095 +--------------------+-------------------+
2099 +-------------------+---------+-----------+-------+-----------------------+
2100 |Attribute |Qualifier|Cardinality|Content|Description |
2101 +===================+=========+===========+=======+=======================+
2102 |context |M |1 |Object |Context |
2103 +-------------------+---------+-----------+-------+-----------------------+
2104 |csarId |M |1 |String |csarId |
2105 +-------------------+---------+-----------+-------+-----------------------+
2106 |nsName |M |1 |String |Name of the NS |
2107 +-------------------+---------+-----------+-------+-----------------------+
2108 |description |M |1 |String |description |
2109 +-------------------+---------+-----------+-------+-----------------------+
2113 +-----------------+---------+-----------+----------------+-------------------+
2114 |Attribute |Qualifier|Cardinality|Content |Description |
2115 +-----------------+---------+-----------+----------------+-------------------+
2116 |nsInstanceId |M |1 |String |nsInstanceId |
2117 +-----------------+---------+-----------+----------------+-------------------+
2122 +--------------------+-------------------+
2123 |Interface Definition|Description |
2124 +====================+===================+
2126 +--------------------+-------------------+
2127 |Operation Type |GET |
2128 +--------------------+-------------------+
2129 |Content-Type |application/json |
2130 +--------------------+-------------------+
2134 +-----------------+---------+-----------+----------------+-------------------+
2135 |Attribute |Qualifier|Cardinality|Content |Description |
2136 +-----------------+---------+-----------+----------------+-------------------+
2137 |nsInstanceId |M |1 |String |nsInstanceId |
2138 +-----------------+---------+-----------+----------------+-------------------+
2139 |nsName |M |1 |String |The name of ns |
2140 +-----------------+---------+-----------+----------------+-------------------+
2141 |description |M |1 |String |description |
2142 +-----------------+---------+-----------+----------------+-------------------+
2143 |nsdId |M |1 |String |ID of ns |
2144 +-----------------+---------+-----------+----------------+-------------------+
2145 |vnfInfo |M |1 |Array |Vnf information |
2146 +-----------------+---------+-----------+----------------+-------------------+
2147 |vlInfo |M |1 |Array |vl information |
2148 +-----------------+---------+-----------+----------------+-------------------+
2149 |vnffgInfo |M |1 |Array |vnffg information |
2150 +-----------------+---------+-----------+----------------+-------------------+
2151 |nsState |M |1 |String |state of ns |
2152 +-----------------+---------+-----------+----------------+-------------------+
2156 +-----------------+---------+-----------+----------------+-------------------+
2157 |Attribute |Qualifier|Cardinality|Content |Description |
2158 +-----------------+---------+-----------+----------------+-------------------+
2159 |vnfInstanceId |M |1 |String |vnfInstanceId |
2160 +-----------------+---------+-----------+----------------+-------------------+
2161 |vnfInstanceName |M |1 |String |vnfInstanceName |
2162 +-----------------+---------+-----------+----------------+-------------------+
2163 |vnfdId |M |1 |String |vnfdId |
2164 +-----------------+---------+-----------+----------------+-------------------+
2168 +----------------------+---------+-----------+----------------+-------------------+
2169 |Attribute |Qualifier|Cardinality|Content |Description |
2170 +----------------------+---------+-----------+----------------+-------------------+
2171 |vlInstanceId |M |1 |String |vlInstanceId |
2172 +----------------------+---------+-----------+----------------+-------------------+
2173 |vlInstanceName |M |1 |String |vlInstanceName |
2174 +----------------------+---------+-----------+----------------+-------------------+
2175 |vldId |M |1 |String |vldId |
2176 +----------------------+---------+-----------+----------------+-------------------+
2177 |relatedCpInstanceId |M |1 |Array |relatedCpInstanceId|
2178 +----------------------+---------+-----------+----------------+-------------------+
2180 relatedCpInstanceId Array:
2182 +----------------------+---------+-----------+----------------+-------------------+
2183 |Attribute |Qualifier|Cardinality|Content |Description |
2184 +----------------------+---------+-----------+----------------+-------------------+
2185 |cpInstanceId |M |1 |String |cpInstanceId |
2186 +----------------------+---------+-----------+----------------+-------------------+
2187 |cpInstanceName |M |1 |String |cpInstanceName |
2188 +----------------------+---------+-----------+----------------+-------------------+
2189 |cpdId |M |1 |String |cpdId |
2190 +----------------------+---------+-----------+----------------+-------------------+
2194 +----------------------+---------+-----------+----------------+-------------------+
2195 |Attribute |Qualifier|Cardinality|Content |Description |
2196 +----------------------+---------+-----------+----------------+-------------------+
2197 |vnffgInstanceId |M |1 |String |vnffgInstanceId |
2198 +----------------------+---------+-----------+----------------+-------------------+
2199 |vnfId |M |1 |String |vnfId |
2200 +----------------------+---------+-----------+----------------+-------------------+
2201 |pnfId |M |1 |String |pnfId |
2202 +----------------------+---------+-----------+----------------+-------------------+
2203 |virtualLinkId |M |1 |Array |virtualLinkId |
2204 +----------------------+---------+-----------+----------------+-------------------+
2205 |cpId |M |1 |Array |cpId |
2206 +----------------------+---------+-----------+----------------+-------------------+
2207 |nfp |M |1 |Array |nfp |
2208 +----------------------+---------+-----------+----------------+-------------------+
2213 +--------------------+-------------------------------------+
2214 |Interface Definition|Description |
2215 +====================+=====================================+
2216 |URI |/ns/{nsInstanceId}/Instantiate |
2217 +--------------------+-------------------------------------+
2218 |Operation Type |POST |
2219 +--------------------+-------------------------------------+
2220 |Content-Type |application/json |
2221 +--------------------+-------------------------------------+
2225 +----------------------+---------+-----------+-------+-----------------------+
2226 |Attribute |Qualifier|Cardinality|Content|Description |
2227 +======================+=========+===========+=======+=======================+
2228 |LocationConstraints |M |1 |Array |LocationConstraints |
2229 +----------------------+---------+-----------+-------+-----------------------+
2230 |additionalParamForNs |M |1 |String |additionalParamForNs |
2231 +----------------------+---------+-----------+-------+-----------------------+
2232 |nsInstanceId |M |1 |String |nsInstanceId |
2233 +----------------------+---------+-----------+-------+-----------------------+
2235 LocationConstraints Array:
2237 +----------------------+---------+-----------+-------+-----------------------+
2238 |Attribute |Qualifier|Cardinality|Content|Description |
2239 +======================+=========+===========+=======+=======================+
2240 |vnfProfileId |M |1 |String |vnfProfileId |
2241 +----------------------+---------+-----------+-------+-----------------------+
2242 |vimid |M |1 |String |vimid |
2243 +----------------------+---------+-----------+-------+-----------------------+
2247 +--------------+---------+-----------+-------+-----------------------+
2248 |Attribute |Qualifier|Cardinality|Content|Description |
2249 +==============+=========+===========+=======+=======================+
2250 |jobId |M |1 |String |jobId |
2251 +--------------+---------+-----------+-------+-----------------------+
2256 +--------------------+-------------------------------------+
2257 |Interface Definition|Description |
2258 +====================+=====================================+
2259 |URI |/ns/{ns_instance_id}/terminate |
2260 +--------------------+-------------------------------------+
2261 |Operation Type |POST |
2262 +--------------------+-------------------------------------+
2263 |Content-Type |application/json |
2264 +--------------------+-------------------------------------+
2268 +----------------------------+---------+-----------+-------+-----------------------------+
2269 |Attribute |Qualifier|Cardinality|Content|Description |
2270 +============================+=========+===========+=======+=============================+
2271 |terminationType |M |1 |String |terminationType |
2272 +----------------------------+---------+-----------+-------+-----------------------------+
2273 |gracefulTerminationTimeout |M |1 |String |gracefulTerminationTimeout |
2274 +----------------------------+---------+-----------+-------+-----------------------------+
2275 |nsInstanceId |M |1 |String |nsInstanceId |
2276 +----------------------------+---------+-----------+-------+-----------------------------+
2280 +--------------+---------+-----------+-------+-----------------------+
2281 |Attribute |Qualifier|Cardinality|Content|Description |
2282 +==============+=========+===========+=======+=======================+
2283 |jobId |M |1 |String |jobId |
2284 +--------------+---------+-----------+-------+-----------------------+
2289 +--------------------+-------------------------------------+
2290 |Interface Definition|Description |
2291 +====================+=====================================+
2292 |URI |/ns/{ns_instance_id} |
2293 +--------------------+-------------------------------------+
2294 |Operation Type |DELETE |
2295 +--------------------+-------------------------------------+
2299 +----------------------------+---------+-----------+-------+-----------------------------+
2300 |Attribute |Qualifier|Cardinality|Content|Description |
2301 +============================+=========+===========+=======+=============================+
2302 |nsInstanceId |M |1 |String |nsInstanceId |
2303 +----------------------------+---------+-----------+-------+-----------------------------+
2310 https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
2312 +--------------------+-----------------------------------------------------------------------------------------------+
2313 |Interface Definition|Description |
2314 +====================+===============================================================================================+
2315 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens |
2316 +--------------------+-----------------------------------------------------------------------------------------------+
2317 |Operation Type |POST |
2318 +--------------------+-----------------------------------------------------------------------------------------------+
2319 |Content-Type |application/json |
2320 +--------------------+-----------------------------------------------------------------------------------------------+
2324 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2325 |Attribute |Qualifier|Cardinality|Content |Description |
2326 +================+=========+===========+==========================+================================================================================================================================================+
2327 |nocatalog |O |1 |string |The authentication response excludes the service catalog. By default, the response includes the service catalog. |
2328 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2329 |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.|
2330 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2331 |auth |M |1 |object |An auth object. |
2332 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2333 |user |M |1 |object |A user object. |
2334 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2335 |scope |O |1 |string |The authorization scope, including either a project or a domain |
2336 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2337 |password |M |1 |object |The password object, contains the authentication information. |
2338 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2339 |id |O |1 |string |The ID of the user. Required if you do not specify the user name. |
2340 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2341 |identity |M |1 |object |An identity object. |
2342 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2343 |methods |M |1 |array |The authentication method. For password authentication, specify password. |
2344 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2348 +-------------------------+------------------+--------------------------------------------------------------------------+
2349 |Attribute |Content |Description |
2350 +=========================+==================+==========================================================================+
2351 |X-Subject-Token |String |The authentication token. |
2352 +-------------------------+------------------+--------------------------------------------------------------------------+
2353 |domain |object |A domain object, containing: |
2354 +-------------------------+------------------+--------------------------------------------------------------------------+
2355 |region_id |String |The ID of the region that contains the service endpoint. |
2356 +-------------------------+------------------+--------------------------------------------------------------------------+
2357 |methods |array |The authentication method. For password authentication, specify password. |
2358 +-------------------------+------------------+--------------------------------------------------------------------------+
2359 |roles |array |A list of role objects, each containing: |
2360 +-------------------------+------------------+--------------------------------------------------------------------------+
2361 |url |String |The endpoint URL. |
2362 +-------------------------+------------------+--------------------------------------------------------------------------+
2363 |region |String |The geographic location of the service endpoint. |
2364 +-------------------------+------------------+--------------------------------------------------------------------------+
2365 |token |object |A token object. |
2366 +-------------------------+------------------+--------------------------------------------------------------------------+
2367 |expires_at |String |The date and time when the token expires. |
2368 +-------------------------+------------------+--------------------------------------------------------------------------+
2369 |project |object |A project object, containing: |
2370 +-------------------------+------------------+--------------------------------------------------------------------------+
2371 |issued_at |String |The date and time when the token was issued. |
2372 +-------------------------+------------------+--------------------------------------------------------------------------+
2373 |catalog |array |A catalog object. |
2374 +-------------------------+------------------+--------------------------------------------------------------------------+
2375 |extras |object |A set of metadata key and value pairs, if any. |
2376 +-------------------------+------------------+--------------------------------------------------------------------------+
2377 |user |object |A user object. |
2378 +-------------------------+------------------+--------------------------------------------------------------------------+
2379 |audit_ids |array |A list of one or two audit IDs. |
2380 +-------------------------+------------------+--------------------------------------------------------------------------+
2381 |interface |String |The interface type, which describes the visibility of the endpoint. |
2382 +-------------------------+------------------+--------------------------------------------------------------------------+
2383 |endpoints |array |A list of endpoint objects. |
2384 +-------------------------+------------------+--------------------------------------------------------------------------+
2385 |type |String |The endpoint type. |
2386 +-------------------------+------------------+--------------------------------------------------------------------------+
2387 |id |String |The ID of the user. Required if you do not specify the user name. |
2388 +-------------------------+------------------+--------------------------------------------------------------------------+
2389 |name |String |The user name. |
2390 +-------------------------+------------------+--------------------------------------------------------------------------+
2395 https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
2397 +--------------------+-----------------------------------------------------------------------------------------------+
2398 |Interface Definition|Description |
2399 +====================+===============================================================================================+
2400 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks |
2401 +--------------------+-----------------------------------------------------------------------------------------------+
2402 |Operation Type |POST |
2403 +--------------------+-----------------------------------------------------------------------------------------------+
2404 |Content-Type |application/json |
2405 +--------------------+-----------------------------------------------------------------------------------------------+
2409 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2410 |Attribute |Qualifier|Cardinality|Content |Description |
2411 +==================+=========+===========+==========================+=================================================================================================+
2412 |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2413 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2414 |disable_rollback |O |1 |boolean |Enables or disables deletion of all stack resources when stack creation fails. |
2415 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2416 |environment |O |1 |object |A JSON environment for the stack. |
2417 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2418 |files |O |1 |object |Supplies the contents of files referenced in the template or the environment. |
2419 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2420 |parameters |O |1 |object |Supplies arguments for parameters defined in the stack template. |
2421 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2422 |stack_name |M |1 |string |A name for the stack. |
2423 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2424 |tags |O |1 |string |One or more simple string tags to associate with the stack. |
2425 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2426 |template |O |1 |object |The stack template on which to perform the operation. |
2427 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2428 |template_url |O |1 |string |A URI to the location containing the stack template on which to perform the operation. |
2429 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2430 |timeout_mins |O |1 |integer |The timeout for stack creation in minutes. |
2431 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2435 +-------------------------+------------------+--------------------------------------------------------------------------+
2436 |Attribute |Content |Description |
2437 +=========================+==================+==========================================================================+
2438 |location |String |For asynchronous resource operations. |
2439 +-------------------------+------------------+--------------------------------------------------------------------------+
2440 |X-Openstack-Reqeuest-Id |object |A domain object, containing: |
2441 +-------------------------+------------------+--------------------------------------------------------------------------+
2442 |stack |String |The ID of the region that contains the service endpoint. |
2443 +-------------------------+------------------+--------------------------------------------------------------------------+
2444 |id |String |The authentication method. For password authentication, specify password. |
2445 +-------------------------+------------------+--------------------------------------------------------------------------+
2446 |links |String |The authentication method. For password authentication, specify password. |
2447 +-------------------------+------------------+--------------------------------------------------------------------------+
2452 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2454 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2455 |Interface Definition|Description |
2456 +====================+=======================================================================================================================+
2457 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2458 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2459 |Operation Type |GET |
2460 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2461 |Content-Type |application/json |
2462 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2466 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2467 |Attribute |Qualifier|Cardinality|Content |Description |
2468 +==================+=========+===========+==========================+=================================================================================================+
2469 |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2470 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2471 |stack_name |M |1 |string |The name of a stack. |
2472 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2473 |stack_id |M |1 |string |The UUID of the stack. |
2474 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2475 |resolve_outputs |O |1 |boolean |A boolean indicating whether the outputs section of a stack should be resolved. |
2476 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2480 +-------------------------+------------------+------------------------------------------------------------------------------+
2481 |Attribute |Content |Description |
2482 +=========================+==================+==============================================================================+
2483 |X-Openstack-Reqeuest-Id |String |A unique ID for tracking service request. |
2484 +-------------------------+------------------+------------------------------------------------------------------------------+
2485 |stack |Object |The stack object. |
2486 +-------------------------+------------------+------------------------------------------------------------------------------+
2487 |capabilities |array |List of stack capabilities for stack. |
2488 +-------------------------+------------------+------------------------------------------------------------------------------+
2489 |creation_time |String |The date and time when the resource was created. |
2490 +-------------------------+------------------+------------------------------------------------------------------------------+
2491 |deletion_time |String |The date and time when the resource was (soft-) deleted. |
2492 +-------------------------+------------------+------------------------------------------------------------------------------+
2493 |description |String |The description of the stack resource. |
2494 +-------------------------+------------------+------------------------------------------------------------------------------+
2495 |disable_rollback |boolean |Whether deletion of all stack resources when stack creation fails is enabled. |
2496 +-------------------------+------------------+------------------------------------------------------------------------------+
2497 |id |String |The UUID of the stack. |
2498 +-------------------------+------------------+------------------------------------------------------------------------------+
2499 |links |array |A list of URLs for the stack. |
2500 +-------------------------+------------------+------------------------------------------------------------------------------+
2501 |notification_topics |array |List of notification topics for stack. |
2502 +-------------------------+------------------+------------------------------------------------------------------------------+
2503 |outputs |array |A list of stack outputs. |
2504 +-------------------------+------------------+------------------------------------------------------------------------------+
2505 |parameters |object | A group of key-value pairs |
2506 +-------------------------+------------------+------------------------------------------------------------------------------+
2507 |parent |String |The stack ID of the parent stack, if this is a nested stack. |
2508 +-------------------------+------------------+------------------------------------------------------------------------------+
2509 |stack_name |String |A name for the stack. |
2510 +-------------------------+------------------+------------------------------------------------------------------------------+
2511 |stack_owner |String |The owner of the stack. |
2512 +-------------------------+------------------+------------------------------------------------------------------------------+
2513 |stack_status |String |The status of the stack. |
2514 +-------------------------+------------------+------------------------------------------------------------------------------+
2515 |stack_status_reason |String |The reason for the current status of the stack. |
2516 +-------------------------+------------------+------------------------------------------------------------------------------+
2517 |stack_user_project_id |String |The project UUID of the stack user. |
2518 +-------------------------+------------------+------------------------------------------------------------------------------+
2519 |tags |array |The stack tags. |
2520 +-------------------------+------------------+------------------------------------------------------------------------------+
2521 |template_description |String |The description of the stack template. |
2522 +-------------------------+------------------+------------------------------------------------------------------------------+
2523 |timeout_mins |integer |The timeout for stack creation in minutes. |
2524 +-------------------------+------------------+------------------------------------------------------------------------------+
2525 |updated_time |String |The date and time when the object was updated. |
2526 +-------------------------+------------------+------------------------------------------------------------------------------+
2531 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2533 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2534 |Interface Definition|Description |
2535 +====================+=======================================================================================================================+
2536 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2537 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2538 |Operation Type |DELETE |
2539 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2540 |Content-Type |application/json |
2541 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2545 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2546 |Attribute |Qualifier|Cardinality|Content |Description |
2547 +==================+=========+===========+==========================+=================================================================================================+
2548 |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2549 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2550 |stack_name |M |1 |string |The name of a stack. |
2551 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2552 |stack_id |M |1 |string |The UUID of the stack. |
2553 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2558 https://developer.openstack.org/api-ref/compute/#create-server
2560 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2561 |Interface Definition|Description |
2562 +====================+=======================================================================================================================+
2563 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.37/{tenant_id}/servers |
2564 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2565 |Operation Type |POST |
2566 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2567 |Content-Type |application/json |
2568 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2572 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2573 |Attribute |Qualifier|Cardinality|Content |Description |
2574 +================================================+=========+===========+==========================+=================================================================================================+
2575 |server |M |1 |object |A server object. |
2576 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2577 |name |M |1 |string |The server name. |
2578 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2579 |flavorRef |M |1 |string |The flavor reference, as an ID (including a UUID) or full URL |
2580 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2581 |imageRef |M |1 |string |The UUID of the image to use for your server instance |
2582 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2583 |security_groups |O |1 |array |One or more security groups. |
2584 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2585 |metadata |O |1 |object |Metadata key and value pairs. |
2586 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2587 |accessIPv4 |O |1 |string |IPv4 address that should be used to access this server. |
2588 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2589 |accessIPv6 |O |1 |string |IPv6 address that should be used to access this server. |
2590 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2591 |adminPass |O |1 |string |The administrative password of the server. |
2592 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2593 |user_data |O |1 |string |Configuration information or scripts to use upon launch. |
2594 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2595 |availability_zone |O |1 |string |The availability zone from which to launch the server. |
2596 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2597 |networks |M |1 |object |A networks object. |
2598 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2599 |networks.uuid |O |1 |string |To provision the server instance with a NIC for a network |
2600 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2601 |networks.port |O |1 |string |To provision the server instance with a NIC for an already existing port |
2602 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2603 |networks.fixed_ip |O |1 |string |A fixed IPv4 address for the NIC |
2604 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2605 |networks.tag |O |1 |string |A device role tag that can be applied to a network interface. |
2606 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2607 |personality |O |1 |array |The file path and contents, text only, to inject into the server at launch. |
2608 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2609 |block_device_mapping_v2 |O |1 |array |Enables fine grained control of the block device mapping for an instance. |
2610 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2611 |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. |
2612 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2613 |block_device_mapping_v2.source_type |M |1 |string |The source type of the volume. |
2614 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2615 |block_device_mapping_v2.destination_type |O |1 |string |Defines where the volume comes from. |
2616 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2617 |block_device_mapping_v2.delete_on_termination |O |1 |string |To delete the boot volume when the server is destroyed, specify true. |
2618 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2619 |block_device_mapping_v2.guest_format |M |1 |string |Specifies the guest server disk file system format, such as ephemeral or swap. |
2620 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2621 |block_device_mapping_v2.boot_index |M |1 |string |Defines the order in which a hypervisor tries devices |
2622 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2623 |block_device_mapping_v2.uuid |O |1 |string |This is the uuid of source resource. |
2624 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2625 |block_device_mapping_v2.tag |O |1 |string |A device role tag that can be applied to a block device. |
2626 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2627 |block_device_mapping_v2.disk_bus |O |1 |string |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter |
2628 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2629 |config_drive |O |1 |boolean |Indicates whether a configuration drive enables metadata injection. |
2630 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2631 |key_name |O |1 |string |Key pair name. |
2632 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2633 |os:scheduler_hints |O |1 |object |The dictionary of data to send to the scheduler. |
2634 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2635 |OS-DCF:diskConfig |O |1 |string |Controls how the API partitions the disk when you create, rebuild, or resize servers. |
2636 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2637 |description |O |1 |string |A free form description of the server. |
2638 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2639 |tags |O |1 |array |A list of tags. |
2640 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2644 +-------------------------+------------------+------------------------------------------------------------------------------+
2645 |Attribute |Content |Description |
2646 +=========================+==================+==============================================================================+
2647 |Location |String |The location URL of the server. |
2648 +-------------------------+------------------+------------------------------------------------------------------------------+
2649 |server |object |A server object. |
2650 +-------------------------+------------------+------------------------------------------------------------------------------+
2651 |id |String |The UUID of the server. |
2652 +-------------------------+------------------+------------------------------------------------------------------------------+
2653 |links |array |Links to the resources in question. |
2654 +-------------------------+------------------+------------------------------------------------------------------------------+
2655 |OS-DCF:diskConfig |String |Disk configuration. |
2656 +-------------------------+------------------+------------------------------------------------------------------------------+
2657 |security_groups |array |One or more security groups objects. |
2658 +-------------------------+------------------+------------------------------------------------------------------------------+
2659 |security_groups.name |String |The security group name. |
2660 +-------------------------+------------------+------------------------------------------------------------------------------+
2661 |adminPass |String |The administrative password for the server. |
2662 +-------------------------+------------------+------------------------------------------------------------------------------+
2667 https://developer.openstack.org/api-ref/compute/#delete-server
2669 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2670 |Interface Definition|Description |
2671 +====================+=======================================================================================================================+
2672 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id} |
2673 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2674 |Operation Type |DELETE |
2675 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2676 |Content-Type |application/json |
2677 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2681 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2682 |Attribute |Qualifier|Cardinality|Content |Description |
2683 +==================+=========+===========+==========================+=================================================================================================+
2684 |server_id |M |1 |string |The UUID of the server. |
2685 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2690 https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
2692 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2693 |Interface Definition|Description |
2694 +====================+=======================================================================================================================+
2695 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs |
2696 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2697 |Operation Type |POST |
2698 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2699 |Content-Type |application/json |
2700 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2704 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2705 |Attribute |Qualifier|Cardinality|Content |Description |
2706 +==================+=========+===========+==========================+=================================================================================================+
2707 |keypair |M |1 |Object |Keypair object |
2708 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2709 |name |M |1 |string |A name for the keypair which will be used to reference it later. |
2710 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2711 |public_key |O |1 |string |The public ssh key to import. If you omit this value, a keypair is generated for you. |
2712 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2713 |type |O |1 |string |The type of the keypair. |
2714 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2715 |user_id |O |1 |string |The user_id for a keypair. |
2716 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2720 +-----------------+------------------+------------------------------------------------------------------------------+
2721 |Attribute |Content |Description |
2722 +=================+==================+==============================================================================+
2723 |keypair |object |Keypair object |
2724 +-----------------+------------------+------------------------------------------------------------------------------+
2725 |name |String |A name for the keypair which will be used to reference it later. |
2726 +-----------------+------------------+------------------------------------------------------------------------------+
2727 |public_key |String |The keypair public key. |
2728 +-----------------+------------------+------------------------------------------------------------------------------+
2729 |fingerprint |String |The fingerprint for the keypair. |
2730 +-----------------+------------------+------------------------------------------------------------------------------+
2731 |user_id |String |The user_id for a keypair. |
2732 +-----------------+------------------+------------------------------------------------------------------------------+
2733 |private_key |String |If you do not provide a public key on create |
2734 +-----------------+------------------+------------------------------------------------------------------------------+
2735 |type |String |The type of the keypair. |
2736 +-----------------+------------------+------------------------------------------------------------------------------+
2741 https://developer.openstack.org/api-ref/compute/#delete-keypair
2743 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2744 |Interface Definition|Description |
2745 +====================+=======================================================================================================================+
2746 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id} |
2747 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2748 |Operation Type |DELETE |
2749 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2750 |Content-Type |application/json |
2751 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2755 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2756 |Attribute |Qualifier|Cardinality|Content |Description |
2757 +==================+=========+===========+==========================+=================================================================================================+
2758 |keypair_name |M |1 |String |The keypair name. |
2759 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2760 |user_id |O |1 |String |This allows administrative users to operate key-pairs of specified user ID. |
2761 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2766 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
2768 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2769 |Interface Definition|Description |
2770 +====================+=======================================================================================================================+
2771 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks |
2772 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2773 |Operation Type |POST |
2774 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2775 |Content-Type |application/json |
2776 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2780 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2781 |Attribute |Qualifier|Cardinality|Content |Description |
2782 +============================+=========+===========+==========================+=================================================================================================+
2783 |network |M |1 |Object |A network object. |
2784 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2785 |admin_state_up |O |1 |boolean |The administrative state of the network, which is up (true) or down (false). |
2786 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2787 |dns_domain |O |1 |string |A valid DNS domain. |
2788 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2789 |mtu |O |1 |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2790 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2791 |name |O |1 |string |Human-readable name of the network. |
2792 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2793 |port_security_enabled |O |1 |boolean |The port security status of the network. |
2794 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2795 |project_id |O |1 |string |The ID of the project that owns the resource. |
2796 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2797 |provider:network_type |O |1 |string |The type of physical network that this network should be mapped to. |
2798 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2799 |provider:physical_network |O |1 |string |The physical network where this network should be implemented. |
2800 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2801 |provider:segmentation_id |O |1 |integer |The ID of the isolated segment on the physical network. |
2802 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2803 |qos_policy_id |O |1 |string |The ID of the QoS policy. |
2804 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2805 |router:external |O |1 |boolean |Indicates whether this network can provide floating IPs via a router. |
2806 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2807 |segments |O |1 |array |A list of provider segment objects. |
2808 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2809 |shared |O |1 |boolean |Indicates whether this network is shared across all tenants. |
2810 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2811 |tenant_id |O |1 |string |The ID of the project that owns the resource. |
2812 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2813 |vlan_transparent |O |1 |boolean |Indicates the VLAN transparency mode of the network, |
2814 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2815 |description |O |1 |string |A human-readable description for the resource. |
2816 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2817 |is_default |O |1 |boolean |The network is default or not. |
2818 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2819 |availability_zone_hints |O |1 |array |The availability zone candidate for the network. |
2820 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2824 +-----------------------------+------------------+------------------------------------------------------------------------------+
2825 |Attribute |Content |Description |
2826 +=============================+==================+==============================================================================+
2827 |network |object |A network object. |
2828 +-----------------------------+------------------+------------------------------------------------------------------------------+
2829 |admin_state_up |boolean |The administrative state of the network, which is up (true) or down (false). |
2830 +-----------------------------+------------------+------------------------------------------------------------------------------+
2831 |availability_zone_hints |array |The availability zone candidate for the network. |
2832 +-----------------------------+------------------+------------------------------------------------------------------------------+
2833 |availability_zones |array |The availability zone for the network. |
2834 +-----------------------------+------------------+------------------------------------------------------------------------------+
2835 |created_at |String |Time at which the resource has been created (in UTC ISO8601 format). |
2836 +-----------------------------+------------------+------------------------------------------------------------------------------+
2837 |dns_domain |String |A valid DNS domain. |
2838 +-----------------------------+------------------+------------------------------------------------------------------------------+
2839 |id |String |The ID of the network. |
2840 +-----------------------------+------------------+------------------------------------------------------------------------------+
2841 |ipv4_address_scope |String |The ID of the IPv4 address scope that the network is associated with. |
2842 +-----------------------------+------------------+------------------------------------------------------------------------------+
2843 |ipv6_address_scope |String |The ID of the IPv6 address scope that the network is associated with. |
2844 +-----------------------------+------------------+------------------------------------------------------------------------------+
2845 |mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2846 +-----------------------------+------------------+------------------------------------------------------------------------------+
2847 |name |String |Human-readable name of the network. |
2848 +-----------------------------+------------------+------------------------------------------------------------------------------+
2849 |port_security_enabled |boolean |The port security status of the network. |
2850 +-----------------------------+------------------+------------------------------------------------------------------------------+
2851 |project_id |String |The ID of the project. |
2852 +-----------------------------+------------------+------------------------------------------------------------------------------+
2853 |provider:network_type |String |The type of physical network that this network is mapped to. |
2854 +-----------------------------+------------------+------------------------------------------------------------------------------+
2855 |provider:physical_network |String |The physical network where this network is implemented. |
2856 +-----------------------------+------------------+------------------------------------------------------------------------------+
2857 |provider:segmentation_id |integer |The ID of the isolated segment on the physical network. |
2858 +-----------------------------+------------------+------------------------------------------------------------------------------+
2859 |qos_policy_id |String |The ID of the QoS policy. |
2860 +-----------------------------+------------------+------------------------------------------------------------------------------+
2861 |revision_number |integer |The revision number of the resource. |
2862 +-----------------------------+------------------+------------------------------------------------------------------------------+
2863 |router:external |boolean |Indicates whether this network can provide floating IPs via a router. |
2864 +-----------------------------+------------------+------------------------------------------------------------------------------+
2865 |segments |array |A list of provider segment objects. |
2866 +-----------------------------+------------------+------------------------------------------------------------------------------+
2867 |shared |boolean |Indicates whether this network is shared across all tenants. |
2868 +-----------------------------+------------------+------------------------------------------------------------------------------+
2869 |status |String |The network status. Values are ACTIVE, DOWN, BUILD or ERROR. |
2870 +-----------------------------+------------------+------------------------------------------------------------------------------+
2871 |subnets |array |The associated subnets. |
2872 +-----------------------------+------------------+------------------------------------------------------------------------------+
2873 |tenant_id |String |The ID of the project. |
2874 +-----------------------------+------------------+------------------------------------------------------------------------------+
2875 |updated_at |String |Time at which the resource has been updated (in UTC ISO8601 format). |
2876 +-----------------------------+------------------+------------------------------------------------------------------------------+
2877 |vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. |
2878 +-----------------------------+------------------+------------------------------------------------------------------------------+
2879 |description |String |A human-readable description for the resource. |
2880 +-----------------------------+------------------+------------------------------------------------------------------------------+
2881 |is_default |boolean |The network is default pool or not. |
2882 +-----------------------------+------------------+------------------------------------------------------------------------------+
2887 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
2889 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2890 |Interface Definition|Description |
2891 +====================+=======================================================================================================================+
2892 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id} |
2893 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2894 |Operation Type |DELETE |
2895 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2896 |Content-Type |application/json |
2897 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2901 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2902 |Attribute |Qualifier|Cardinality|Content |Description |
2903 +============================+=========+===========+==========================+==============================================================+
2904 |network_id |M |1 |String |The ID of the network. |
2905 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2910 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
2912 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2913 |Interface Definition|Description |
2914 +====================+=======================================================================================================================+
2915 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets |
2916 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2917 |Operation Type |POST |
2918 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2919 |Content-Type |application/json |
2920 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2924 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2925 |Attribute |Qualifier|Cardinality|Content |Description |
2926 +============================+=========+===========+==========================+=================================================================================================+
2927 |subnet |M |1 |string |A subnet object. |
2928 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2929 |tenant_id |O |1 |string |The ID of the project that owns the resource. |
2930 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2931 |project_id |O |1 |string |The ID of the project that owns the resource. |
2932 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2933 |name |O |1 |string |Human-readable name of the resource. |
2934 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2935 |enable_dhcp |O |1 |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2936 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2937 |network_id |M |1 |string |The ID of the network to which the subnet belongs. |
2938 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2939 |dns_nameservers |O |1 |array |List of dns name servers associated with the subnet. |
2940 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2941 |allocation_pools |O |1 |array |Allocation pools with start and end IP addresses for this subnet. |
2942 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2943 |host_routes |O |1 |array |Additional routes for the subnet. |
2944 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2945 |ip_version |M |1 |integer |The IP protocol version. Value is 4 or 6. |
2946 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2947 |gateway_ip |O |1 |string |Gateway IP of this subnet. |
2948 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2949 |cidr |M |1 |string |The CIDR of the subnet. |
2950 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2951 |description |O |1 |string |A human-readable description for the resource. |
2952 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2953 |ipv6_address_mode |O |1 |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2954 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2955 |ipv6_ra_mode |O |1 |string |The IPv6 router advertisement specifies whether the networking service |
2956 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2957 |segment_id |O |1 |string |The ID of a network segment the subnet is associated with. |
2958 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2959 |subnetpool_id |O |1 |string |The ID of the subnet pool associated with the subnet. |
2960 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2961 |use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. |
2962 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2963 |service_types |O |1 |array |The service types associated with the subnet. |
2964 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2968 +-----------------------------+------------------+------------------------------------------------------------------------------+
2969 |Attribute |Content |Description |
2970 +=============================+==================+==============================================================================+
2971 |subnet |string |A subnet object. |
2972 +-----------------------------+------------------+------------------------------------------------------------------------------+
2973 |id |string |The ID of the subnet. |
2974 +-----------------------------+------------------+------------------------------------------------------------------------------+
2975 |tenant_id |string |The ID of the project. |
2976 +-----------------------------+------------------+------------------------------------------------------------------------------+
2977 |project_id |string |The ID of the project. |
2978 +-----------------------------+------------------+------------------------------------------------------------------------------+
2979 |name |String |Human-readable name of the resource. |
2980 +-----------------------------+------------------+------------------------------------------------------------------------------+
2981 |enable_dhcp |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2982 +-----------------------------+------------------+------------------------------------------------------------------------------+
2983 |network_id |String |The ID of the network to which the subnet belongs. |
2984 +-----------------------------+------------------+------------------------------------------------------------------------------+
2985 |dns_nameservers |array |List of dns name servers associated with the subnet. |
2986 +-----------------------------+------------------+------------------------------------------------------------------------------+
2987 |allocation_pools |array |Allocation pools with start and end IP addresses for this subnet. |
2988 +-----------------------------+------------------+------------------------------------------------------------------------------+
2989 |host_routes |array |Additional routes for the subnet. |
2990 +-----------------------------+------------------+------------------------------------------------------------------------------+
2991 |ip_version |integer |The IP protocol version. Value is 4 or 6. |
2992 +-----------------------------+------------------+------------------------------------------------------------------------------+
2993 |gateway_ip |string |Gateway IP of this subnet. |
2994 +-----------------------------+------------------+------------------------------------------------------------------------------+
2995 |cidr |string |The CIDR of the subnet. |
2996 +-----------------------------+------------------+------------------------------------------------------------------------------+
2997 |created_at |string |Time at which the subnet has been created. |
2998 +-----------------------------+------------------+------------------------------------------------------------------------------+
2999 |description |string |A human-readable description for the resource. |
3000 +-----------------------------+------------------+------------------------------------------------------------------------------+
3001 |ipv6_address_mode |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
3002 +-----------------------------+------------------+------------------------------------------------------------------------------+
3003 |ipv6_ra_mode |string |The IPv6 router advertisement specifies whether the networking service |
3004 +-----------------------------+------------------+------------------------------------------------------------------------------+
3005 |revision_number |integer |The revision number of the resource. |
3006 +-----------------------------+------------------+------------------------------------------------------------------------------+
3007 |service_types |string |The service types associated with the subnet. |
3008 +-----------------------------+------------------+------------------------------------------------------------------------------+
3009 |subnetpool_id |string |The ID of the subnet pool associated with the subnet. |
3010 +-----------------------------+------------------+------------------------------------------------------------------------------+
3011 |segment_id |string |The ID of a network segment the subnet is associated with. |
3012 +-----------------------------+------------------+------------------------------------------------------------------------------+
3013 |updated_at |string |Time at which the subnet has been updated. |
3014 +-----------------------------+------------------+------------------------------------------------------------------------------+
3019 https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
3021 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3022 |Interface Definition|Description |
3023 +====================+=======================================================================================================================+
3024 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id} |
3025 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3026 |Operation Type |DELETE |
3027 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3028 |Content-Type |application/json |
3029 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3033 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3034 |Attribute |Qualifier|Cardinality|Content |Description |
3035 +============================+=========+===========+==========================+==============================================================+
3036 |subnet_id |M |1 |String |The ID of the subnet. |
3037 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3042 https://developer.openstack.org/api-ref/networking/v2/#create-port
3044 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3045 |Interface Definition|Description |
3046 +====================+=======================================================================================================================+
3047 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports |
3048 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3049 |Operation Type |POST |
3050 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3051 |Content-Type |application/json |
3052 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3056 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3057 |Attribute |Qualifier|Cardinality|Content |Description |
3058 +============================+=========+===========+==========================+=================================================================================================+
3059 |port |M |1 |object |A port object. |
3060 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3061 |admin_state_up |O |1 |boolean |The administrative state of the resource. |
3062 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3063 |allowed_address_pairs |O |1 |array |A set of zero or more allowed address pairs. |
3064 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3065 |binding:host_id |O |1 |string |The ID of the host where the port resides. |
3066 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3067 |binding:profile |O |1 |string |A dictionary that enables the application running on the specific host |
3068 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3069 |binding:vnic_type |O |1 |string |The type of vNIC which this port should be attached to. |
3070 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3071 |description |O |1 |string |A human-readable description for the resource. |
3072 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3073 |device_id |O |1 |string |The ID of the device that uses this port. |
3074 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3075 |device_owner |O |1 |string |The entity type that uses this port. |
3076 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3077 |dns_domain |O |1 |string |A valid DNS domain. |
3078 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3079 |dns_name |O |1 |string |A valid DNS name. |
3080 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3081 |extra_dhcp_opts |O |1 |array |A set of zero or more extra DHCP option pairs. |
3082 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3083 |fixed_ips |O |1 |array |The IP addresses for the port. |
3084 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3085 |mac_address |O |1 |string |The MAC address of the port. |
3086 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3087 |name |O |1 |string |Human-readable name of the resource. |
3088 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3089 |network_id |M |1 |string |The ID of the attached network. |
3090 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3091 |port_security_enabled |O |1 |boolean |The port security status. |
3092 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3093 |project_id |O |1 |string |The ID of the project that owns the resource. |
3094 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3095 |qos_policy_id |O |1 |string |QoS policy associated with the port. |
3096 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3097 |security_groups |O |1 |array |The IDs of security groups applied to the port. |
3098 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3099 |tenant_id |O |1 |string |The ID of the project that owns the resource. |
3100 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3104 +-----------------------------+------------------+------------------------------------------------------------------------------+
3105 |Attribute |Content |Description |
3106 +=============================+==================+==============================================================================+
3107 |port |object |A port object. |
3108 +-----------------------------+------------------+------------------------------------------------------------------------------+
3109 |admin_state_up |boolean |The administrative state of the resource. |
3110 +-----------------------------+------------------+------------------------------------------------------------------------------+
3111 |allowed_address_pairs |array |A set of zero or more allowed address pairs. |
3112 +-----------------------------+------------------+------------------------------------------------------------------------------+
3113 |binding:host_id |string |The ID of the host where the port resides. |
3114 +-----------------------------+------------------+------------------------------------------------------------------------------+
3115 |binding:profile |String |A dictionary that enables the application running on the specific host |
3116 +-----------------------------+------------------+------------------------------------------------------------------------------+
3117 |binding:vif_details |object |A dictionary which contains additional information on the port. |
3118 +-----------------------------+------------------+------------------------------------------------------------------------------+
3119 |binding:vif_type |String |The type of which mechanism is used for the port. |
3120 +-----------------------------+------------------+------------------------------------------------------------------------------+
3121 |binding:vnic_type |string |The type of vNIC which this port should be attached to. |
3122 +-----------------------------+------------------+------------------------------------------------------------------------------+
3123 |created_at |string |Time at which port has been created. |
3124 +-----------------------------+------------------+------------------------------------------------------------------------------+
3125 |data_plane_status |string |Status of the underlying data plane of a port. |
3126 +-----------------------------+------------------+------------------------------------------------------------------------------+
3127 |description |string |A human-readable description for the resource. |
3128 +-----------------------------+------------------+------------------------------------------------------------------------------+
3129 |device_id |string |The ID of the device that uses this port. |
3130 +-----------------------------+------------------+------------------------------------------------------------------------------+
3131 |device_owner |string |The entity type that uses this port. |
3132 +-----------------------------+------------------+------------------------------------------------------------------------------+
3133 |dns_assignment |object |Data assigned to a port by the Networking internal DNS |
3134 +-----------------------------+------------------+------------------------------------------------------------------------------+
3135 |dns_domain |string |A valid DNS domain. |
3136 +-----------------------------+------------------+------------------------------------------------------------------------------+
3137 |dns_name |string |A valid DNS name. |
3138 +-----------------------------+------------------+------------------------------------------------------------------------------+
3139 |extra_dhcp_opts |array |A set of zero or more extra DHCP option pairs. |
3140 +-----------------------------+------------------+------------------------------------------------------------------------------+
3141 |fixed_ips |array |The IP addresses for the port. |
3142 +-----------------------------+------------------+------------------------------------------------------------------------------+
3143 |id |string |The ID of the resource. |
3144 +-----------------------------+------------------+------------------------------------------------------------------------------+
3145 |ip_allocation |string |Indicates when ports use either deferred, immediate or no IP allocation (none)|
3146 +-----------------------------+------------------+------------------------------------------------------------------------------+
3147 |mac_address |string |The MAC address of the port. |
3148 +-----------------------------+------------------+------------------------------------------------------------------------------+
3149 |name |string |Human-readable name of the resource. |
3150 +-----------------------------+------------------+------------------------------------------------------------------------------+
3151 |network_id |string |The ID of the attached network. |
3152 +-----------------------------+------------------+------------------------------------------------------------------------------+
3153 |port_security_enabled |boolean |The port security status. |
3154 +-----------------------------+------------------+------------------------------------------------------------------------------+
3155 |project_id |string |The ID of the project. |
3156 +-----------------------------+------------------+------------------------------------------------------------------------------+
3157 |revision_number |integer |The revision number of the resource. |
3158 +-----------------------------+------------------+------------------------------------------------------------------------------+
3159 |qos_policy_id |string |The ID of the QoS policy associated with the port. |
3160 +-----------------------------+------------------+------------------------------------------------------------------------------+
3161 |security_groups |array |The IDs of security groups applied to the port. |
3162 +-----------------------------+------------------+------------------------------------------------------------------------------+
3163 |status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. |
3164 +-----------------------------+------------------+------------------------------------------------------------------------------+
3165 |tenant_id |string |The ID of the project. |
3166 +-----------------------------+------------------+------------------------------------------------------------------------------+
3167 |updated_at |string |Time at which port has been updated. |
3168 +-----------------------------+------------------+------------------------------------------------------------------------------+
3173 https://developer.openstack.org/api-ref/network/v2/#delete-port
3175 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3176 |Interface Definition|Description |
3177 +====================+=======================================================================================================================+
3178 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id} |
3179 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3180 |Operation Type |DELETE |
3181 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3182 |Content-Type |application/json |
3183 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3187 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3188 |Attribute |Qualifier|Cardinality|Content |Description |
3189 +============================+=========+===========+==========================+==============================================================+
3190 |port_id |M |1 |String |The ID of the port. |
3191 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3193 Create Security Group
3194 ++++++++++++++++++++++
3196 https://developer.openstack.org/api-ref/network/v2/#create-security-group
3198 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3199 |Interface Definition|Description |
3200 +====================+=======================================================================================================================+
3201 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups |
3202 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3203 |Operation Type |POST |
3204 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3205 |Content-Type |application/json |
3206 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3210 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3211 |Attribute |Qualifier|Cardinality|Content |Description |
3212 +============================+=========+===========+==========================+==============================================================+
3213 |security_group |M |1 |object |A security_group object. |
3214 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3215 |tenant_id |M |1 |string |The ID of the project. |
3216 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3217 |project_id |M |1 |string |The ID of the project. |
3218 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3219 |description |O |1 |string |A human-readable description for the resource. |
3220 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3221 |name |M |1 |string |Human-readable name of the resource. |
3222 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3226 +-----------------------------+------------------+------------------------------------------------------------------------------+
3227 |Attribute |Content |Description |
3228 +=============================+==================+==============================================================================+
3229 |security_group |object |A security_group object. |
3230 +-----------------------------+------------------+------------------------------------------------------------------------------+
3231 |id |string |The ID of the security group. |
3232 +-----------------------------+------------------+------------------------------------------------------------------------------+
3233 |tenant_id |string |The ID of the project. |
3234 +-----------------------------+------------------+------------------------------------------------------------------------------+
3235 |project_id |string |The ID of the project. |
3236 +-----------------------------+------------------+------------------------------------------------------------------------------+
3237 |created_at |string |Time at which the resource has been created (in UTC ISO8601 format). |
3238 +-----------------------------+------------------+------------------------------------------------------------------------------+
3239 |updated_at |string |Time at which the resource has been updated (in UTC ISO8601 format). |
3240 +-----------------------------+------------------+------------------------------------------------------------------------------+
3241 |revision_number |integer |The revision number of the resource. |
3242 +-----------------------------+------------------+------------------------------------------------------------------------------+
3243 |name |string |Human-readable name of the resource. |
3244 +-----------------------------+------------------+------------------------------------------------------------------------------+
3245 |description |string |A human-readable description for the resource. |
3246 +-----------------------------+------------------+------------------------------------------------------------------------------+
3247 |security_group_rules |array |A list of security_group_rule objects. |
3248 +-----------------------------+------------------+------------------------------------------------------------------------------+
3250 Delete security group
3251 ++++++++++++++++++++++
3253 https://developer.openstack.org/api-ref/network/v2/#delete-security-group
3255 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3256 |Interface Definition|Description |
3257 +====================+=======================================================================================================================+
3258 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id} |
3259 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3260 |Operation Type |DELETE |
3261 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3262 |Content-Type |application/json |
3263 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3267 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3268 |Attribute |Qualifier|Cardinality|Content |Description |
3269 +============================+=========+===========+==========================+==============================================================+
3270 |security_group_id |M |1 |String |The ID of the security group. |
3271 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3273 Create Security Group Rule
3274 ++++++++++++++++++++++++++
3276 https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
3278 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3279 |Interface Definition|Description |
3280 +====================+=======================================================================================================================+
3281 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules |
3282 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3283 |Operation Type |POST |
3284 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3285 |Content-Type |application/json |
3286 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3290 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3291 |Attribute |Qualifier|Cardinality|Content |Description |
3292 +============================+=========+===========+==========================+================================================================================================+
3293 |security_group_rule |M |1 |object |A security_group_rule object. |
3294 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3295 |remote_group_id |O |1 |string |The remote group UUID to associate with this security group rule. |
3296 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3297 |direction |M |1 |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3298 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3299 |protocol |M |1 |string |The IP protocol can be represented by a string, an integer, or null. |
3300 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3301 |ethertype |O |1 |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3302 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3303 |port_range_max |O |1 |integer |The maximum port number in the range that is matched by the security group rule. |
3304 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3305 |security_group_id |M |1 |string |The security group ID to associate with this security group rule. |
3306 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3307 |port_range_min |O |1 |integer |The minimum port number in the range that is matched by the security group rule. |
3308 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3309 |remote_ip_prefix |M |1 |string |The remote IP prefix to associate with this metering rule packet. |
3310 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3311 |description |O |1 |string |A human-readable description for the resource. Default is an empty string. |
3312 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3316 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3317 |Attribute |Content |Description |
3318 +=============================+==================+=================================================================================================+
3319 |security_group_rule |object |A security_group_rule object. |
3320 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3321 |remote_group_id |string |The remote group UUID to associate with this security group rule. |
3322 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3323 |direction |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3324 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3325 |protocol |string |The IP protocol can be represented by a string, an integer, or null. |
3326 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3327 |ethertype |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3328 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3329 |port_range_max |integer |The maximum port number in the range that is matched by the security group rule. |
3330 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3331 |security_group_id |string |The security group ID to associate with this security group rule. |
3332 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3333 |tenant_id |string |The ID of the project. |
3334 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3335 |project_id |string |The ID of the project. |
3336 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3337 |port_range_min |integer |The minimum port number in the range that is matched by the security group rule. |
3338 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3339 |remote_ip_prefix |string |The remote IP prefix to associate with this metering rule packet. |
3340 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3341 |revision_number |integer |The revision number of the resource. |
3342 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3343 |id |string |The ID of the security group rule. |
3344 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3345 |description |string |A human-readable description for the resource. |
3346 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3348 Delete security group
3349 ++++++++++++++++++++++
3351 https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
3353 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3354 |Interface Definition|Description |
3355 +====================+=================================================================================================================================+
3356 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id} |
3357 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3358 |Operation Type |DELETE |
3359 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3360 |Content-Type |application/json |
3361 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3365 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3366 |Attribute |Qualifier|Cardinality|Content |Description |
3367 +============================+=========+===========+==========================+==============================================================+
3368 |security_group_rule_id |M |1 |String |The ID of the security group rule. |
3369 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3374 Create a dictionary item
3375 ++++++++++++++++++++++++
3377 +--------------------+--------------------------+
3378 |Interface Definition|Description |
3379 +====================+==========================+
3380 |URI |/createDictionaryItem |
3381 +--------------------+--------------------------+
3382 |Operation Type |PUT |
3383 +--------------------+--------------------------+
3387 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3388 |Attribute |Qualifier|Cardinality|Content|Description |
3389 +===================+=========+===========+=======+=============================================================+
3390 |dictionory |M |1 |String | |
3391 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3392 |dictionaryJson |M |1 |String | |
3393 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3394 |dictionaryType |M |1 |String | |
3395 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3396 |requestId |M |1 |String | |
3397 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3401 +-------------------+---------+-----------------------------------------------------------------------------------------+
3402 |Header Name |Qualifier|Description |
3403 +===================+=========+=========================================================================================+
3404 |ClientAuth |Y |encoded client authentication details |
3405 +-------------------+---------+-----------------------------------------------------------------------------------------+
3406 |X-ECOMP-RequestID |N |Request ID to track the requests |
3407 +-------------------+---------+-----------------------------------------------------------------------------------------+
3408 |Environment |Y |execution environments |
3409 +-------------------+---------+-----------------------------------------------------------------------------------------+
3410 |Authorization |Y |Base64 encoded username:password |
3411 +-------------------+---------+-----------------------------------------------------------------------------------------+
3415 +------------------+---------------------+
3416 |HTTP CODE |Description |
3417 +==================+=====================+
3419 +------------------+---------------------+
3420 |400 |Invalid Request |
3421 +------------------+---------------------+
3422 |401 |Unauthorized |
3423 +------------------+---------------------+
3425 +------------------+---------------------+
3430 +--------------------+--------------------------+
3431 |Interface Definition|Description |
3432 +====================+==========================+
3433 |URI |/createPolicy |
3434 +--------------------+--------------------------+
3435 |Operation Type |PUT |
3436 +--------------------+--------------------------+
3440 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3441 |Attribute |Qualifier|Cardinality|Content|Description |
3442 +===================+=========+===========+=======+=============================================================+
3443 |attributes |M |1 |Object |set of attributes in key value pair |
3444 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3445 |configBody |M |1 |String | |
3446 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3447 |configBodyType |M |1 |String | |
3448 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3449 |configName |M |1 |String | |
3450 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3451 |ecompName |M |1 |String | |
3452 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3453 |policyClass |M |1 |String | |
3454 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3455 |policyConfigType |M |1 |String | |
3456 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3457 |policyDescription |M |1 |String | |
3458 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3459 |policyName |M |1 |String | |
3460 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3461 |requestID |M |1 |String |request ID |
3462 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3466 +-------------------+---------+-----------------------------------------------------------------------------------------+
3467 |Header Name |Qualifier|Description |
3468 +===================+=========+=========================================================================================+
3469 |ClientAuth |Y |encoded client authentication details |
3470 +-------------------+---------+-----------------------------------------------------------------------------------------+
3471 |X-ECOMP-RequestID |N |Request ID to track the requests |
3472 +-------------------+---------+-----------------------------------------------------------------------------------------+
3473 |Environment |Y |execution environments |
3474 +-------------------+---------+-----------------------------------------------------------------------------------------+
3475 |Authorization |Y |Base64 encoded username:password |
3476 +-------------------+---------+-----------------------------------------------------------------------------------------+
3480 +------------------+---------------------+
3481 |HTTP CODE |Description |
3482 +==================+=====================+
3484 +------------------+---------------------+
3485 |400 |Invalid Request |
3486 +------------------+---------------------+
3487 |401 |Unauthorized |
3488 +------------------+---------------------+
3490 +------------------+---------------------+
3495 +--------------------+--------------------------+
3496 |Interface Definition|Description |
3497 +====================+==========================+
3498 |URI |/deletePolicy |
3499 +--------------------+--------------------------+
3500 |Operation Type |DELETE |
3501 +--------------------+--------------------------+
3505 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3506 |Attribute |Qualifier|Cardinality|Content|Description |
3507 +===================+=========+===========+=======+=============================================================+
3508 |deleteCondition |M |1 |String | |
3509 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3510 |pdpGroup |M |1 |String | |
3511 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3512 |policyComponent |M |1 |String | |
3513 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3514 |policyName |M |1 |String | |
3515 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3516 |policyType |M |1 |String | |
3517 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3518 |requestID |M |1 |String |request ID |
3519 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3523 +-------------------+---------+-----------------------------------------------------------------------------------------+
3524 |Header Name |Qualifier|Description |
3525 +===================+=========+=========================================================================================+
3526 |ClientAuth |Y |encoded client authentication details |
3527 +-------------------+---------+-----------------------------------------------------------------------------------------+
3528 |X-ECOMP-RequestID |N |Request ID to track the requests |
3529 +-------------------+---------+-----------------------------------------------------------------------------------------+
3530 |Environment |Y |execution environments |
3531 +-------------------+---------+-----------------------------------------------------------------------------------------+
3532 |Authorization |Y |Base64 encoded username:password |
3533 +-------------------+---------+-----------------------------------------------------------------------------------------+
3537 +------------------+---------------------+
3538 |HTTP CODE |Description |
3539 +==================+=====================+
3541 +------------------+---------------------+
3542 |400 |Invalid Request |
3543 +------------------+---------------------+
3544 |401 |Unauthorized |
3545 +------------------+---------------------+
3547 +------------------+---------------------+
3552 +--------------------+--------------------------+
3553 |Interface Definition|Description |
3554 +====================+==========================+
3556 +--------------------+--------------------------+
3557 |Operation Type |POST |
3558 +--------------------+--------------------------+
3562 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3563 |Attribute |Qualifier|Cardinality|Content|Description |
3564 +===================+=========+===========+=======+=============================================================+
3565 |configAttributes |M |1 |String | |
3566 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3567 |configName |M |1 |String | |
3568 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3569 |ecompName |M |1 |String | |
3570 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3571 |policyName |M |1 |String | |
3572 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3573 |unique |M |1 |Boolean| |
3574 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3575 |requestID |M |1 |String |request ID |
3576 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3580 +-------------------+---------+-----------------------------------------------------------------------------------------+
3581 |Header Name |Qualifier|Description |
3582 +===================+=========+=========================================================================================+
3583 |ClientAuth |Y |encoded client authentication details |
3584 +-------------------+---------+-----------------------------------------------------------------------------------------+
3585 |X-ECOMP-RequestID |N |Request ID to track the requests |
3586 +-------------------+---------+-----------------------------------------------------------------------------------------+
3587 |Environment |Y |execution environments |
3588 +-------------------+---------+-----------------------------------------------------------------------------------------+
3589 |Authorization |Y |Base64 encoded username:password |
3590 +-------------------+---------+-----------------------------------------------------------------------------------------+
3594 +------------------+---------------------+
3595 |HTTP CODE |Description |
3596 +==================+=====================+
3598 +------------------+---------------------+
3599 |400 |Invalid Request |
3600 +------------------+---------------------+
3601 |401 |Unauthorized |
3602 +------------------+---------------------+
3604 +------------------+---------------------+
3609 +--------------------+--------------------------+
3610 |Interface Definition|Description |
3611 +====================+==========================+
3612 |URI |/getDecision |
3613 +--------------------+--------------------------+
3614 |Operation Type |POST |
3615 +--------------------+--------------------------+
3619 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3620 |Attribute |Qualifier|Cardinality|Content|Description |
3621 +===================+=========+===========+=======+=============================================================+
3622 |decisionAttributes |M |1 |Object | |
3623 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3624 |ecompComponentName |M |1 |String | |
3625 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3626 |requestID |M |1 |String |request ID |
3627 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3631 +-------------------+---------+-----------------------------------------------------------------------------------------+
3632 |Header Name |Qualifier|Description |
3633 +===================+=========+=========================================================================================+
3634 |ClientAuth |Y |encoded client authentication details |
3635 +-------------------+---------+-----------------------------------------------------------------------------------------+
3636 |X-ECOMP-RequestID |N |Request ID to track the requests |
3637 +-------------------+---------+-----------------------------------------------------------------------------------------+
3638 |Environment |Y |execution environments |
3639 +-------------------+---------+-----------------------------------------------------------------------------------------+
3640 |Authorization |Y |Base64 encoded username:password |
3641 +-------------------+---------+-----------------------------------------------------------------------------------------+
3645 +------------------+---------------------+
3646 |HTTP CODE |Description |
3647 +==================+=====================+
3649 +------------------+---------------------+
3650 |400 |Invalid Request |
3651 +------------------+---------------------+
3652 |401 |Unauthorized |
3653 +------------------+---------------------+
3655 +------------------+---------------------+
3657 Response Parameters:
3659 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3660 |Attribute |Qualifier|Cardinality|Content|Description |
3661 +===================+=========+===========+=======+=============================================================+
3662 |decision |N |1 |String | |
3663 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3664 |details |N |1 |String | |
3665 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3667 Get Dictionary Items
3668 ++++++++++++++++++++
3670 +--------------------+--------------------------+
3671 |Interface Definition|Description |
3672 +====================+==========================+
3673 |URI |/getDictionaryItems |
3674 +--------------------+--------------------------+
3675 |Operation Type |POST |
3676 +--------------------+--------------------------+
3680 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3681 |Attribute |Qualifier|Cardinality|Content|Description |
3682 +===================+=========+===========+=======+=============================================================+
3683 |dictionary |N |1 |String | |
3684 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3685 |dictionaryJson |N |1 |String | |
3686 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3687 |dictionaryType |N |1 |String | |
3688 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3689 |requestID |M |1 |String |request ID |
3690 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3694 +-------------------+---------+-----------------------------------------------------------------------------------------+
3695 |Header Name |Qualifier|Description |
3696 +===================+=========+=========================================================================================+
3697 |ClientAuth |Y |encoded client authentication details |
3698 +-------------------+---------+-----------------------------------------------------------------------------------------+
3699 |X-ECOMP-RequestID |N |Request ID to track the requests |
3700 +-------------------+---------+-----------------------------------------------------------------------------------------+
3701 |Environment |Y |execution environments |
3702 +-------------------+---------+-----------------------------------------------------------------------------------------+
3703 |Authorization |Y |Base64 encoded username:password |
3704 +-------------------+---------+-----------------------------------------------------------------------------------------+
3708 +------------------+---------------------+
3709 |HTTP CODE |Description |
3710 +==================+=====================+
3712 +------------------+---------------------+
3713 |400 |Invalid Request |
3714 +------------------+---------------------+
3715 |401 |Unauthorized |
3716 +------------------+---------------------+
3718 +------------------+---------------------+
3720 Response Parameters:
3722 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3723 |Attribute |Qualifier|Cardinality|Content|Description |
3724 +===================+=========+===========+=======+=============================================================+
3725 |dictionaryData |N |1 |Object | |
3726 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3727 |dictionaryJson |N |1 |Object | |
3728 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3729 |responseCode |N |1 |Integer| |
3730 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3731 |responseMessage |N |1 |Object | |
3732 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3737 +--------------------+--------------------------+
3738 |Interface Definition|Description |
3739 +====================+==========================+
3741 +--------------------+--------------------------+
3742 |Operation Type |GET |
3743 +--------------------+--------------------------+
3747 +-------------------+---------+-----------------------------------------------------------------------------------------+
3748 |Header Name |Qualifier|Description |
3749 +===================+=========+=========================================================================================+
3750 |ClientAuth |Y |encoded client authentication details |
3751 +-------------------+---------+-----------------------------------------------------------------------------------------+
3752 |X-ECOMP-RequestID |N |Request ID to track the requests |
3753 +-------------------+---------+-----------------------------------------------------------------------------------------+
3754 |Environment |Y |execution environments |
3755 +-------------------+---------+-----------------------------------------------------------------------------------------+
3756 |Authorization |Y |Base64 encoded username:password |
3757 +-------------------+---------+-----------------------------------------------------------------------------------------+
3761 +------------------+---------------------+
3762 |HTTP CODE |Description |
3763 +==================+=====================+
3765 +------------------+---------------------+
3766 |400 |Invalid Request |
3767 +------------------+---------------------+
3768 |401 |Unauthorized |
3769 +------------------+---------------------+
3771 +------------------+---------------------+
3773 Response Parameters:
3775 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3776 |Attribute |Qualifier|Cardinality|Content|Description |
3777 +===================+=========+===========+=======+=============================================================+
3778 |metricsTotal |N |1 |Integer| |
3779 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3780 |papMetrics |N |1 |Integer| |
3781 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3782 |pdpMetrics |N |1 |Integer| |
3783 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3784 |responseCode |N |1 |Object | |
3785 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3786 |responseMessage |N |1 |String | |
3787 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3792 +--------------------+--------------------------+
3793 |Interface Definition|Description |
3794 +====================+==========================+
3795 |URI |/getNotification |
3796 +--------------------+--------------------------+
3797 |Operation Type |POST |
3798 +--------------------+--------------------------+
3802 +-------------------+---------+-----------------------------------------------------------------------------------------+
3803 |Header Name |Qualifier|Description |
3804 +===================+=========+=========================================================================================+
3805 |ClientAuth |Y |encoded client authentication details |
3806 +-------------------+---------+-----------------------------------------------------------------------------------------+
3807 |X-ECOMP-RequestID |N |Request ID to track the requests |
3808 +-------------------+---------+-----------------------------------------------------------------------------------------+
3809 |Environment |Y |execution environments |
3810 +-------------------+---------+-----------------------------------------------------------------------------------------+
3811 |Authorization |Y |Base64 encoded username:password |
3812 +-------------------+---------+-----------------------------------------------------------------------------------------+
3816 +------------------+---------------------+
3817 |HTTP CODE |Description |
3818 +==================+=====================+
3820 +------------------+---------------------+
3821 |400 |Invalid Request |
3822 +------------------+---------------------+
3823 |401 |Unauthorized |
3824 +------------------+---------------------+
3826 +------------------+---------------------+
3828 Response Parameters:
3830 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3831 |Attribute |Qualifier|Cardinality|Content|Description |
3832 +===================+=========+===========+=======+=============================================================+
3833 |metricsTotal |N |1 |Integer| |
3834 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3835 |papMetrics |N |1 |Integer| |
3836 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3837 |pdpMetrics |N |1 |Integer| |
3838 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3839 |responseCode |N |1 |Object | |
3840 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3841 |responseMessage |N |1 |String | |
3842 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3847 +--------------------+--------------------------+
3848 |Interface Definition|Description |
3849 +====================+==========================+
3850 |URI |/listConfiguration |
3851 +--------------------+--------------------------+
3852 |Operation Type |POST |
3853 +--------------------+--------------------------+
3857 +-------------------+---------+-----------------------------------------------------------------------------------------+
3858 |Header Name |Qualifier|Description |
3859 +===================+=========+=========================================================================================+
3860 |ClientAuth |Y |encoded client authentication details |
3861 +-------------------+---------+-----------------------------------------------------------------------------------------+
3862 |X-ECOMP-RequestID |N |Request ID to track the requests |
3863 +-------------------+---------+-----------------------------------------------------------------------------------------+
3864 |Environment |Y |execution environments |
3865 +-------------------+---------+-----------------------------------------------------------------------------------------+
3866 |Authorization |Y |Base64 encoded username:password |
3867 +-------------------+---------+-----------------------------------------------------------------------------------------+
3871 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3872 |Attribute |Qualifier|Cardinality|Content|Description |
3873 +===================+=========+===========+=======+=============================================================+
3874 |configAttributes |N |1 |Object | |
3875 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3876 |configName |N |1 |String | |
3877 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3878 |ecompName |N |1 |String | |
3879 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3880 |policyName |N |1 |String | |
3881 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3882 |requestID |N |1 |String | |
3883 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3884 |unique |N |1 |Boolean| |
3885 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3889 +------------------+---------------------+
3890 |HTTP CODE |Description |
3891 +==================+=====================+
3893 +------------------+---------------------+
3894 |400 |Invalid Request |
3895 +------------------+---------------------+
3896 |401 |Unauthorized |
3897 +------------------+---------------------+
3899 +------------------+---------------------+
3904 +--------------------+--------------------------+
3905 |Interface Definition|Description |
3906 +====================+==========================+
3907 |URI |/policyEngineImport |
3908 +--------------------+--------------------------+
3909 |Operation Type |POST |
3910 +--------------------+--------------------------+
3914 +-------------------+---------+-----------------------------------------------------------------------------------------+
3915 |Header Name |Qualifier|Description |
3916 +===================+=========+=========================================================================================+
3917 |ClientAuth |Y |encoded client authentication details |
3918 +-------------------+---------+-----------------------------------------------------------------------------------------+
3919 |X-ECOMP-RequestID |N |Request ID to track the requests |
3920 +-------------------+---------+-----------------------------------------------------------------------------------------+
3921 |Environment |Y |execution environments |
3922 +-------------------+---------+-----------------------------------------------------------------------------------------+
3923 |Authorization |Y |Base64 encoded username:password |
3924 +-------------------+---------+-----------------------------------------------------------------------------------------+
3928 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3929 |Attribute |Qualifier|Cardinality|Content|Description |
3930 +===================+=========+===========+=======+=============================================================+
3931 |importParameterJson|Y |1 |String | |
3932 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3933 |file |Y |1 |File | |
3934 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3938 +------------------+---------------------+
3939 |HTTP CODE |Description |
3940 +==================+=====================+
3942 +------------------+---------------------+
3943 |400 |Invalid Request |
3944 +------------------+---------------------+
3945 |401 |Unauthorized |
3946 +------------------+---------------------+
3948 +------------------+---------------------+
3953 +--------------------+--------------------------+
3954 |Interface Definition|Description |
3955 +====================+==========================+
3957 +--------------------+--------------------------+
3958 |Operation Type |PUT |
3959 +--------------------+--------------------------+
3963 +-------------------+---------+-----------------------------------------------------------------------------------------+
3964 |Header Name |Qualifier|Description |
3965 +===================+=========+=========================================================================================+
3966 |ClientAuth |Y |encoded client authentication details |
3967 +-------------------+---------+-----------------------------------------------------------------------------------------+
3968 |X-ECOMP-RequestID |N |Request ID to track the requests |
3969 +-------------------+---------+-----------------------------------------------------------------------------------------+
3970 |Environment |Y |execution environments |
3971 +-------------------+---------+-----------------------------------------------------------------------------------------+
3972 |Authorization |Y |Base64 encoded username:password |
3973 +-------------------+---------+-----------------------------------------------------------------------------------------+
3977 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3978 |Attribute |Qualifier|Cardinality|Content|Description |
3979 +===================+=========+===========+=======+=============================================================+
3980 |pdpGroup |N |1 |String | |
3981 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3982 |policyName |N |1 |String | |
3983 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3984 |policyType |N |1 |String | |
3985 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3989 +------------------+---------------------+
3990 |HTTP CODE |Description |
3991 +==================+=====================+
3993 +------------------+---------------------+
3994 |400 |Invalid Request |
3995 +------------------+---------------------+
3996 |401 |Unauthorized |
3997 +------------------+---------------------+
3999 +------------------+---------------------+
4004 +--------------------+--------------------------+
4005 |Interface Definition|Description |
4006 +====================+==========================+
4008 +--------------------+--------------------------+
4009 |Operation Type |POST |
4010 +--------------------+--------------------------+
4014 +-------------------+---------+-----------------------------------------------------------------------------------------+
4015 |Header Name |Qualifier|Description |
4016 +===================+=========+=========================================================================================+
4017 |ClientAuth |Y |encoded client authentication details |
4018 +-------------------+---------+-----------------------------------------------------------------------------------------+
4019 |X-ECOMP-RequestID |N |Request ID to track the requests |
4020 +-------------------+---------+-----------------------------------------------------------------------------------------+
4021 |Environment |Y |execution environments |
4022 +-------------------+---------+-----------------------------------------------------------------------------------------+
4023 |Authorization |Y |Base64 encoded username:password |
4024 +-------------------+---------+-----------------------------------------------------------------------------------------+
4028 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4029 |Attribute |Qualifier|Cardinality|Content|Description |
4030 +===================+=========+===========+=======+=============================================================+
4031 |eventAttributes |N |1 |Object | |
4032 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4033 |requestID |N |1 |String | |
4034 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4038 +------------------+---------------------+
4039 |HTTP CODE |Description |
4040 +==================+=====================+
4042 +------------------+---------------------+
4043 |400 |Invalid Request |
4044 +------------------+---------------------+
4045 |401 |Unauthorized |
4046 +------------------+---------------------+
4048 +------------------+---------------------+
4053 +--------------------+--------------------------+
4054 |Interface Definition|Description |
4055 +====================+==========================+
4057 +--------------------+--------------------------+
4058 |Operation Type |POST |
4059 +--------------------+--------------------------+
4063 +-------------------+---------+-----------------------------------------------------------------------------------------+
4064 |Header Name |Qualifier|Description |
4065 +===================+=========+=========================================================================================+
4066 |ClientAuth |Y |encoded client authentication details |
4067 +-------------------+---------+-----------------------------------------------------------------------------------------+
4068 |X-ECOMP-RequestID |N |Request ID to track the requests |
4069 +-------------------+---------+-----------------------------------------------------------------------------------------+
4070 |Environment |Y |execution environments |
4071 +-------------------+---------+-----------------------------------------------------------------------------------------+
4072 |Authorization |Y |Base64 encoded username:password |
4073 +-------------------+---------+-----------------------------------------------------------------------------------------+
4077 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4078 |Attribute |Qualifier|Cardinality|Content|Description |
4079 +===================+=========+===========+=======+=============================================================+
4080 |notificationTopic |Y |1 |String | |
4081 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4085 +------------------+---------------------+
4086 |HTTP CODE |Description |
4087 +==================+=====================+
4089 +------------------+---------------------+
4090 |400 |Invalid Request |
4091 +------------------+---------------------+
4092 |401 |Unauthorized |
4093 +------------------+---------------------+
4095 +------------------+---------------------+
4100 +--------------------+--------------------------+
4101 |Interface Definition|Description |
4102 +====================+==========================+
4103 |URI |/stopNotification |
4104 +--------------------+--------------------------+
4105 |Operation Type |POST |
4106 +--------------------+--------------------------+
4110 +-------------------+---------+-----------------------------------------------------------------------------------------+
4111 |Header Name |Qualifier|Description |
4112 +===================+=========+=========================================================================================+
4113 |ClientAuth |Y |encoded client authentication details |
4114 +-------------------+---------+-----------------------------------------------------------------------------------------+
4115 |X-ECOMP-RequestID |N |Request ID to track the requests |
4116 +-------------------+---------+-----------------------------------------------------------------------------------------+
4117 |Environment |Y |execution environments |
4118 +-------------------+---------+-----------------------------------------------------------------------------------------+
4119 |Authorization |Y |Base64 encoded username:password |
4120 +-------------------+---------+-----------------------------------------------------------------------------------------+
4124 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4125 |Attribute |Qualifier|Cardinality|Content|Description |
4126 +===================+=========+===========+=======+=============================================================+
4127 |notificationTopic |Y |1 |String | |
4128 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4132 +------------------+---------------------+
4133 |HTTP CODE |Description |
4134 +==================+=====================+
4136 +------------------+---------------------+
4137 |400 |Invalid Request |
4138 +------------------+---------------------+
4139 |401 |Unauthorized |
4140 +------------------+---------------------+
4142 +------------------+---------------------+
4147 +--------------------+--------------------------+
4148 |Interface Definition|Description |
4149 +====================+==========================+
4150 |URI |/updateDictionaryItem |
4151 +--------------------+--------------------------+
4152 |Operation Type |PUT |
4153 +--------------------+--------------------------+
4157 +-------------------+---------+-----------------------------------------------------------------------------------------+
4158 |Header Name |Qualifier|Description |
4159 +===================+=========+=========================================================================================+
4160 |ClientAuth |Y |encoded client authentication details |
4161 +-------------------+---------+-----------------------------------------------------------------------------------------+
4162 |X-ECOMP-RequestID |N |Request ID to track the requests |
4163 +-------------------+---------+-----------------------------------------------------------------------------------------+
4164 |Environment |Y |execution environments |
4165 +-------------------+---------+-----------------------------------------------------------------------------------------+
4166 |Authorization |Y |Base64 encoded username:password |
4167 +-------------------+---------+-----------------------------------------------------------------------------------------+
4171 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4172 |Attribute |Qualifier|Cardinality|Content|Description |
4173 +===================+=========+===========+=======+=============================================================+
4174 |dictionary |N |1 |String | |
4175 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4176 |dictionaryJson |N |1 |String | |
4177 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4178 |dictionaryType |N |1 |String | |
4179 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4180 |requestID |N |1 |String | |
4181 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4185 +------------------+---------------------+
4186 |HTTP CODE |Description |
4187 +==================+=====================+
4189 +------------------+---------------------+
4190 |400 |Invalid Request |
4191 +------------------+---------------------+
4192 |401 |Unauthorized |
4193 +------------------+---------------------+
4195 +------------------+---------------------+
4200 +--------------------+--------------------------+
4201 |Interface Definition|Description |
4202 +====================+==========================+
4203 |URI |/updatePolicy |
4204 +--------------------+--------------------------+
4205 |Operation Type |PUT |
4206 +--------------------+--------------------------+
4210 +-------------------+---------+-----------------------------------------------------------------------------------------+
4211 |Header Name |Qualifier|Description |
4212 +===================+=========+=========================================================================================+
4213 |ClientAuth |Y |encoded client authentication details |
4214 +-------------------+---------+-----------------------------------------------------------------------------------------+
4215 |X-ECOMP-RequestID |N |Request ID to track the requests |
4216 +-------------------+---------+-----------------------------------------------------------------------------------------+
4217 |Environment |Y |execution environments |
4218 +-------------------+---------+-----------------------------------------------------------------------------------------+
4219 |Authorization |Y |Base64 encoded username:password |
4220 +-------------------+---------+-----------------------------------------------------------------------------------------+
4224 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4225 |Attribute |Qualifier|Cardinality|Content|Description |
4226 +===================+=========+===========+=======+=============================================================+
4227 |attributes |N |1 |Object | |
4228 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4229 |configBody |N |1 |String | |
4230 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4231 |configBodyType |N |1 |String | |
4232 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4233 |configName |N |1 |String | |
4234 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4235 |ecompName |N |1 |String | |
4236 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4237 |policyClass |N |1 |String | |
4238 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4239 |policyConfigType |N |1 |String | |
4240 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4241 |policyDescription |N |1 |String | |
4242 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4243 |policyName |N |1 |String | |
4244 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4245 |requestID |N |1 |String | |
4246 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4250 +------------------+---------------------+
4251 |HTTP CODE |Description |
4252 +==================+=====================+
4254 +------------------+---------------------+
4255 |400 |Invalid Request |
4256 +------------------+---------------------+
4257 |401 |Unauthorized |
4258 +------------------+---------------------+
4260 +------------------+---------------------+
Code Review / so.git / blob