1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Huawei Technologies Co., Ltd.
6 ================================
8 .. image:: ../images/SO_1.png
15 Create service instance
16 ++++++++++++++++++++++++
18 +--------------------+-------------------------------------+
19 |Interface Definition|Description |
20 +====================+=====================================+
21 |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6 |
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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6/{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 |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6 |
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 |/onap/so/infra/serviceInstantiation/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 |name |String |Service instance name. |
1775 +------------------------------+-----------------+------------------------------------+
1776 |description |String |Service instance description |
1777 +------------------------------+-----------------+------------------------------------+
1778 |serviceUuid |String |Model UUID |
1779 +------------------------------+-----------------+------------------------------------+
1780 |serviceInvariantUuid |String |Model Invariant UUID |
1781 +------------------------------+-----------------+------------------------------------+
1782 |gloabalSubscriberId |String |Customer Id |
1783 +------------------------------+-----------------+------------------------------------+
1784 |serviceType |String |service Type |
1785 +------------------------------+-----------------+------------------------------------+
1786 |parameters |Object |Parameter Object |
1787 +------------------------------+-----------------+------------------------------------+
1791 +------------------------------+-----------------+------------------------------------+
1792 |Attribute |Content |Description |
1793 +==============================+=================+====================================+
1794 |locationConstraints |List of object |location infor for each vnf |
1795 +------------------------------+-----------------+------------------------------------+
1796 |resource |List of Resource |resource of service/resource |
1797 +------------------------------+-----------------+------------------------------------+
1798 |requestInputs |key-value map |input of service/resource
1799 +------------------------------+-----------------+------------------------------------+
1801 LocationConstraint Object
1803 +------------------------------+-----------------+------------------------------------+
1804 |Attribute |Content |Description |
1805 +==============================+=================+====================================+
1806 |vnfProfileId |String |Customization id for VNF |
1807 +------------------------------+-----------------+------------------------------------+
1808 |locationConstraints |Object |DC location info of VNF |
1809 +------------------------------+-----------------+------------------------------------+
1811 VnfLocationConstraint Object
1813 +------------------------------+-----------------+------------------------------------+
1814 |Attribute |Content |Description |
1815 +==============================+=================+====================================+
1816 |vimId |String |VIM id from ESR definition |
1817 +------------------------------+-----------------+------------------------------------+
1821 +------------------------------+-----------------+------------------------------------+
1822 |Attribute |Content |Description |
1823 +==============================+=================+====================================+
1824 |resourceName |String |The resource name |
1825 +------------------------------+-----------------+------------------------------------+
1826 |resourceInvariantUuid |String |The resource invariant UUID. |
1827 +------------------------------+-----------------+------------------------------------+
1828 |resourceUuid |String |The resource UUID. |
1829 +------------------------------+-----------------+------------------------------------+
1830 |resourceCustomizationUuid |String |The resource customization UUID. |
1831 +------------------------------+-----------------+------------------------------------+
1832 |parameters |Object |Parameter of resource |
1833 +------------------------------+-----------------+------------------------------------+
1837 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1838 |Attribute |Qualifier|Cardinality|Content|Description |
1839 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1840 |serviceId |M |1 |String |Service instance ID. |
1841 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1842 |operationId |M |1 |String |Service Operation ID. |
1843 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1845 Delete E2E service instance
1846 ++++++++++++++++++++++++++++
1848 +--------------------+-----------------------------------------------+
1849 |Interface Definition|Description |
1850 +====================+===============================================+
1851 |URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}|
1852 +--------------------+-----------------------------------------------+
1853 |Operation Type |DELETE |
1854 +--------------------+-----------------------------------------------+
1858 +-------------------+---------+-----------+-------+----------------------------------------+
1859 |Attribute |Qualifier|Cardinality|Content|Description |
1860 +===================+=========+===========+=======+========================================+
1861 |globalSubscriberId |M |1 |String |The subscriber id. It is defined in AAI |
1862 +-------------------+---------+-----------+-------+----------------------------------------+
1863 |serviceType |M |1 |String |The service type. It is defined in AAI |
1864 +-------------------+---------+-----------+-------+----------------------------------------+
1868 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1869 |Attribute |Qualifier|Cardinality|Content|Description |
1870 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1871 |operationId |M |1 |String |The operation id. |
1872 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1874 Query E2E service operation result
1875 ++++++++++++++++++++++++++
1877 +--------------------+------------------------------------------------------------------------+
1878 |Interface Definition|Description |
1879 +====================+========================================================================+
1880 |URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
1881 +--------------------+------------------------------------------------------------------------+
1882 |Operation Type |GET |
1883 +--------------------+------------------------------------------------------------------------+
1887 +--------------+---------+-----------+-------+--------------+
1888 |Attribute |Qualifier|Cardinality|Content|Description |
1889 +==============+=========+===========+=======+==============+
1890 |serviceId |M |1 |Service instance ID. |
1891 +--------------+---------+-----------+-------+--------------+
1892 |operationId |M |1 |Service Operation ID. |
1893 +--------------+---------+-----------+-------+--------------+
1897 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1898 |Attribute |Qualifier|Cardinality|Content|Description |
1899 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1900 |operation |M |1 |String |Operation object identify. |
1901 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1902 |operationId |M |1 |String |Operation ID. |
1903 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1904 |operation |M |1 |String |Operation type, create|delete. |
1905 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1906 |result |M |1 |String |Operation result: finished, error, processing. |
1907 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1908 |reason |M |1 |String |If failing, need to write fail reason. |
1909 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1910 |userId |M |1 |String |Operation user ID. |
1911 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1912 |operationContent |M |1 |String |The status detail of current operation which is being executing. |
1913 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1914 |progress |M |1 |String |Current operation progress. |
1915 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1916 |operateAt |M |1 |String |Time that it starts to execute operation. |
1917 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1918 |finishedAt |M |1 |String |Time that it finished executing operation. |
1919 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1924 create or update an existing service-instance
1925 +++++++++++++++++++++++++++++++++++++++++++++
1927 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1928 |Interface Definition|Description |
1929 +====================+====================================================================================================================================================================+
1930 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1931 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1932 |Operation Type |PUT |
1933 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1937 +-------------------+---------+-----------+-------+-----------------------+
1938 |Attribute |Qualifier|Cardinality|Content|Description |
1939 +===================+=========+===========+=======+=======================+
1940 |global-customer-id |M |1 |String |Global Customer ID |
1941 +-------------------+---------+-----------+-------+-----------------------+
1942 |service-type |M |1 |String |Service Type |
1943 +-------------------+---------+-----------+-------+-----------------------+
1944 |service-instance-id|M |1 |String |Service Instance ID |
1945 +-------------------+---------+-----------+-------+-----------------------+
1949 +---------+---------+-----------+-------+-------------------+
1950 |Attribute|Qualifier|Cardinality|Content|Description |
1951 +---------+---------+-----------+-------+-------------------+
1952 |HTTP code|M |1 |Integer|HTTP response code |
1953 +---------+---------+-----------+-------+-------------------+
1955 delete an existing service-instance
1956 +++++++++++++++++++++++++++++++++++
1958 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1959 |Interface Definition|Description |
1960 +====================+====================================================================================================================================================================+
1961 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1962 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1963 |Operation Type |DELETE |
1964 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1968 +-------------------+---------+-----------+-------+-----------------------+
1969 |Attribute |Qualifier|Cardinality|Content|Description |
1970 +===================+=========+===========+=======+=======================+
1971 |global-customer-id |M |1 |String |Global Customer ID |
1972 +-------------------+---------+-----------+-------+-----------------------+
1973 |service-type |M |1 |String |Service Type |
1974 +-------------------+---------+-----------+-------+-----------------------+
1975 |service-instance-id|M |1 |String |Service Instance ID |
1976 +-------------------+---------+-----------+-------+-----------------------+
1980 +---------+---------+-----------+-------+-------------------+
1981 |Attribute|Qualifier|Cardinality|Content|Description |
1982 +---------+---------+-----------+-------+-------------------+
1983 |HTTP code|M |1 |Integer|HTTP response code |
1984 +---------+---------+-----------+-------+-------------------+
1986 get service-instances
1987 +++++++++++++++++++++
1989 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1990 |Interface Definition|Description |
1991 +====================+=============================================================================================================================+
1992 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
1993 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1994 |Operation Type |GET |
1995 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1999 +-------------------+---------+-----------+-------+-----------------------+
2000 |Attribute |Qualifier|Cardinality|Content|Description |
2001 +===================+=========+===========+=======+=======================+
2002 |global-customer-id |M |1 |String |Global Customer ID |
2003 +-------------------+---------+-----------+-------+-----------------------+
2004 |service-type |M |1 |String |Service Type |
2005 +-------------------+---------+-----------+-------+-----------------------+
2006 |subscriber-name |O |1 |String |Subscriber name |
2007 +-------------------+---------+-----------+-------+-----------------------+
2008 |subscriber-type |O |1 |String |Subscriber type |
2009 +-------------------+---------+-----------+-------+-----------------------+
2013 +-----------------+---------+-----------+----------------+-------------------+
2014 |Attribute |Qualifier|Cardinality|Content |Description |
2015 +-----------------+---------+-----------+----------------+-------------------+
2016 |service-instances|M |1 |ServiceInstances|Service Instances |
2017 +-----------------+---------+-----------+----------------+-------------------+
2019 get service-instance
2020 ++++++++++++++++++++
2022 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2023 |Interface Definition|Description |
2024 +====================+====================================================================================================================================================================+
2025 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
2026 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2027 |Operation Type |GET |
2028 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2032 +-------------------+---------+-----------+-------+-----------------------+
2033 |Attribute |Qualifier|Cardinality|Content|Description |
2034 +===================+=========+===========+=======+=======================+
2035 |global-customer-id |M |1 |String |Global Customer ID |
2036 +-------------------+---------+-----------+-------+-----------------------+
2037 |service-type |M |1 |String |Service Type |
2038 +-------------------+---------+-----------+-------+-----------------------+
2039 |service-instance-id|M |1 |String |Service instance ID |
2040 +-------------------+---------+-----------+-------+-----------------------+
2044 +-----------------+---------+-----------+----------------+-------------------+
2045 |Attribute |Qualifier|Cardinality|Content |Description |
2046 +-----------------+---------+-----------+----------------+-------------------+
2047 |service-instance |M |1 |ServiceInstance |Service Instance |
2048 +-----------------+---------+-----------+----------------+-------------------+
2050 see node definition for valid relationships
2051 +++++++++++++++++++++++++++++++++++++++++++
2053 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2054 |Interface Definition|Description |
2055 +====================+===================================================================================================================================================================================================+
2056 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2057 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2058 |Operation Type |PUT |
2059 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2063 +-------------------+---------+-----------+-------+-----------------------+
2064 |Attribute |Qualifier|Cardinality|Content|Description |
2065 +===================+=========+===========+=======+=======================+
2066 |global-customer-id |M |1 |String |Global Customer ID |
2067 +-------------------+---------+-----------+-------+-----------------------+
2068 |service-type |M |1 |String |Service Type |
2069 +-------------------+---------+-----------+-------+-----------------------+
2070 |service-instance-id|M |1 |String |Service instance ID |
2071 +-------------------+---------+-----------+-------+-----------------------+
2075 +---------+---------+-----------+-------+-------------------+
2076 |Attribute|Qualifier|Cardinality|Content|Description |
2077 +---------+---------+-----------+-------+-------------------+
2078 |HTTP code|M |1 |Integer|HTTP response code |
2079 +---------+---------+-----------+-------+-------------------+
2081 delete an existing relationship
2082 +++++++++++++++++++++++++++++++
2084 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2085 |Interface Definition|Description |
2086 +====================+===================================================================================================================================================================================================+
2087 |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2088 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2089 |Operation Type |DELETE |
2090 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2094 +-------------------+---------+-----------+-------+-----------------------+
2095 |Attribute |Qualifier|Cardinality|Content|Description |
2096 +===================+=========+===========+=======+=======================+
2097 |global-customer-id |M |1 |String |Global Customer ID |
2098 +-------------------+---------+-----------+-------+-----------------------+
2099 |service-type |M |1 |String |Service Type |
2100 +-------------------+---------+-----------+-------+-----------------------+
2101 |service-instance-id|M |1 |String |Service instance ID |
2102 +-------------------+---------+-----------+-------+-----------------------+
2106 +---------+---------+-----------+-------+-------------------+
2107 |Attribute|Qualifier|Cardinality|Content|Description |
2108 +---------+---------+-----------+-------+-------------------+
2109 |HTTP code|M |1 |Integer|HTTP response code |
2110 +---------+---------+-----------+-------+-------------------+
2119 +--------------------+-------------------+
2120 |Interface Definition|Description |
2121 +====================+===================+
2123 +--------------------+-------------------+
2124 |Operation Type |POST |
2125 +--------------------+-------------------+
2126 |Content-Type |application/json |
2127 +--------------------+-------------------+
2131 +-------------------+---------+-----------+-------+-----------------------+
2132 |Attribute |Qualifier|Cardinality|Content|Description |
2133 +===================+=========+===========+=======+=======================+
2134 |context |M |1 |Object |Context |
2135 +-------------------+---------+-----------+-------+-----------------------+
2136 |csarId |M |1 |String |csarId |
2137 +-------------------+---------+-----------+-------+-----------------------+
2138 |nsName |M |1 |String |Name of the NS |
2139 +-------------------+---------+-----------+-------+-----------------------+
2140 |description |M |1 |String |description |
2141 +-------------------+---------+-----------+-------+-----------------------+
2145 +-----------------+---------+-----------+----------------+-------------------+
2146 |Attribute |Qualifier|Cardinality|Content |Description |
2147 +-----------------+---------+-----------+----------------+-------------------+
2148 |nsInstanceId |M |1 |String |nsInstanceId |
2149 +-----------------+---------+-----------+----------------+-------------------+
2154 +--------------------+-------------------+
2155 |Interface Definition|Description |
2156 +====================+===================+
2158 +--------------------+-------------------+
2159 |Operation Type |GET |
2160 +--------------------+-------------------+
2161 |Content-Type |application/json |
2162 +--------------------+-------------------+
2166 +-----------------+---------+-----------+----------------+-------------------+
2167 |Attribute |Qualifier|Cardinality|Content |Description |
2168 +-----------------+---------+-----------+----------------+-------------------+
2169 |nsInstanceId |M |1 |String |nsInstanceId |
2170 +-----------------+---------+-----------+----------------+-------------------+
2171 |nsName |M |1 |String |The name of ns |
2172 +-----------------+---------+-----------+----------------+-------------------+
2173 |description |M |1 |String |description |
2174 +-----------------+---------+-----------+----------------+-------------------+
2175 |nsdId |M |1 |String |ID of ns |
2176 +-----------------+---------+-----------+----------------+-------------------+
2177 |vnfInfo |M |1 |Array |Vnf information |
2178 +-----------------+---------+-----------+----------------+-------------------+
2179 |vlInfo |M |1 |Array |vl information |
2180 +-----------------+---------+-----------+----------------+-------------------+
2181 |vnffgInfo |M |1 |Array |vnffg information |
2182 +-----------------+---------+-----------+----------------+-------------------+
2183 |nsState |M |1 |String |state of ns |
2184 +-----------------+---------+-----------+----------------+-------------------+
2188 +-----------------+---------+-----------+----------------+-------------------+
2189 |Attribute |Qualifier|Cardinality|Content |Description |
2190 +-----------------+---------+-----------+----------------+-------------------+
2191 |vnfInstanceId |M |1 |String |vnfInstanceId |
2192 +-----------------+---------+-----------+----------------+-------------------+
2193 |vnfInstanceName |M |1 |String |vnfInstanceName |
2194 +-----------------+---------+-----------+----------------+-------------------+
2195 |vnfdId |M |1 |String |vnfdId |
2196 +-----------------+---------+-----------+----------------+-------------------+
2200 +----------------------+---------+-----------+----------------+-------------------+
2201 |Attribute |Qualifier|Cardinality|Content |Description |
2202 +----------------------+---------+-----------+----------------+-------------------+
2203 |vlInstanceId |M |1 |String |vlInstanceId |
2204 +----------------------+---------+-----------+----------------+-------------------+
2205 |vlInstanceName |M |1 |String |vlInstanceName |
2206 +----------------------+---------+-----------+----------------+-------------------+
2207 |vldId |M |1 |String |vldId |
2208 +----------------------+---------+-----------+----------------+-------------------+
2209 |relatedCpInstanceId |M |1 |Array |relatedCpInstanceId|
2210 +----------------------+---------+-----------+----------------+-------------------+
2212 relatedCpInstanceId Array:
2214 +----------------------+---------+-----------+----------------+-------------------+
2215 |Attribute |Qualifier|Cardinality|Content |Description |
2216 +----------------------+---------+-----------+----------------+-------------------+
2217 |cpInstanceId |M |1 |String |cpInstanceId |
2218 +----------------------+---------+-----------+----------------+-------------------+
2219 |cpInstanceName |M |1 |String |cpInstanceName |
2220 +----------------------+---------+-----------+----------------+-------------------+
2221 |cpdId |M |1 |String |cpdId |
2222 +----------------------+---------+-----------+----------------+-------------------+
2226 +----------------------+---------+-----------+----------------+-------------------+
2227 |Attribute |Qualifier|Cardinality|Content |Description |
2228 +----------------------+---------+-----------+----------------+-------------------+
2229 |vnffgInstanceId |M |1 |String |vnffgInstanceId |
2230 +----------------------+---------+-----------+----------------+-------------------+
2231 |vnfId |M |1 |String |vnfId |
2232 +----------------------+---------+-----------+----------------+-------------------+
2233 |pnfId |M |1 |String |pnfId |
2234 +----------------------+---------+-----------+----------------+-------------------+
2235 |virtualLinkId |M |1 |Array |virtualLinkId |
2236 +----------------------+---------+-----------+----------------+-------------------+
2237 |cpId |M |1 |Array |cpId |
2238 +----------------------+---------+-----------+----------------+-------------------+
2239 |nfp |M |1 |Array |nfp |
2240 +----------------------+---------+-----------+----------------+-------------------+
2245 +--------------------+-------------------------------------+
2246 |Interface Definition|Description |
2247 +====================+=====================================+
2248 |URI |/ns/{nsInstanceId}/Instantiate |
2249 +--------------------+-------------------------------------+
2250 |Operation Type |POST |
2251 +--------------------+-------------------------------------+
2252 |Content-Type |application/json |
2253 +--------------------+-------------------------------------+
2257 +----------------------+---------+-----------+-------+-----------------------+
2258 |Attribute |Qualifier|Cardinality|Content|Description |
2259 +======================+=========+===========+=======+=======================+
2260 |LocationConstraints |M |1 |Array |LocationConstraints |
2261 +----------------------+---------+-----------+-------+-----------------------+
2262 |additionalParamForNs |M |1 |String |additionalParamForNs |
2263 +----------------------+---------+-----------+-------+-----------------------+
2264 |nsInstanceId |M |1 |String |nsInstanceId |
2265 +----------------------+---------+-----------+-------+-----------------------+
2267 LocationConstraints Array:
2269 +----------------------+---------+-----------+-------+-----------------------+
2270 |Attribute |Qualifier|Cardinality|Content|Description |
2271 +======================+=========+===========+=======+=======================+
2272 |vnfProfileId |M |1 |String |vnfProfileId |
2273 +----------------------+---------+-----------+-------+-----------------------+
2274 |vimid |M |1 |String |vimid |
2275 +----------------------+---------+-----------+-------+-----------------------+
2279 +--------------+---------+-----------+-------+-----------------------+
2280 |Attribute |Qualifier|Cardinality|Content|Description |
2281 +==============+=========+===========+=======+=======================+
2282 |jobId |M |1 |String |jobId |
2283 +--------------+---------+-----------+-------+-----------------------+
2288 +--------------------+-------------------------------------+
2289 |Interface Definition|Description |
2290 +====================+=====================================+
2291 |URI |/ns/{ns_instance_id}/terminate |
2292 +--------------------+-------------------------------------+
2293 |Operation Type |POST |
2294 +--------------------+-------------------------------------+
2295 |Content-Type |application/json |
2296 +--------------------+-------------------------------------+
2300 +----------------------------+---------+-----------+-------+-----------------------------+
2301 |Attribute |Qualifier|Cardinality|Content|Description |
2302 +============================+=========+===========+=======+=============================+
2303 |terminationType |M |1 |String |terminationType |
2304 +----------------------------+---------+-----------+-------+-----------------------------+
2305 |gracefulTerminationTimeout |M |1 |String |gracefulTerminationTimeout |
2306 +----------------------------+---------+-----------+-------+-----------------------------+
2307 |nsInstanceId |M |1 |String |nsInstanceId |
2308 +----------------------------+---------+-----------+-------+-----------------------------+
2312 +--------------+---------+-----------+-------+-----------------------+
2313 |Attribute |Qualifier|Cardinality|Content|Description |
2314 +==============+=========+===========+=======+=======================+
2315 |jobId |M |1 |String |jobId |
2316 +--------------+---------+-----------+-------+-----------------------+
2321 +--------------------+-------------------------------------+
2322 |Interface Definition|Description |
2323 +====================+=====================================+
2324 |URI |/ns/{ns_instance_id} |
2325 +--------------------+-------------------------------------+
2326 |Operation Type |DELETE |
2327 +--------------------+-------------------------------------+
2331 +----------------------------+---------+-----------+-------+-----------------------------+
2332 |Attribute |Qualifier|Cardinality|Content|Description |
2333 +============================+=========+===========+=======+=============================+
2334 |nsInstanceId |M |1 |String |nsInstanceId |
2335 +----------------------------+---------+-----------+-------+-----------------------------+
2342 https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
2344 +--------------------+-----------------------------------------------------------------------------------------------+
2345 |Interface Definition|Description |
2346 +====================+===============================================================================================+
2347 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens |
2348 +--------------------+-----------------------------------------------------------------------------------------------+
2349 |Operation Type |POST |
2350 +--------------------+-----------------------------------------------------------------------------------------------+
2351 |Content-Type |application/json |
2352 +--------------------+-----------------------------------------------------------------------------------------------+
2356 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2357 |Attribute |Qualifier|Cardinality|Content |Description |
2358 +================+=========+===========+==========================+================================================================================================================================================+
2359 |nocatalog |O |1 |string |The authentication response excludes the service catalog. By default, the response includes the service catalog. |
2360 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2361 |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.|
2362 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2363 |auth |M |1 |object |An auth object. |
2364 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2365 |user |M |1 |object |A user object. |
2366 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2367 |scope |O |1 |string |The authorization scope, including either a project or a domain |
2368 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2369 |password |M |1 |object |The password object, contains the authentication information. |
2370 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2371 |id |O |1 |string |The ID of the user. Required if you do not specify the user name. |
2372 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2373 |identity |M |1 |object |An identity object. |
2374 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2375 |methods |M |1 |array |The authentication method. For password authentication, specify password. |
2376 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2380 +-------------------------+------------------+--------------------------------------------------------------------------+
2381 |Attribute |Content |Description |
2382 +=========================+==================+==========================================================================+
2383 |X-Subject-Token |String |The authentication token. |
2384 +-------------------------+------------------+--------------------------------------------------------------------------+
2385 |domain |object |A domain object, containing: |
2386 +-------------------------+------------------+--------------------------------------------------------------------------+
2387 |region_id |String |The ID of the region that contains the service endpoint. |
2388 +-------------------------+------------------+--------------------------------------------------------------------------+
2389 |methods |array |The authentication method. For password authentication, specify password. |
2390 +-------------------------+------------------+--------------------------------------------------------------------------+
2391 |roles |array |A list of role objects, each containing: |
2392 +-------------------------+------------------+--------------------------------------------------------------------------+
2393 |url |String |The endpoint URL. |
2394 +-------------------------+------------------+--------------------------------------------------------------------------+
2395 |region |String |The geographic location of the service endpoint. |
2396 +-------------------------+------------------+--------------------------------------------------------------------------+
2397 |token |object |A token object. |
2398 +-------------------------+------------------+--------------------------------------------------------------------------+
2399 |expires_at |String |The date and time when the token expires. |
2400 +-------------------------+------------------+--------------------------------------------------------------------------+
2401 |project |object |A project object, containing: |
2402 +-------------------------+------------------+--------------------------------------------------------------------------+
2403 |issued_at |String |The date and time when the token was issued. |
2404 +-------------------------+------------------+--------------------------------------------------------------------------+
2405 |catalog |array |A catalog object. |
2406 +-------------------------+------------------+--------------------------------------------------------------------------+
2407 |extras |object |A set of metadata key and value pairs, if any. |
2408 +-------------------------+------------------+--------------------------------------------------------------------------+
2409 |user |object |A user object. |
2410 +-------------------------+------------------+--------------------------------------------------------------------------+
2411 |audit_ids |array |A list of one or two audit IDs. |
2412 +-------------------------+------------------+--------------------------------------------------------------------------+
2413 |interface |String |The interface type, which describes the visibility of the endpoint. |
2414 +-------------------------+------------------+--------------------------------------------------------------------------+
2415 |endpoints |array |A list of endpoint objects. |
2416 +-------------------------+------------------+--------------------------------------------------------------------------+
2417 |type |String |The endpoint type. |
2418 +-------------------------+------------------+--------------------------------------------------------------------------+
2419 |id |String |The ID of the user. Required if you do not specify the user name. |
2420 +-------------------------+------------------+--------------------------------------------------------------------------+
2421 |name |String |The user name. |
2422 +-------------------------+------------------+--------------------------------------------------------------------------+
2427 https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
2429 +--------------------+-----------------------------------------------------------------------------------------------+
2430 |Interface Definition|Description |
2431 +====================+===============================================================================================+
2432 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks |
2433 +--------------------+-----------------------------------------------------------------------------------------------+
2434 |Operation Type |POST |
2435 +--------------------+-----------------------------------------------------------------------------------------------+
2436 |Content-Type |application/json |
2437 +--------------------+-----------------------------------------------------------------------------------------------+
2441 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2442 |Attribute |Qualifier|Cardinality|Content |Description |
2443 +==================+=========+===========+==========================+=================================================================================================+
2444 |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2445 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2446 |disable_rollback |O |1 |boolean |Enables or disables deletion of all stack resources when stack creation fails. |
2447 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2448 |environment |O |1 |object |A JSON environment for the stack. |
2449 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2450 |files |O |1 |object |Supplies the contents of files referenced in the template or the environment. |
2451 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2452 |parameters |O |1 |object |Supplies arguments for parameters defined in the stack template. |
2453 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2454 |stack_name |M |1 |string |A name for the stack. |
2455 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2456 |tags |O |1 |string |One or more simple string tags to associate with the stack. |
2457 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2458 |template |O |1 |object |The stack template on which to perform the operation. |
2459 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2460 |template_url |O |1 |string |A URI to the location containing the stack template on which to perform the operation. |
2461 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2462 |timeout_mins |O |1 |integer |The timeout for stack creation in minutes. |
2463 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2467 +-------------------------+------------------+--------------------------------------------------------------------------+
2468 |Attribute |Content |Description |
2469 +=========================+==================+==========================================================================+
2470 |location |String |For asynchronous resource operations. |
2471 +-------------------------+------------------+--------------------------------------------------------------------------+
2472 |X-Openstack-Reqeuest-Id |object |A domain object, containing: |
2473 +-------------------------+------------------+--------------------------------------------------------------------------+
2474 |stack |String |The ID of the region that contains the service endpoint. |
2475 +-------------------------+------------------+--------------------------------------------------------------------------+
2476 |id |String |The authentication method. For password authentication, specify password. |
2477 +-------------------------+------------------+--------------------------------------------------------------------------+
2478 |links |String |The authentication method. For password authentication, specify password. |
2479 +-------------------------+------------------+--------------------------------------------------------------------------+
2484 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2486 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2487 |Interface Definition|Description |
2488 +====================+=======================================================================================================================+
2489 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2490 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2491 |Operation Type |GET |
2492 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2493 |Content-Type |application/json |
2494 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2498 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2499 |Attribute |Qualifier|Cardinality|Content |Description |
2500 +==================+=========+===========+==========================+=================================================================================================+
2501 |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2502 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2503 |stack_name |M |1 |string |The name of a stack. |
2504 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2505 |stack_id |M |1 |string |The UUID of the stack. |
2506 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2507 |resolve_outputs |O |1 |boolean |A boolean indicating whether the outputs section of a stack should be resolved. |
2508 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2512 +-------------------------+------------------+------------------------------------------------------------------------------+
2513 |Attribute |Content |Description |
2514 +=========================+==================+==============================================================================+
2515 |X-Openstack-Reqeuest-Id |String |A unique ID for tracking service request. |
2516 +-------------------------+------------------+------------------------------------------------------------------------------+
2517 |stack |Object |The stack object. |
2518 +-------------------------+------------------+------------------------------------------------------------------------------+
2519 |capabilities |array |List of stack capabilities for stack. |
2520 +-------------------------+------------------+------------------------------------------------------------------------------+
2521 |creation_time |String |The date and time when the resource was created. |
2522 +-------------------------+------------------+------------------------------------------------------------------------------+
2523 |deletion_time |String |The date and time when the resource was (soft-) deleted. |
2524 +-------------------------+------------------+------------------------------------------------------------------------------+
2525 |description |String |The description of the stack resource. |
2526 +-------------------------+------------------+------------------------------------------------------------------------------+
2527 |disable_rollback |boolean |Whether deletion of all stack resources when stack creation fails is enabled. |
2528 +-------------------------+------------------+------------------------------------------------------------------------------+
2529 |id |String |The UUID of the stack. |
2530 +-------------------------+------------------+------------------------------------------------------------------------------+
2531 |links |array |A list of URLs for the stack. |
2532 +-------------------------+------------------+------------------------------------------------------------------------------+
2533 |notification_topics |array |List of notification topics for stack. |
2534 +-------------------------+------------------+------------------------------------------------------------------------------+
2535 |outputs |array |A list of stack outputs. |
2536 +-------------------------+------------------+------------------------------------------------------------------------------+
2537 |parameters |object | A group of key-value pairs |
2538 +-------------------------+------------------+------------------------------------------------------------------------------+
2539 |parent |String |The stack ID of the parent stack, if this is a nested stack. |
2540 +-------------------------+------------------+------------------------------------------------------------------------------+
2541 |stack_name |String |A name for the stack. |
2542 +-------------------------+------------------+------------------------------------------------------------------------------+
2543 |stack_owner |String |The owner of the stack. |
2544 +-------------------------+------------------+------------------------------------------------------------------------------+
2545 |stack_status |String |The status of the stack. |
2546 +-------------------------+------------------+------------------------------------------------------------------------------+
2547 |stack_status_reason |String |The reason for the current status of the stack. |
2548 +-------------------------+------------------+------------------------------------------------------------------------------+
2549 |stack_user_project_id |String |The project UUID of the stack user. |
2550 +-------------------------+------------------+------------------------------------------------------------------------------+
2551 |tags |array |The stack tags. |
2552 +-------------------------+------------------+------------------------------------------------------------------------------+
2553 |template_description |String |The description of the stack template. |
2554 +-------------------------+------------------+------------------------------------------------------------------------------+
2555 |timeout_mins |integer |The timeout for stack creation in minutes. |
2556 +-------------------------+------------------+------------------------------------------------------------------------------+
2557 |updated_time |String |The date and time when the object was updated. |
2558 +-------------------------+------------------+------------------------------------------------------------------------------+
2563 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2565 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2566 |Interface Definition|Description |
2567 +====================+=======================================================================================================================+
2568 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
2569 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2570 |Operation Type |DELETE |
2571 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2572 |Content-Type |application/json |
2573 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2577 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2578 |Attribute |Qualifier|Cardinality|Content |Description |
2579 +==================+=========+===========+==========================+=================================================================================================+
2580 |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
2581 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2582 |stack_name |M |1 |string |The name of a stack. |
2583 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2584 |stack_id |M |1 |string |The UUID of the stack. |
2585 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2590 https://developer.openstack.org/api-ref/compute/#create-server
2592 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2593 |Interface Definition|Description |
2594 +====================+=======================================================================================================================+
2595 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.37/{tenant_id}/servers |
2596 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2597 |Operation Type |POST |
2598 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2599 |Content-Type |application/json |
2600 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2604 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2605 |Attribute |Qualifier|Cardinality|Content |Description |
2606 +================================================+=========+===========+==========================+=================================================================================================+
2607 |server |M |1 |object |A server object. |
2608 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2609 |name |M |1 |string |The server name. |
2610 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2611 |flavorRef |M |1 |string |The flavor reference, as an ID (including a UUID) or full URL |
2612 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2613 |imageRef |M |1 |string |The UUID of the image to use for your server instance |
2614 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2615 |security_groups |O |1 |array |One or more security groups. |
2616 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2617 |metadata |O |1 |object |Metadata key and value pairs. |
2618 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2619 |accessIPv4 |O |1 |string |IPv4 address that should be used to access this server. |
2620 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2621 |accessIPv6 |O |1 |string |IPv6 address that should be used to access this server. |
2622 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2623 |adminPass |O |1 |string |The administrative password of the server. |
2624 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2625 |user_data |O |1 |string |Configuration information or scripts to use upon launch. |
2626 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2627 |availability_zone |O |1 |string |The availability zone from which to launch the server. |
2628 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2629 |networks |M |1 |object |A networks object. |
2630 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2631 |networks.uuid |O |1 |string |To provision the server instance with a NIC for a network |
2632 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2633 |networks.port |O |1 |string |To provision the server instance with a NIC for an already existing port |
2634 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2635 |networks.fixed_ip |O |1 |string |A fixed IPv4 address for the NIC |
2636 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2637 |networks.tag |O |1 |string |A device role tag that can be applied to a network interface. |
2638 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2639 |personality |O |1 |array |The file path and contents, text only, to inject into the server at launch. |
2640 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2641 |block_device_mapping_v2 |O |1 |array |Enables fine grained control of the block device mapping for an instance. |
2642 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2643 |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. |
2644 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2645 |block_device_mapping_v2.source_type |M |1 |string |The source type of the volume. |
2646 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2647 |block_device_mapping_v2.destination_type |O |1 |string |Defines where the volume comes from. |
2648 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2649 |block_device_mapping_v2.delete_on_termination |O |1 |string |To delete the boot volume when the server is destroyed, specify true. |
2650 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2651 |block_device_mapping_v2.guest_format |M |1 |string |Specifies the guest server disk file system format, such as ephemeral or swap. |
2652 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2653 |block_device_mapping_v2.boot_index |M |1 |string |Defines the order in which a hypervisor tries devices |
2654 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2655 |block_device_mapping_v2.uuid |O |1 |string |This is the uuid of source resource. |
2656 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2657 |block_device_mapping_v2.tag |O |1 |string |A device role tag that can be applied to a block device. |
2658 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2659 |block_device_mapping_v2.disk_bus |O |1 |string |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter |
2660 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2661 |config_drive |O |1 |boolean |Indicates whether a configuration drive enables metadata injection. |
2662 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2663 |key_name |O |1 |string |Key pair name. |
2664 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2665 |os:scheduler_hints |O |1 |object |The dictionary of data to send to the scheduler. |
2666 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2667 |OS-DCF:diskConfig |O |1 |string |Controls how the API partitions the disk when you create, rebuild, or resize servers. |
2668 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2669 |description |O |1 |string |A free form description of the server. |
2670 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2671 |tags |O |1 |array |A list of tags. |
2672 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2676 +-------------------------+------------------+------------------------------------------------------------------------------+
2677 |Attribute |Content |Description |
2678 +=========================+==================+==============================================================================+
2679 |Location |String |The location URL of the server. |
2680 +-------------------------+------------------+------------------------------------------------------------------------------+
2681 |server |object |A server object. |
2682 +-------------------------+------------------+------------------------------------------------------------------------------+
2683 |id |String |The UUID of the server. |
2684 +-------------------------+------------------+------------------------------------------------------------------------------+
2685 |links |array |Links to the resources in question. |
2686 +-------------------------+------------------+------------------------------------------------------------------------------+
2687 |OS-DCF:diskConfig |String |Disk configuration. |
2688 +-------------------------+------------------+------------------------------------------------------------------------------+
2689 |security_groups |array |One or more security groups objects. |
2690 +-------------------------+------------------+------------------------------------------------------------------------------+
2691 |security_groups.name |String |The security group name. |
2692 +-------------------------+------------------+------------------------------------------------------------------------------+
2693 |adminPass |String |The administrative password for the server. |
2694 +-------------------------+------------------+------------------------------------------------------------------------------+
2699 https://developer.openstack.org/api-ref/compute/#delete-server
2701 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2702 |Interface Definition|Description |
2703 +====================+=======================================================================================================================+
2704 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id} |
2705 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2706 |Operation Type |DELETE |
2707 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2708 |Content-Type |application/json |
2709 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2713 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2714 |Attribute |Qualifier|Cardinality|Content |Description |
2715 +==================+=========+===========+==========================+=================================================================================================+
2716 |server_id |M |1 |string |The UUID of the server. |
2717 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2722 https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
2724 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2725 |Interface Definition|Description |
2726 +====================+=======================================================================================================================+
2727 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs |
2728 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2729 |Operation Type |POST |
2730 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2731 |Content-Type |application/json |
2732 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2736 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2737 |Attribute |Qualifier|Cardinality|Content |Description |
2738 +==================+=========+===========+==========================+=================================================================================================+
2739 |keypair |M |1 |Object |Keypair object |
2740 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2741 |name |M |1 |string |A name for the keypair which will be used to reference it later. |
2742 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2743 |public_key |O |1 |string |The public ssh key to import. If you omit this value, a keypair is generated for you. |
2744 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2745 |type |O |1 |string |The type of the keypair. |
2746 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2747 |user_id |O |1 |string |The user_id for a keypair. |
2748 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2752 +-----------------+------------------+------------------------------------------------------------------------------+
2753 |Attribute |Content |Description |
2754 +=================+==================+==============================================================================+
2755 |keypair |object |Keypair object |
2756 +-----------------+------------------+------------------------------------------------------------------------------+
2757 |name |String |A name for the keypair which will be used to reference it later. |
2758 +-----------------+------------------+------------------------------------------------------------------------------+
2759 |public_key |String |The keypair public key. |
2760 +-----------------+------------------+------------------------------------------------------------------------------+
2761 |fingerprint |String |The fingerprint for the keypair. |
2762 +-----------------+------------------+------------------------------------------------------------------------------+
2763 |user_id |String |The user_id for a keypair. |
2764 +-----------------+------------------+------------------------------------------------------------------------------+
2765 |private_key |String |If you do not provide a public key on create |
2766 +-----------------+------------------+------------------------------------------------------------------------------+
2767 |type |String |The type of the keypair. |
2768 +-----------------+------------------+------------------------------------------------------------------------------+
2773 https://developer.openstack.org/api-ref/compute/#delete-keypair
2775 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2776 |Interface Definition|Description |
2777 +====================+=======================================================================================================================+
2778 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id} |
2779 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2780 |Operation Type |DELETE |
2781 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2782 |Content-Type |application/json |
2783 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2787 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2788 |Attribute |Qualifier|Cardinality|Content |Description |
2789 +==================+=========+===========+==========================+=================================================================================================+
2790 |keypair_name |M |1 |String |The keypair name. |
2791 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2792 |user_id |O |1 |String |This allows administrative users to operate key-pairs of specified user ID. |
2793 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2798 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
2800 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2801 |Interface Definition|Description |
2802 +====================+=======================================================================================================================+
2803 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks |
2804 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2805 |Operation Type |POST |
2806 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2807 |Content-Type |application/json |
2808 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2812 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2813 |Attribute |Qualifier|Cardinality|Content |Description |
2814 +============================+=========+===========+==========================+=================================================================================================+
2815 |network |M |1 |Object |A network object. |
2816 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2817 |admin_state_up |O |1 |boolean |The administrative state of the network, which is up (true) or down (false). |
2818 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2819 |dns_domain |O |1 |string |A valid DNS domain. |
2820 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2821 |mtu |O |1 |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2822 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2823 |name |O |1 |string |Human-readable name of the network. |
2824 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2825 |port_security_enabled |O |1 |boolean |The port security status of the network. |
2826 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2827 |project_id |O |1 |string |The ID of the project that owns the resource. |
2828 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2829 |provider:network_type |O |1 |string |The type of physical network that this network should be mapped to. |
2830 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2831 |provider:physical_network |O |1 |string |The physical network where this network should be implemented. |
2832 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2833 |provider:segmentation_id |O |1 |integer |The ID of the isolated segment on the physical network. |
2834 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2835 |qos_policy_id |O |1 |string |The ID of the QoS policy. |
2836 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2837 |router:external |O |1 |boolean |Indicates whether this network can provide floating IPs via a router. |
2838 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2839 |segments |O |1 |array |A list of provider segment objects. |
2840 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2841 |shared |O |1 |boolean |Indicates whether this network is shared across all tenants. |
2842 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2843 |tenant_id |O |1 |string |The ID of the project that owns the resource. |
2844 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2845 |vlan_transparent |O |1 |boolean |Indicates the VLAN transparency mode of the network, |
2846 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2847 |description |O |1 |string |A human-readable description for the resource. |
2848 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2849 |is_default |O |1 |boolean |The network is default or not. |
2850 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2851 |availability_zone_hints |O |1 |array |The availability zone candidate for the network. |
2852 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2856 +-----------------------------+------------------+------------------------------------------------------------------------------+
2857 |Attribute |Content |Description |
2858 +=============================+==================+==============================================================================+
2859 |network |object |A network object. |
2860 +-----------------------------+------------------+------------------------------------------------------------------------------+
2861 |admin_state_up |boolean |The administrative state of the network, which is up (true) or down (false). |
2862 +-----------------------------+------------------+------------------------------------------------------------------------------+
2863 |availability_zone_hints |array |The availability zone candidate for the network. |
2864 +-----------------------------+------------------+------------------------------------------------------------------------------+
2865 |availability_zones |array |The availability zone for the network. |
2866 +-----------------------------+------------------+------------------------------------------------------------------------------+
2867 |created_at |String |Time at which the resource has been created (in UTC ISO8601 format). |
2868 +-----------------------------+------------------+------------------------------------------------------------------------------+
2869 |dns_domain |String |A valid DNS domain. |
2870 +-----------------------------+------------------+------------------------------------------------------------------------------+
2871 |id |String |The ID of the network. |
2872 +-----------------------------+------------------+------------------------------------------------------------------------------+
2873 |ipv4_address_scope |String |The ID of the IPv4 address scope that the network is associated with. |
2874 +-----------------------------+------------------+------------------------------------------------------------------------------+
2875 |ipv6_address_scope |String |The ID of the IPv6 address scope that the network is associated with. |
2876 +-----------------------------+------------------+------------------------------------------------------------------------------+
2877 |mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. |
2878 +-----------------------------+------------------+------------------------------------------------------------------------------+
2879 |name |String |Human-readable name of the network. |
2880 +-----------------------------+------------------+------------------------------------------------------------------------------+
2881 |port_security_enabled |boolean |The port security status of the network. |
2882 +-----------------------------+------------------+------------------------------------------------------------------------------+
2883 |project_id |String |The ID of the project. |
2884 +-----------------------------+------------------+------------------------------------------------------------------------------+
2885 |provider:network_type |String |The type of physical network that this network is mapped to. |
2886 +-----------------------------+------------------+------------------------------------------------------------------------------+
2887 |provider:physical_network |String |The physical network where this network is implemented. |
2888 +-----------------------------+------------------+------------------------------------------------------------------------------+
2889 |provider:segmentation_id |integer |The ID of the isolated segment on the physical network. |
2890 +-----------------------------+------------------+------------------------------------------------------------------------------+
2891 |qos_policy_id |String |The ID of the QoS policy. |
2892 +-----------------------------+------------------+------------------------------------------------------------------------------+
2893 |revision_number |integer |The revision number of the resource. |
2894 +-----------------------------+------------------+------------------------------------------------------------------------------+
2895 |router:external |boolean |Indicates whether this network can provide floating IPs via a router. |
2896 +-----------------------------+------------------+------------------------------------------------------------------------------+
2897 |segments |array |A list of provider segment objects. |
2898 +-----------------------------+------------------+------------------------------------------------------------------------------+
2899 |shared |boolean |Indicates whether this network is shared across all tenants. |
2900 +-----------------------------+------------------+------------------------------------------------------------------------------+
2901 |status |String |The network status. Values are ACTIVE, DOWN, BUILD or ERROR. |
2902 +-----------------------------+------------------+------------------------------------------------------------------------------+
2903 |subnets |array |The associated subnets. |
2904 +-----------------------------+------------------+------------------------------------------------------------------------------+
2905 |tenant_id |String |The ID of the project. |
2906 +-----------------------------+------------------+------------------------------------------------------------------------------+
2907 |updated_at |String |Time at which the resource has been updated (in UTC ISO8601 format). |
2908 +-----------------------------+------------------+------------------------------------------------------------------------------+
2909 |vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. |
2910 +-----------------------------+------------------+------------------------------------------------------------------------------+
2911 |description |String |A human-readable description for the resource. |
2912 +-----------------------------+------------------+------------------------------------------------------------------------------+
2913 |is_default |boolean |The network is default pool or not. |
2914 +-----------------------------+------------------+------------------------------------------------------------------------------+
2919 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
2921 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2922 |Interface Definition|Description |
2923 +====================+=======================================================================================================================+
2924 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id} |
2925 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2926 |Operation Type |DELETE |
2927 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2928 |Content-Type |application/json |
2929 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2933 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2934 |Attribute |Qualifier|Cardinality|Content |Description |
2935 +============================+=========+===========+==========================+==============================================================+
2936 |network_id |M |1 |String |The ID of the network. |
2937 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2942 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
2944 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2945 |Interface Definition|Description |
2946 +====================+=======================================================================================================================+
2947 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets |
2948 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2949 |Operation Type |POST |
2950 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2951 |Content-Type |application/json |
2952 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2956 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2957 |Attribute |Qualifier|Cardinality|Content |Description |
2958 +============================+=========+===========+==========================+=================================================================================================+
2959 |subnet |M |1 |string |A subnet object. |
2960 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2961 |tenant_id |O |1 |string |The ID of the project that owns the resource. |
2962 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2963 |project_id |O |1 |string |The ID of the project that owns the resource. |
2964 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2965 |name |O |1 |string |Human-readable name of the resource. |
2966 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2967 |enable_dhcp |O |1 |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
2968 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2969 |network_id |M |1 |string |The ID of the network to which the subnet belongs. |
2970 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2971 |dns_nameservers |O |1 |array |List of dns name servers associated with the subnet. |
2972 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2973 |allocation_pools |O |1 |array |Allocation pools with start and end IP addresses for this subnet. |
2974 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2975 |host_routes |O |1 |array |Additional routes for the subnet. |
2976 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2977 |ip_version |M |1 |integer |The IP protocol version. Value is 4 or 6. |
2978 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2979 |gateway_ip |O |1 |string |Gateway IP of this subnet. |
2980 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2981 |cidr |M |1 |string |The CIDR of the subnet. |
2982 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2983 |description |O |1 |string |A human-readable description for the resource. |
2984 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2985 |ipv6_address_mode |O |1 |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
2986 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2987 |ipv6_ra_mode |O |1 |string |The IPv6 router advertisement specifies whether the networking service |
2988 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2989 |segment_id |O |1 |string |The ID of a network segment the subnet is associated with. |
2990 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2991 |subnetpool_id |O |1 |string |The ID of the subnet pool associated with the subnet. |
2992 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2993 |use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. |
2994 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2995 |service_types |O |1 |array |The service types associated with the subnet. |
2996 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3000 +-----------------------------+------------------+------------------------------------------------------------------------------+
3001 |Attribute |Content |Description |
3002 +=============================+==================+==============================================================================+
3003 |subnet |string |A subnet object. |
3004 +-----------------------------+------------------+------------------------------------------------------------------------------+
3005 |id |string |The ID of the subnet. |
3006 +-----------------------------+------------------+------------------------------------------------------------------------------+
3007 |tenant_id |string |The ID of the project. |
3008 +-----------------------------+------------------+------------------------------------------------------------------------------+
3009 |project_id |string |The ID of the project. |
3010 +-----------------------------+------------------+------------------------------------------------------------------------------+
3011 |name |String |Human-readable name of the resource. |
3012 +-----------------------------+------------------+------------------------------------------------------------------------------+
3013 |enable_dhcp |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
3014 +-----------------------------+------------------+------------------------------------------------------------------------------+
3015 |network_id |String |The ID of the network to which the subnet belongs. |
3016 +-----------------------------+------------------+------------------------------------------------------------------------------+
3017 |dns_nameservers |array |List of dns name servers associated with the subnet. |
3018 +-----------------------------+------------------+------------------------------------------------------------------------------+
3019 |allocation_pools |array |Allocation pools with start and end IP addresses for this subnet. |
3020 +-----------------------------+------------------+------------------------------------------------------------------------------+
3021 |host_routes |array |Additional routes for the subnet. |
3022 +-----------------------------+------------------+------------------------------------------------------------------------------+
3023 |ip_version |integer |The IP protocol version. Value is 4 or 6. |
3024 +-----------------------------+------------------+------------------------------------------------------------------------------+
3025 |gateway_ip |string |Gateway IP of this subnet. |
3026 +-----------------------------+------------------+------------------------------------------------------------------------------+
3027 |cidr |string |The CIDR of the subnet. |
3028 +-----------------------------+------------------+------------------------------------------------------------------------------+
3029 |created_at |string |Time at which the subnet has been created. |
3030 +-----------------------------+------------------+------------------------------------------------------------------------------+
3031 |description |string |A human-readable description for the resource. |
3032 +-----------------------------+------------------+------------------------------------------------------------------------------+
3033 |ipv6_address_mode |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
3034 +-----------------------------+------------------+------------------------------------------------------------------------------+
3035 |ipv6_ra_mode |string |The IPv6 router advertisement specifies whether the networking service |
3036 +-----------------------------+------------------+------------------------------------------------------------------------------+
3037 |revision_number |integer |The revision number of the resource. |
3038 +-----------------------------+------------------+------------------------------------------------------------------------------+
3039 |service_types |string |The service types associated with the subnet. |
3040 +-----------------------------+------------------+------------------------------------------------------------------------------+
3041 |subnetpool_id |string |The ID of the subnet pool associated with the subnet. |
3042 +-----------------------------+------------------+------------------------------------------------------------------------------+
3043 |segment_id |string |The ID of a network segment the subnet is associated with. |
3044 +-----------------------------+------------------+------------------------------------------------------------------------------+
3045 |updated_at |string |Time at which the subnet has been updated. |
3046 +-----------------------------+------------------+------------------------------------------------------------------------------+
3051 https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
3053 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3054 |Interface Definition|Description |
3055 +====================+=======================================================================================================================+
3056 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id} |
3057 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3058 |Operation Type |DELETE |
3059 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3060 |Content-Type |application/json |
3061 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3065 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3066 |Attribute |Qualifier|Cardinality|Content |Description |
3067 +============================+=========+===========+==========================+==============================================================+
3068 |subnet_id |M |1 |String |The ID of the subnet. |
3069 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3074 https://developer.openstack.org/api-ref/networking/v2/#create-port
3076 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3077 |Interface Definition|Description |
3078 +====================+=======================================================================================================================+
3079 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports |
3080 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3081 |Operation Type |POST |
3082 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3083 |Content-Type |application/json |
3084 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3088 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3089 |Attribute |Qualifier|Cardinality|Content |Description |
3090 +============================+=========+===========+==========================+=================================================================================================+
3091 |port |M |1 |object |A port object. |
3092 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3093 |admin_state_up |O |1 |boolean |The administrative state of the resource. |
3094 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3095 |allowed_address_pairs |O |1 |array |A set of zero or more allowed address pairs. |
3096 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3097 |binding:host_id |O |1 |string |The ID of the host where the port resides. |
3098 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3099 |binding:profile |O |1 |string |A dictionary that enables the application running on the specific host |
3100 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3101 |binding:vnic_type |O |1 |string |The type of vNIC which this port should be attached to. |
3102 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3103 |description |O |1 |string |A human-readable description for the resource. |
3104 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3105 |device_id |O |1 |string |The ID of the device that uses this port. |
3106 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3107 |device_owner |O |1 |string |The entity type that uses this port. |
3108 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3109 |dns_domain |O |1 |string |A valid DNS domain. |
3110 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3111 |dns_name |O |1 |string |A valid DNS name. |
3112 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3113 |extra_dhcp_opts |O |1 |array |A set of zero or more extra DHCP option pairs. |
3114 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3115 |fixed_ips |O |1 |array |The IP addresses for the port. |
3116 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3117 |mac_address |O |1 |string |The MAC address of the port. |
3118 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3119 |name |O |1 |string |Human-readable name of the resource. |
3120 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3121 |network_id |M |1 |string |The ID of the attached network. |
3122 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3123 |port_security_enabled |O |1 |boolean |The port security status. |
3124 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3125 |project_id |O |1 |string |The ID of the project that owns the resource. |
3126 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3127 |qos_policy_id |O |1 |string |QoS policy associated with the port. |
3128 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3129 |security_groups |O |1 |array |The IDs of security groups applied to the port. |
3130 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3131 |tenant_id |O |1 |string |The ID of the project that owns the resource. |
3132 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3136 +-----------------------------+------------------+------------------------------------------------------------------------------+
3137 |Attribute |Content |Description |
3138 +=============================+==================+==============================================================================+
3139 |port |object |A port object. |
3140 +-----------------------------+------------------+------------------------------------------------------------------------------+
3141 |admin_state_up |boolean |The administrative state of the resource. |
3142 +-----------------------------+------------------+------------------------------------------------------------------------------+
3143 |allowed_address_pairs |array |A set of zero or more allowed address pairs. |
3144 +-----------------------------+------------------+------------------------------------------------------------------------------+
3145 |binding:host_id |string |The ID of the host where the port resides. |
3146 +-----------------------------+------------------+------------------------------------------------------------------------------+
3147 |binding:profile |String |A dictionary that enables the application running on the specific host |
3148 +-----------------------------+------------------+------------------------------------------------------------------------------+
3149 |binding:vif_details |object |A dictionary which contains additional information on the port. |
3150 +-----------------------------+------------------+------------------------------------------------------------------------------+
3151 |binding:vif_type |String |The type of which mechanism is used for the port. |
3152 +-----------------------------+------------------+------------------------------------------------------------------------------+
3153 |binding:vnic_type |string |The type of vNIC which this port should be attached to. |
3154 +-----------------------------+------------------+------------------------------------------------------------------------------+
3155 |created_at |string |Time at which port has been created. |
3156 +-----------------------------+------------------+------------------------------------------------------------------------------+
3157 |data_plane_status |string |Status of the underlying data plane of a port. |
3158 +-----------------------------+------------------+------------------------------------------------------------------------------+
3159 |description |string |A human-readable description for the resource. |
3160 +-----------------------------+------------------+------------------------------------------------------------------------------+
3161 |device_id |string |The ID of the device that uses this port. |
3162 +-----------------------------+------------------+------------------------------------------------------------------------------+
3163 |device_owner |string |The entity type that uses this port. |
3164 +-----------------------------+------------------+------------------------------------------------------------------------------+
3165 |dns_assignment |object |Data assigned to a port by the Networking internal DNS |
3166 +-----------------------------+------------------+------------------------------------------------------------------------------+
3167 |dns_domain |string |A valid DNS domain. |
3168 +-----------------------------+------------------+------------------------------------------------------------------------------+
3169 |dns_name |string |A valid DNS name. |
3170 +-----------------------------+------------------+------------------------------------------------------------------------------+
3171 |extra_dhcp_opts |array |A set of zero or more extra DHCP option pairs. |
3172 +-----------------------------+------------------+------------------------------------------------------------------------------+
3173 |fixed_ips |array |The IP addresses for the port. |
3174 +-----------------------------+------------------+------------------------------------------------------------------------------+
3175 |id |string |The ID of the resource. |
3176 +-----------------------------+------------------+------------------------------------------------------------------------------+
3177 |ip_allocation |string |Indicates when ports use either deferred, immediate or no IP allocation (none)|
3178 +-----------------------------+------------------+------------------------------------------------------------------------------+
3179 |mac_address |string |The MAC address of the port. |
3180 +-----------------------------+------------------+------------------------------------------------------------------------------+
3181 |name |string |Human-readable name of the resource. |
3182 +-----------------------------+------------------+------------------------------------------------------------------------------+
3183 |network_id |string |The ID of the attached network. |
3184 +-----------------------------+------------------+------------------------------------------------------------------------------+
3185 |port_security_enabled |boolean |The port security status. |
3186 +-----------------------------+------------------+------------------------------------------------------------------------------+
3187 |project_id |string |The ID of the project. |
3188 +-----------------------------+------------------+------------------------------------------------------------------------------+
3189 |revision_number |integer |The revision number of the resource. |
3190 +-----------------------------+------------------+------------------------------------------------------------------------------+
3191 |qos_policy_id |string |The ID of the QoS policy associated with the port. |
3192 +-----------------------------+------------------+------------------------------------------------------------------------------+
3193 |security_groups |array |The IDs of security groups applied to the port. |
3194 +-----------------------------+------------------+------------------------------------------------------------------------------+
3195 |status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. |
3196 +-----------------------------+------------------+------------------------------------------------------------------------------+
3197 |tenant_id |string |The ID of the project. |
3198 +-----------------------------+------------------+------------------------------------------------------------------------------+
3199 |updated_at |string |Time at which port has been updated. |
3200 +-----------------------------+------------------+------------------------------------------------------------------------------+
3205 https://developer.openstack.org/api-ref/network/v2/#delete-port
3207 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3208 |Interface Definition|Description |
3209 +====================+=======================================================================================================================+
3210 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id} |
3211 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3212 |Operation Type |DELETE |
3213 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3214 |Content-Type |application/json |
3215 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3219 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3220 |Attribute |Qualifier|Cardinality|Content |Description |
3221 +============================+=========+===========+==========================+==============================================================+
3222 |port_id |M |1 |String |The ID of the port. |
3223 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3225 Create Security Group
3226 ++++++++++++++++++++++
3228 https://developer.openstack.org/api-ref/network/v2/#create-security-group
3230 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3231 |Interface Definition|Description |
3232 +====================+=======================================================================================================================+
3233 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups |
3234 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3235 |Operation Type |POST |
3236 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3237 |Content-Type |application/json |
3238 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3242 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3243 |Attribute |Qualifier|Cardinality|Content |Description |
3244 +============================+=========+===========+==========================+==============================================================+
3245 |security_group |M |1 |object |A security_group object. |
3246 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3247 |tenant_id |M |1 |string |The ID of the project. |
3248 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3249 |project_id |M |1 |string |The ID of the project. |
3250 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3251 |description |O |1 |string |A human-readable description for the resource. |
3252 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3253 |name |M |1 |string |Human-readable name of the resource. |
3254 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3258 +-----------------------------+------------------+------------------------------------------------------------------------------+
3259 |Attribute |Content |Description |
3260 +=============================+==================+==============================================================================+
3261 |security_group |object |A security_group object. |
3262 +-----------------------------+------------------+------------------------------------------------------------------------------+
3263 |id |string |The ID of the security group. |
3264 +-----------------------------+------------------+------------------------------------------------------------------------------+
3265 |tenant_id |string |The ID of the project. |
3266 +-----------------------------+------------------+------------------------------------------------------------------------------+
3267 |project_id |string |The ID of the project. |
3268 +-----------------------------+------------------+------------------------------------------------------------------------------+
3269 |created_at |string |Time at which the resource has been created (in UTC ISO8601 format). |
3270 +-----------------------------+------------------+------------------------------------------------------------------------------+
3271 |updated_at |string |Time at which the resource has been updated (in UTC ISO8601 format). |
3272 +-----------------------------+------------------+------------------------------------------------------------------------------+
3273 |revision_number |integer |The revision number of the resource. |
3274 +-----------------------------+------------------+------------------------------------------------------------------------------+
3275 |name |string |Human-readable name of the resource. |
3276 +-----------------------------+------------------+------------------------------------------------------------------------------+
3277 |description |string |A human-readable description for the resource. |
3278 +-----------------------------+------------------+------------------------------------------------------------------------------+
3279 |security_group_rules |array |A list of security_group_rule objects. |
3280 +-----------------------------+------------------+------------------------------------------------------------------------------+
3282 Delete security group
3283 ++++++++++++++++++++++
3285 https://developer.openstack.org/api-ref/network/v2/#delete-security-group
3287 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3288 |Interface Definition|Description |
3289 +====================+=======================================================================================================================+
3290 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id} |
3291 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3292 |Operation Type |DELETE |
3293 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3294 |Content-Type |application/json |
3295 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3299 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3300 |Attribute |Qualifier|Cardinality|Content |Description |
3301 +============================+=========+===========+==========================+==============================================================+
3302 |security_group_id |M |1 |String |The ID of the security group. |
3303 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3305 Create Security Group Rule
3306 ++++++++++++++++++++++++++
3308 https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
3310 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3311 |Interface Definition|Description |
3312 +====================+=======================================================================================================================+
3313 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules |
3314 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3315 |Operation Type |POST |
3316 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3317 |Content-Type |application/json |
3318 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3322 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3323 |Attribute |Qualifier|Cardinality|Content |Description |
3324 +============================+=========+===========+==========================+================================================================================================+
3325 |security_group_rule |M |1 |object |A security_group_rule object. |
3326 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3327 |remote_group_id |O |1 |string |The remote group UUID to associate with this security group rule. |
3328 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3329 |direction |M |1 |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3330 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3331 |protocol |M |1 |string |The IP protocol can be represented by a string, an integer, or null. |
3332 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3333 |ethertype |O |1 |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3334 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3335 |port_range_max |O |1 |integer |The maximum port number in the range that is matched by the security group rule. |
3336 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3337 |security_group_id |M |1 |string |The security group ID to associate with this security group rule. |
3338 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3339 |port_range_min |O |1 |integer |The minimum port number in the range that is matched by the security group rule. |
3340 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3341 |remote_ip_prefix |M |1 |string |The remote IP prefix to associate with this metering rule packet. |
3342 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3343 |description |O |1 |string |A human-readable description for the resource. Default is an empty string. |
3344 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3348 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3349 |Attribute |Content |Description |
3350 +=============================+==================+=================================================================================================+
3351 |security_group_rule |object |A security_group_rule object. |
3352 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3353 |remote_group_id |string |The remote group UUID to associate with this security group rule. |
3354 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3355 |direction |string |Ingress or egress, which is the direction in which the metering rule is applied. |
3356 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3357 |protocol |string |The IP protocol can be represented by a string, an integer, or null. |
3358 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3359 |ethertype |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3360 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3361 |port_range_max |integer |The maximum port number in the range that is matched by the security group rule. |
3362 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3363 |security_group_id |string |The security group ID to associate with this security group rule. |
3364 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3365 |tenant_id |string |The ID of the project. |
3366 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3367 |project_id |string |The ID of the project. |
3368 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3369 |port_range_min |integer |The minimum port number in the range that is matched by the security group rule. |
3370 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3371 |remote_ip_prefix |string |The remote IP prefix to associate with this metering rule packet. |
3372 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3373 |revision_number |integer |The revision number of the resource. |
3374 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3375 |id |string |The ID of the security group rule. |
3376 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3377 |description |string |A human-readable description for the resource. |
3378 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3380 Delete security group
3381 ++++++++++++++++++++++
3383 https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
3385 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3386 |Interface Definition|Description |
3387 +====================+=================================================================================================================================+
3388 |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id} |
3389 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3390 |Operation Type |DELETE |
3391 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3392 |Content-Type |application/json |
3393 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3397 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3398 |Attribute |Qualifier|Cardinality|Content |Description |
3399 +============================+=========+===========+==========================+==============================================================+
3400 |security_group_rule_id |M |1 |String |The ID of the security group rule. |
3401 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3406 Create a dictionary item
3407 ++++++++++++++++++++++++
3409 +--------------------+--------------------------+
3410 |Interface Definition|Description |
3411 +====================+==========================+
3412 |URI |/createDictionaryItem |
3413 +--------------------+--------------------------+
3414 |Operation Type |PUT |
3415 +--------------------+--------------------------+
3419 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3420 |Attribute |Qualifier|Cardinality|Content|Description |
3421 +===================+=========+===========+=======+=============================================================+
3422 |dictionory |M |1 |String | |
3423 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3424 |dictionaryJson |M |1 |String | |
3425 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3426 |dictionaryType |M |1 |String | |
3427 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3428 |requestId |M |1 |String | |
3429 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3433 +-------------------+---------+-----------------------------------------------------------------------------------------+
3434 |Header Name |Qualifier|Description |
3435 +===================+=========+=========================================================================================+
3436 |ClientAuth |Y |encoded client authentication details |
3437 +-------------------+---------+-----------------------------------------------------------------------------------------+
3438 |X-ECOMP-RequestID |N |Request ID to track the requests |
3439 +-------------------+---------+-----------------------------------------------------------------------------------------+
3440 |Environment |Y |execution environments |
3441 +-------------------+---------+-----------------------------------------------------------------------------------------+
3442 |Authorization |Y |Base64 encoded username:password |
3443 +-------------------+---------+-----------------------------------------------------------------------------------------+
3447 +------------------+---------------------+
3448 |HTTP CODE |Description |
3449 +==================+=====================+
3451 +------------------+---------------------+
3452 |400 |Invalid Request |
3453 +------------------+---------------------+
3454 |401 |Unauthorized |
3455 +------------------+---------------------+
3457 +------------------+---------------------+
3462 +--------------------+--------------------------+
3463 |Interface Definition|Description |
3464 +====================+==========================+
3465 |URI |/createPolicy |
3466 +--------------------+--------------------------+
3467 |Operation Type |PUT |
3468 +--------------------+--------------------------+
3472 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3473 |Attribute |Qualifier|Cardinality|Content|Description |
3474 +===================+=========+===========+=======+=============================================================+
3475 |attributes |M |1 |Object |set of attributes in key value pair |
3476 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3477 |configBody |M |1 |String | |
3478 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3479 |configBodyType |M |1 |String | |
3480 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3481 |configName |M |1 |String | |
3482 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3483 |ecompName |M |1 |String | |
3484 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3485 |policyClass |M |1 |String | |
3486 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3487 |policyConfigType |M |1 |String | |
3488 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3489 |policyDescription |M |1 |String | |
3490 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3491 |policyName |M |1 |String | |
3492 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3493 |requestID |M |1 |String |request ID |
3494 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3498 +-------------------+---------+-----------------------------------------------------------------------------------------+
3499 |Header Name |Qualifier|Description |
3500 +===================+=========+=========================================================================================+
3501 |ClientAuth |Y |encoded client authentication details |
3502 +-------------------+---------+-----------------------------------------------------------------------------------------+
3503 |X-ECOMP-RequestID |N |Request ID to track the requests |
3504 +-------------------+---------+-----------------------------------------------------------------------------------------+
3505 |Environment |Y |execution environments |
3506 +-------------------+---------+-----------------------------------------------------------------------------------------+
3507 |Authorization |Y |Base64 encoded username:password |
3508 +-------------------+---------+-----------------------------------------------------------------------------------------+
3512 +------------------+---------------------+
3513 |HTTP CODE |Description |
3514 +==================+=====================+
3516 +------------------+---------------------+
3517 |400 |Invalid Request |
3518 +------------------+---------------------+
3519 |401 |Unauthorized |
3520 +------------------+---------------------+
3522 +------------------+---------------------+
3527 +--------------------+--------------------------+
3528 |Interface Definition|Description |
3529 +====================+==========================+
3530 |URI |/deletePolicy |
3531 +--------------------+--------------------------+
3532 |Operation Type |DELETE |
3533 +--------------------+--------------------------+
3537 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3538 |Attribute |Qualifier|Cardinality|Content|Description |
3539 +===================+=========+===========+=======+=============================================================+
3540 |deleteCondition |M |1 |String | |
3541 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3542 |pdpGroup |M |1 |String | |
3543 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3544 |policyComponent |M |1 |String | |
3545 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3546 |policyName |M |1 |String | |
3547 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3548 |policyType |M |1 |String | |
3549 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3550 |requestID |M |1 |String |request ID |
3551 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3555 +-------------------+---------+-----------------------------------------------------------------------------------------+
3556 |Header Name |Qualifier|Description |
3557 +===================+=========+=========================================================================================+
3558 |ClientAuth |Y |encoded client authentication details |
3559 +-------------------+---------+-----------------------------------------------------------------------------------------+
3560 |X-ECOMP-RequestID |N |Request ID to track the requests |
3561 +-------------------+---------+-----------------------------------------------------------------------------------------+
3562 |Environment |Y |execution environments |
3563 +-------------------+---------+-----------------------------------------------------------------------------------------+
3564 |Authorization |Y |Base64 encoded username:password |
3565 +-------------------+---------+-----------------------------------------------------------------------------------------+
3569 +------------------+---------------------+
3570 |HTTP CODE |Description |
3571 +==================+=====================+
3573 +------------------+---------------------+
3574 |400 |Invalid Request |
3575 +------------------+---------------------+
3576 |401 |Unauthorized |
3577 +------------------+---------------------+
3579 +------------------+---------------------+
3584 +--------------------+--------------------------+
3585 |Interface Definition|Description |
3586 +====================+==========================+
3588 +--------------------+--------------------------+
3589 |Operation Type |POST |
3590 +--------------------+--------------------------+
3594 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3595 |Attribute |Qualifier|Cardinality|Content|Description |
3596 +===================+=========+===========+=======+=============================================================+
3597 |configAttributes |M |1 |String | |
3598 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3599 |configName |M |1 |String | |
3600 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3601 |ecompName |M |1 |String | |
3602 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3603 |policyName |M |1 |String | |
3604 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3605 |unique |M |1 |Boolean| |
3606 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3607 |requestID |M |1 |String |request ID |
3608 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3612 +-------------------+---------+-----------------------------------------------------------------------------------------+
3613 |Header Name |Qualifier|Description |
3614 +===================+=========+=========================================================================================+
3615 |ClientAuth |Y |encoded client authentication details |
3616 +-------------------+---------+-----------------------------------------------------------------------------------------+
3617 |X-ECOMP-RequestID |N |Request ID to track the requests |
3618 +-------------------+---------+-----------------------------------------------------------------------------------------+
3619 |Environment |Y |execution environments |
3620 +-------------------+---------+-----------------------------------------------------------------------------------------+
3621 |Authorization |Y |Base64 encoded username:password |
3622 +-------------------+---------+-----------------------------------------------------------------------------------------+
3626 +------------------+---------------------+
3627 |HTTP CODE |Description |
3628 +==================+=====================+
3630 +------------------+---------------------+
3631 |400 |Invalid Request |
3632 +------------------+---------------------+
3633 |401 |Unauthorized |
3634 +------------------+---------------------+
3636 +------------------+---------------------+
3641 +--------------------+--------------------------+
3642 |Interface Definition|Description |
3643 +====================+==========================+
3644 |URI |/getDecision |
3645 +--------------------+--------------------------+
3646 |Operation Type |POST |
3647 +--------------------+--------------------------+
3651 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3652 |Attribute |Qualifier|Cardinality|Content|Description |
3653 +===================+=========+===========+=======+=============================================================+
3654 |decisionAttributes |M |1 |Object | |
3655 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3656 |ecompComponentName |M |1 |String | |
3657 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3658 |requestID |M |1 |String |request ID |
3659 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3663 +-------------------+---------+-----------------------------------------------------------------------------------------+
3664 |Header Name |Qualifier|Description |
3665 +===================+=========+=========================================================================================+
3666 |ClientAuth |Y |encoded client authentication details |
3667 +-------------------+---------+-----------------------------------------------------------------------------------------+
3668 |X-ECOMP-RequestID |N |Request ID to track the requests |
3669 +-------------------+---------+-----------------------------------------------------------------------------------------+
3670 |Environment |Y |execution environments |
3671 +-------------------+---------+-----------------------------------------------------------------------------------------+
3672 |Authorization |Y |Base64 encoded username:password |
3673 +-------------------+---------+-----------------------------------------------------------------------------------------+
3677 +------------------+---------------------+
3678 |HTTP CODE |Description |
3679 +==================+=====================+
3681 +------------------+---------------------+
3682 |400 |Invalid Request |
3683 +------------------+---------------------+
3684 |401 |Unauthorized |
3685 +------------------+---------------------+
3687 +------------------+---------------------+
3689 Response Parameters:
3691 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3692 |Attribute |Qualifier|Cardinality|Content|Description |
3693 +===================+=========+===========+=======+=============================================================+
3694 |decision |N |1 |String | |
3695 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3696 |details |N |1 |String | |
3697 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3699 Get Dictionary Items
3700 ++++++++++++++++++++
3702 +--------------------+--------------------------+
3703 |Interface Definition|Description |
3704 +====================+==========================+
3705 |URI |/getDictionaryItems |
3706 +--------------------+--------------------------+
3707 |Operation Type |POST |
3708 +--------------------+--------------------------+
3712 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3713 |Attribute |Qualifier|Cardinality|Content|Description |
3714 +===================+=========+===========+=======+=============================================================+
3715 |dictionary |N |1 |String | |
3716 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3717 |dictionaryJson |N |1 |String | |
3718 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3719 |dictionaryType |N |1 |String | |
3720 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3721 |requestID |M |1 |String |request ID |
3722 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3726 +-------------------+---------+-----------------------------------------------------------------------------------------+
3727 |Header Name |Qualifier|Description |
3728 +===================+=========+=========================================================================================+
3729 |ClientAuth |Y |encoded client authentication details |
3730 +-------------------+---------+-----------------------------------------------------------------------------------------+
3731 |X-ECOMP-RequestID |N |Request ID to track the requests |
3732 +-------------------+---------+-----------------------------------------------------------------------------------------+
3733 |Environment |Y |execution environments |
3734 +-------------------+---------+-----------------------------------------------------------------------------------------+
3735 |Authorization |Y |Base64 encoded username:password |
3736 +-------------------+---------+-----------------------------------------------------------------------------------------+
3740 +------------------+---------------------+
3741 |HTTP CODE |Description |
3742 +==================+=====================+
3744 +------------------+---------------------+
3745 |400 |Invalid Request |
3746 +------------------+---------------------+
3747 |401 |Unauthorized |
3748 +------------------+---------------------+
3750 +------------------+---------------------+
3752 Response Parameters:
3754 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3755 |Attribute |Qualifier|Cardinality|Content|Description |
3756 +===================+=========+===========+=======+=============================================================+
3757 |dictionaryData |N |1 |Object | |
3758 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3759 |dictionaryJson |N |1 |Object | |
3760 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3761 |responseCode |N |1 |Integer| |
3762 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3763 |responseMessage |N |1 |Object | |
3764 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3769 +--------------------+--------------------------+
3770 |Interface Definition|Description |
3771 +====================+==========================+
3773 +--------------------+--------------------------+
3774 |Operation Type |GET |
3775 +--------------------+--------------------------+
3779 +-------------------+---------+-----------------------------------------------------------------------------------------+
3780 |Header Name |Qualifier|Description |
3781 +===================+=========+=========================================================================================+
3782 |ClientAuth |Y |encoded client authentication details |
3783 +-------------------+---------+-----------------------------------------------------------------------------------------+
3784 |X-ECOMP-RequestID |N |Request ID to track the requests |
3785 +-------------------+---------+-----------------------------------------------------------------------------------------+
3786 |Environment |Y |execution environments |
3787 +-------------------+---------+-----------------------------------------------------------------------------------------+
3788 |Authorization |Y |Base64 encoded username:password |
3789 +-------------------+---------+-----------------------------------------------------------------------------------------+
3793 +------------------+---------------------+
3794 |HTTP CODE |Description |
3795 +==================+=====================+
3797 +------------------+---------------------+
3798 |400 |Invalid Request |
3799 +------------------+---------------------+
3800 |401 |Unauthorized |
3801 +------------------+---------------------+
3803 +------------------+---------------------+
3805 Response Parameters:
3807 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3808 |Attribute |Qualifier|Cardinality|Content|Description |
3809 +===================+=========+===========+=======+=============================================================+
3810 |metricsTotal |N |1 |Integer| |
3811 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3812 |papMetrics |N |1 |Integer| |
3813 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3814 |pdpMetrics |N |1 |Integer| |
3815 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3816 |responseCode |N |1 |Object | |
3817 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3818 |responseMessage |N |1 |String | |
3819 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3824 +--------------------+--------------------------+
3825 |Interface Definition|Description |
3826 +====================+==========================+
3827 |URI |/getNotification |
3828 +--------------------+--------------------------+
3829 |Operation Type |POST |
3830 +--------------------+--------------------------+
3834 +-------------------+---------+-----------------------------------------------------------------------------------------+
3835 |Header Name |Qualifier|Description |
3836 +===================+=========+=========================================================================================+
3837 |ClientAuth |Y |encoded client authentication details |
3838 +-------------------+---------+-----------------------------------------------------------------------------------------+
3839 |X-ECOMP-RequestID |N |Request ID to track the requests |
3840 +-------------------+---------+-----------------------------------------------------------------------------------------+
3841 |Environment |Y |execution environments |
3842 +-------------------+---------+-----------------------------------------------------------------------------------------+
3843 |Authorization |Y |Base64 encoded username:password |
3844 +-------------------+---------+-----------------------------------------------------------------------------------------+
3848 +------------------+---------------------+
3849 |HTTP CODE |Description |
3850 +==================+=====================+
3852 +------------------+---------------------+
3853 |400 |Invalid Request |
3854 +------------------+---------------------+
3855 |401 |Unauthorized |
3856 +------------------+---------------------+
3858 +------------------+---------------------+
3860 Response Parameters:
3862 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3863 |Attribute |Qualifier|Cardinality|Content|Description |
3864 +===================+=========+===========+=======+=============================================================+
3865 |metricsTotal |N |1 |Integer| |
3866 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3867 |papMetrics |N |1 |Integer| |
3868 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3869 |pdpMetrics |N |1 |Integer| |
3870 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3871 |responseCode |N |1 |Object | |
3872 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3873 |responseMessage |N |1 |String | |
3874 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3879 +--------------------+--------------------------+
3880 |Interface Definition|Description |
3881 +====================+==========================+
3882 |URI |/listConfiguration |
3883 +--------------------+--------------------------+
3884 |Operation Type |POST |
3885 +--------------------+--------------------------+
3889 +-------------------+---------+-----------------------------------------------------------------------------------------+
3890 |Header Name |Qualifier|Description |
3891 +===================+=========+=========================================================================================+
3892 |ClientAuth |Y |encoded client authentication details |
3893 +-------------------+---------+-----------------------------------------------------------------------------------------+
3894 |X-ECOMP-RequestID |N |Request ID to track the requests |
3895 +-------------------+---------+-----------------------------------------------------------------------------------------+
3896 |Environment |Y |execution environments |
3897 +-------------------+---------+-----------------------------------------------------------------------------------------+
3898 |Authorization |Y |Base64 encoded username:password |
3899 +-------------------+---------+-----------------------------------------------------------------------------------------+
3903 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3904 |Attribute |Qualifier|Cardinality|Content|Description |
3905 +===================+=========+===========+=======+=============================================================+
3906 |configAttributes |N |1 |Object | |
3907 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3908 |configName |N |1 |String | |
3909 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3910 |ecompName |N |1 |String | |
3911 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3912 |policyName |N |1 |String | |
3913 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3914 |requestID |N |1 |String | |
3915 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3916 |unique |N |1 |Boolean| |
3917 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3921 +------------------+---------------------+
3922 |HTTP CODE |Description |
3923 +==================+=====================+
3925 +------------------+---------------------+
3926 |400 |Invalid Request |
3927 +------------------+---------------------+
3928 |401 |Unauthorized |
3929 +------------------+---------------------+
3931 +------------------+---------------------+
3936 +--------------------+--------------------------+
3937 |Interface Definition|Description |
3938 +====================+==========================+
3939 |URI |/policyEngineImport |
3940 +--------------------+--------------------------+
3941 |Operation Type |POST |
3942 +--------------------+--------------------------+
3946 +-------------------+---------+-----------------------------------------------------------------------------------------+
3947 |Header Name |Qualifier|Description |
3948 +===================+=========+=========================================================================================+
3949 |ClientAuth |Y |encoded client authentication details |
3950 +-------------------+---------+-----------------------------------------------------------------------------------------+
3951 |X-ECOMP-RequestID |N |Request ID to track the requests |
3952 +-------------------+---------+-----------------------------------------------------------------------------------------+
3953 |Environment |Y |execution environments |
3954 +-------------------+---------+-----------------------------------------------------------------------------------------+
3955 |Authorization |Y |Base64 encoded username:password |
3956 +-------------------+---------+-----------------------------------------------------------------------------------------+
3960 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3961 |Attribute |Qualifier|Cardinality|Content|Description |
3962 +===================+=========+===========+=======+=============================================================+
3963 |importParameterJson|Y |1 |String | |
3964 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3965 |file |Y |1 |File | |
3966 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3970 +------------------+---------------------+
3971 |HTTP CODE |Description |
3972 +==================+=====================+
3974 +------------------+---------------------+
3975 |400 |Invalid Request |
3976 +------------------+---------------------+
3977 |401 |Unauthorized |
3978 +------------------+---------------------+
3980 +------------------+---------------------+
3985 +--------------------+--------------------------+
3986 |Interface Definition|Description |
3987 +====================+==========================+
3989 +--------------------+--------------------------+
3990 |Operation Type |PUT |
3991 +--------------------+--------------------------+
3995 +-------------------+---------+-----------------------------------------------------------------------------------------+
3996 |Header Name |Qualifier|Description |
3997 +===================+=========+=========================================================================================+
3998 |ClientAuth |Y |encoded client authentication details |
3999 +-------------------+---------+-----------------------------------------------------------------------------------------+
4000 |X-ECOMP-RequestID |N |Request ID to track the requests |
4001 +-------------------+---------+-----------------------------------------------------------------------------------------+
4002 |Environment |Y |execution environments |
4003 +-------------------+---------+-----------------------------------------------------------------------------------------+
4004 |Authorization |Y |Base64 encoded username:password |
4005 +-------------------+---------+-----------------------------------------------------------------------------------------+
4009 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4010 |Attribute |Qualifier|Cardinality|Content|Description |
4011 +===================+=========+===========+=======+=============================================================+
4012 |pdpGroup |N |1 |String | |
4013 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4014 |policyName |N |1 |String | |
4015 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4016 |policyType |N |1 |String | |
4017 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4021 +------------------+---------------------+
4022 |HTTP CODE |Description |
4023 +==================+=====================+
4025 +------------------+---------------------+
4026 |400 |Invalid Request |
4027 +------------------+---------------------+
4028 |401 |Unauthorized |
4029 +------------------+---------------------+
4031 +------------------+---------------------+
4036 +--------------------+--------------------------+
4037 |Interface Definition|Description |
4038 +====================+==========================+
4040 +--------------------+--------------------------+
4041 |Operation Type |POST |
4042 +--------------------+--------------------------+
4046 +-------------------+---------+-----------------------------------------------------------------------------------------+
4047 |Header Name |Qualifier|Description |
4048 +===================+=========+=========================================================================================+
4049 |ClientAuth |Y |encoded client authentication details |
4050 +-------------------+---------+-----------------------------------------------------------------------------------------+
4051 |X-ECOMP-RequestID |N |Request ID to track the requests |
4052 +-------------------+---------+-----------------------------------------------------------------------------------------+
4053 |Environment |Y |execution environments |
4054 +-------------------+---------+-----------------------------------------------------------------------------------------+
4055 |Authorization |Y |Base64 encoded username:password |
4056 +-------------------+---------+-----------------------------------------------------------------------------------------+
4060 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4061 |Attribute |Qualifier|Cardinality|Content|Description |
4062 +===================+=========+===========+=======+=============================================================+
4063 |eventAttributes |N |1 |Object | |
4064 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4065 |requestID |N |1 |String | |
4066 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4070 +------------------+---------------------+
4071 |HTTP CODE |Description |
4072 +==================+=====================+
4074 +------------------+---------------------+
4075 |400 |Invalid Request |
4076 +------------------+---------------------+
4077 |401 |Unauthorized |
4078 +------------------+---------------------+
4080 +------------------+---------------------+
4085 +--------------------+--------------------------+
4086 |Interface Definition|Description |
4087 +====================+==========================+
4089 +--------------------+--------------------------+
4090 |Operation Type |POST |
4091 +--------------------+--------------------------+
4095 +-------------------+---------+-----------------------------------------------------------------------------------------+
4096 |Header Name |Qualifier|Description |
4097 +===================+=========+=========================================================================================+
4098 |ClientAuth |Y |encoded client authentication details |
4099 +-------------------+---------+-----------------------------------------------------------------------------------------+
4100 |X-ECOMP-RequestID |N |Request ID to track the requests |
4101 +-------------------+---------+-----------------------------------------------------------------------------------------+
4102 |Environment |Y |execution environments |
4103 +-------------------+---------+-----------------------------------------------------------------------------------------+
4104 |Authorization |Y |Base64 encoded username:password |
4105 +-------------------+---------+-----------------------------------------------------------------------------------------+
4109 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4110 |Attribute |Qualifier|Cardinality|Content|Description |
4111 +===================+=========+===========+=======+=============================================================+
4112 |notificationTopic |Y |1 |String | |
4113 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4117 +------------------+---------------------+
4118 |HTTP CODE |Description |
4119 +==================+=====================+
4121 +------------------+---------------------+
4122 |400 |Invalid Request |
4123 +------------------+---------------------+
4124 |401 |Unauthorized |
4125 +------------------+---------------------+
4127 +------------------+---------------------+
4132 +--------------------+--------------------------+
4133 |Interface Definition|Description |
4134 +====================+==========================+
4135 |URI |/stopNotification |
4136 +--------------------+--------------------------+
4137 |Operation Type |POST |
4138 +--------------------+--------------------------+
4142 +-------------------+---------+-----------------------------------------------------------------------------------------+
4143 |Header Name |Qualifier|Description |
4144 +===================+=========+=========================================================================================+
4145 |ClientAuth |Y |encoded client authentication details |
4146 +-------------------+---------+-----------------------------------------------------------------------------------------+
4147 |X-ECOMP-RequestID |N |Request ID to track the requests |
4148 +-------------------+---------+-----------------------------------------------------------------------------------------+
4149 |Environment |Y |execution environments |
4150 +-------------------+---------+-----------------------------------------------------------------------------------------+
4151 |Authorization |Y |Base64 encoded username:password |
4152 +-------------------+---------+-----------------------------------------------------------------------------------------+
4156 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4157 |Attribute |Qualifier|Cardinality|Content|Description |
4158 +===================+=========+===========+=======+=============================================================+
4159 |notificationTopic |Y |1 |String | |
4160 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4164 +------------------+---------------------+
4165 |HTTP CODE |Description |
4166 +==================+=====================+
4168 +------------------+---------------------+
4169 |400 |Invalid Request |
4170 +------------------+---------------------+
4171 |401 |Unauthorized |
4172 +------------------+---------------------+
4174 +------------------+---------------------+
4179 +--------------------+--------------------------+
4180 |Interface Definition|Description |
4181 +====================+==========================+
4182 |URI |/updateDictionaryItem |
4183 +--------------------+--------------------------+
4184 |Operation Type |PUT |
4185 +--------------------+--------------------------+
4189 +-------------------+---------+-----------------------------------------------------------------------------------------+
4190 |Header Name |Qualifier|Description |
4191 +===================+=========+=========================================================================================+
4192 |ClientAuth |Y |encoded client authentication details |
4193 +-------------------+---------+-----------------------------------------------------------------------------------------+
4194 |X-ECOMP-RequestID |N |Request ID to track the requests |
4195 +-------------------+---------+-----------------------------------------------------------------------------------------+
4196 |Environment |Y |execution environments |
4197 +-------------------+---------+-----------------------------------------------------------------------------------------+
4198 |Authorization |Y |Base64 encoded username:password |
4199 +-------------------+---------+-----------------------------------------------------------------------------------------+
4203 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4204 |Attribute |Qualifier|Cardinality|Content|Description |
4205 +===================+=========+===========+=======+=============================================================+
4206 |dictionary |N |1 |String | |
4207 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4208 |dictionaryJson |N |1 |String | |
4209 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4210 |dictionaryType |N |1 |String | |
4211 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4212 |requestID |N |1 |String | |
4213 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4217 +------------------+---------------------+
4218 |HTTP CODE |Description |
4219 +==================+=====================+
4221 +------------------+---------------------+
4222 |400 |Invalid Request |
4223 +------------------+---------------------+
4224 |401 |Unauthorized |
4225 +------------------+---------------------+
4227 +------------------+---------------------+
4232 +--------------------+--------------------------+
4233 |Interface Definition|Description |
4234 +====================+==========================+
4235 |URI |/updatePolicy |
4236 +--------------------+--------------------------+
4237 |Operation Type |PUT |
4238 +--------------------+--------------------------+
4242 +-------------------+---------+-----------------------------------------------------------------------------------------+
4243 |Header Name |Qualifier|Description |
4244 +===================+=========+=========================================================================================+
4245 |ClientAuth |Y |encoded client authentication details |
4246 +-------------------+---------+-----------------------------------------------------------------------------------------+
4247 |X-ECOMP-RequestID |N |Request ID to track the requests |
4248 +-------------------+---------+-----------------------------------------------------------------------------------------+
4249 |Environment |Y |execution environments |
4250 +-------------------+---------+-----------------------------------------------------------------------------------------+
4251 |Authorization |Y |Base64 encoded username:password |
4252 +-------------------+---------+-----------------------------------------------------------------------------------------+
4256 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4257 |Attribute |Qualifier|Cardinality|Content|Description |
4258 +===================+=========+===========+=======+=============================================================+
4259 |attributes |N |1 |Object | |
4260 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4261 |configBody |N |1 |String | |
4262 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4263 |configBodyType |N |1 |String | |
4264 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4265 |configName |N |1 |String | |
4266 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4267 |ecompName |N |1 |String | |
4268 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4269 |policyClass |N |1 |String | |
4270 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4271 |policyConfigType |N |1 |String | |
4272 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4273 |policyDescription |N |1 |String | |
4274 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4275 |policyName |N |1 |String | |
4276 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4277 |requestID |N |1 |String | |
4278 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4282 +------------------+---------------------+
4283 |HTTP CODE |Description |
4284 +==================+=====================+
4286 +------------------+---------------------+
4287 |400 |Invalid Request |
4288 +------------------+---------------------+
4289 |401 |Unauthorized |
4290 +------------------+---------------------+
4292 +------------------+---------------------+
4295 OOF/HAS create update API
4296 +++++++++++++++++++++++++
4298 +--------------------+--------------------------+
4299 |Interface Definition|Description |
4300 +====================+==========================+
4301 |URI |/api/oof/v1/placement |
4302 +--------------------+--------------------------+
4303 |Operation Type |POST |
4304 +--------------------+--------------------------+
4309 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4310 |Attribute |Required |Cardinality|Content|Description |
4311 +===================+=========+===========+=======+=============================================================+
4312 |requestInfo |Y |1 |Object |The content of the RequestInfo object. |
4313 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4314 |placementInfo |Y |1 |Object |The Content of the PlacementInfo object. |
4315 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4316 |licenseInfo |N |1 |Object |The Content of the LicenseInfo object. |
4317 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4318 |serviceInfo |Y |1 |Object |The Content of the ServiceInfo object. |
4319 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4322 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4323 |Attribute |Required |Cardinality|Content|Description |
4324 +===================+=========+===========+=======+=======================================================================+
4325 |transactionId |Y |1 |String |A unique ID to track an ONAP transaction. |
4326 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4327 |requestId |Y |1 |String |A unique ID to track multiple requests. |
4328 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4329 |callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. |
4330 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4331 |callbackHeader |N |1 |String |The header information a client expecting in a async callback. |
4332 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4333 |sourceId |Y |1 |String |The unique ID of a client making an optimization call. |
4334 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4335 |requestType |Y |1 |String |The type of a request |
4336 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4337 |numSolutions |N |1 |Integer|Expected number of solutions. |
4338 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4339 |optimizers |Y |1..N |List of Strings|A list of optimization services. |
4340 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4341 |timeout |N |1 |Integer|A tolerance window (in secs) for expecting solutions. Default is 600 secs.|
4342 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4345 PlacementInfo Object
4347 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4348 |Attribute |Required |Cardinality|Content|Description |
4349 +===================+=========+===========+=======+=============================================================+
4350 |requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.|
4351 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4352 |placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service.|
4353 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4354 |subscriberInfo |N |1 |Object |The information of a service subscriber. |
4355 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4357 PlacementDemand Object
4359 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4360 |Attribute |Required |Cardinality|Content|Description |
4361 +===================+=========+===========+=======+=======================================================================+
4362 |resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
4363 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4364 |serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
4365 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4366 |tenantId |N |1 |String |A tenant Id as defined in the ordering system. |
4367 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4368 |resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. |
4369 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4370 |existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. |
4371 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4372 |excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions.|
4373 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4374 |requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. |
4375 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4378 SubscriberInfo Object
4380 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4381 |Attribute |Required |Cardinality|Content|Description |
4382 +===================+=========+===========+=======+=======================================================================+
4383 |globalSubscriberId |Y |1 |String |An ID of a subscriber. |
4384 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4385 |subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'.|
4386 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4387 |subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. |
4388 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4390 ModelMetaData Object
4392 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4393 |Attribute |Required |Cardinality|Content|Description |
4394 +===================+=========+===========+=======+=======================================================================+
4395 |modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. |
4396 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4397 |modelVersionId |Y |1 |String |A unique model Id as defined in a service model. |
4398 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4399 |modelName |N |1 |String |A model name as defined in a service model. |
4400 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4401 |modelType |N |1 |String |A model type as defined in a service model. |
4402 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4403 |modelVersion |N |1 |String |A model version as defined in a service model. |
4404 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4405 |modelCustomizationName |N |1 |String |A model customization name as defined in a service model. |
4406 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4411 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4412 |Attribute |Required |Cardinality|Content|Description |
4413 +===================+=========+===========+=======+=======================================================================+
4414 |identifierType |Y |1 |String |The type of a candidate. |
4415 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4416 |identifiers |Y |1..N |List |A list of identifiers. |
4417 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4418 |cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id.|
4419 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4424 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4425 |Attribute |Required |Cardinality|Content|Description |
4426 +===================+=========+===========+=======+=======================================================================+
4427 |serviceInstanceId |Y |1 |String |A service instance id associated with a request. |
4428 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4429 |modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. |
4430 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4431 |serviceName |Y |1 |String |The name of a service |
4432 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4436 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4437 |Attribute |Required |Cardinality|Content|Description |
4438 +===================+=========+===========+=======+=======================================================================+
4439 |licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. |
4440 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4442 LicenseDemand Object
4444 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4445 |Attribute |Required |Cardinality|Content|Description |
4446 +===================+=========+===========+=======+=======================================================================+
4447 |resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
4448 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4449 |serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
4450 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4451 |resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model.|
4452 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4453 |existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. |
4454 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4458 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4459 |Attribute |Required |Cardinality|Content|Description |
4460 +===================+=========+===========+=======+=======================================================================+
4461 |entitlementPoolUUID|Y |1..N |List |Entitlement pool UUIDs associated with a resource. |
4462 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4463 |licenseKeyGroupUUID|Y |1..N |List |License key groups associated with a resource. |
4464 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4469 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4470 |Attribute |Required |Cardinality|Content|Description |
4471 +===================+=========+===========+=======+=======================================================================+
4472 |requestId |Y |1 |String |A unique Id for an ONAP transaction. |
4473 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4474 |transactionId |Y |1 |String |A unique ID to track multiple requests associated with a transaction. |
4475 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4476 |statusMessage |N |1 |String |Reasoning if a requestStatus is failed. |
4477 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
4478 |requestStatus |Y |1 |String |The status of a request. |
4479 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
Code Review / so.git / blob