Gitiles
Code Review Sign In
gerrit.nordix.org / onap / so / b0c2c00d7f0fd1a74ec7bc00a4625dc2da91fcd0 / . / docs / api / apis / serviceInstances-api.rst
blob: 15ed3932fdff5586a0baf109e4b72f136c9ac844 [file] [log] [blame]
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright 2018 Huawei Technologies Co., Ltd.
4
5serviceInstances API
6====================
7
8
9This API allows to generate some requests to manage:
10
11- serviceInstances (create, delete)
12- volumeGroups attached to a vnf instance (create, delete)
13- vfModules attached to a vnf instance (create, delete)
14- vnfs attached to a service instance (create, delete)
15- orchestrationRequests (get)
sanket12345b0c2c002021-10-05 14:04:10 +0530[diff] [blame^]16- CNF healthCheck
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]17
18links:
19
20- :ref:`create_service_instance`
21- :ref:`delete_service_instance`
22- :ref:`create_volume_group`
23- :ref:`delete_volume_group`
24- :ref:`create_vf_module`
25- :ref:`delete_vf_module`
26- :ref:`create_vnf`
27- :ref:`delete_vnf`
28- :ref:`get_orchestration_request_by_id`
29- :ref:`get_orchestration_request_all`
sanket12345b0c2c002021-10-05 14:04:10 +0530[diff] [blame^]30- :ref:`healthCheck`
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]31
32.. _create_service_instance:
33
34Create service instance
35+++++++++++++++++++++++
36
37+--------------------+--------------------------------------------------------+
38|Interface Definition|Description |
39+====================+========================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]40|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]41+--------------------+--------------------------------------------------------+
42|Operation Type |POST |
43+--------------------+--------------------------------------------------------+
44|Content-Type |application/json |
45+--------------------+--------------------------------------------------------+
46
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]47Request Headers:
48
49+-------------------+---------+-----------------------------------------------------------------------------------------+
50|Header Name |Required |Description |
51+===================+=========+=========================================================================================+
52|Authorization |Y |Base64 encoded username:password |
53+-------------------+---------+-----------------------------------------------------------------------------------------+
54
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]55Request Body:
56
57+----------------+---------+-----------+--------------------------+-------------------------------------------+
58|Attribute |Qualifier|Cardinality|Content |Description |
59+================+=========+===========+==========================+===========================================+
60|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
61+----------------+---------+-----------+--------------------------+-------------------------------------------+
62
63RequestDetails Object
64
65+-------------------+--------------------------+-------------------------------------------------+
66|Attribute |Content |Description |
67+===================+==========================+=================================================+
68|modelInfo |modelInfo Object |Content of modelInfo object. |
69+-------------------+--------------------------+-------------------------------------------------+
70|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
71+-------------------+--------------------------+-------------------------------------------------+
72|requestInfo |requestInfo Object |Content of requestInfo object. |
73+-------------------+--------------------------+-------------------------------------------------+
74|requestParameters |requestParameters Object |Content of requestParameters object. |
75+-------------------+--------------------------+-------------------------------------------------+
76|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
77+-------------------+--------------------------+-------------------------------------------------+
78|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
79+-------------------+--------------------------+-------------------------------------------------+
80|project |project Object |Content of project object. |
81+-------------------+--------------------------+-------------------------------------------------+
82|owningEntity |owningEntity Object |Content of owningEntity object. |
83+-------------------+--------------------------+-------------------------------------------------+
84|platform |platform Object |Content of platform object. |
85+-------------------+--------------------------+-------------------------------------------------+
86|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
87+-------------------+--------------------------+-------------------------------------------------+
88
89ModelInfo Object
90
91+-------------------------+------------------+-------------------------------------------------+
92|Attribute |Content |Description |
93+=========================+==================+=================================================+
94|ModelType |String |Type of model |
95+-------------------------+------------------+-------------------------------------------------+
96|ModelInvariantId |String |The Model Invariant Id. |
97+-------------------------+------------------+-------------------------------------------------+
98|ModelNameVersionId |String |The modelname Version Id |
99+-------------------------+------------------+-------------------------------------------------+
100|ModelName |String |Name of the Model |
101+-------------------------+------------------+-------------------------------------------------+
102|ModelVersion |String |Version of the model |
103+-------------------------+------------------+-------------------------------------------------+
104|ModelCustomization Name |String |The Model Customization name |
105+-------------------------+------------------+-------------------------------------------------+
106|modelCustomizationUuid |String |The Model Customization UUid |
107+-------------------------+------------------+-------------------------------------------------+
108|modelVersionId |String |The Model version id |
109+-------------------------+------------------+-------------------------------------------------+
110|modelUuid |String |The Model UUid |
111+-------------------------+------------------+-------------------------------------------------+
112|modelInvariantUuid |String |The Model Invariant UUid |
113+-------------------------+------------------+-------------------------------------------------+
114|modelInstanceName |String |The Model Instance name |
115+-------------------------+------------------+-------------------------------------------------+
116
117
118SubscriberInfo Object
119
120+-------------------------+------------------+-------------------------------------------------+
121|Attribute |Content |Description |
122+=========================+==================+=================================================+
123|GlobalSubscriberId |String |Global customer Id (in A&AI) |
124+-------------------------+------------------+-------------------------------------------------+
125|SubscriberName |String |Name of the Subscriber |
126+-------------------------+------------------+-------------------------------------------------+
127
128RequestInfo Object
129
130+-------------------------+------------------+-------------------------------------------------+
131|Attribute |Content |Description |
132+=========================+==================+=================================================+
133|Source |String |source of the request |
134+-------------------------+------------------+-------------------------------------------------+
135|billingAccountNumber |String |billingAccountNumber of the request |
136+-------------------------+------------------+-------------------------------------------------+
137|callbackUrl |String |callbackUrl of the request |
138+-------------------------+------------------+-------------------------------------------------+
139|correlator |String |correlator of the request |
140+-------------------------+------------------+-------------------------------------------------+
141|orderNumber |String |orderNumber of the request |
142+-------------------------+------------------+-------------------------------------------------+
143|productFamilyId |String |productFamilyId of the request |
144+-------------------------+------------------+-------------------------------------------------+
145|orderVersion |String |orderVersion of the request |
146+-------------------------+------------------+-------------------------------------------------+
147|instanceName |String |instanceName of the request |
148+-------------------------+------------------+-------------------------------------------------+
149|suppressRollback |String |suppressRollback of the request |
150+-------------------------+------------------+-------------------------------------------------+
151|requestorId |String |requestorId of the request |
152+-------------------------+------------------+-------------------------------------------------+
153
154RequestParameters Object
155
156+-------------------------+------------------+-------------------------------------------------+
157|Attribute |Content |Description |
158+=========================+==================+=================================================+
159|SubscriptionServiceType |String |The service type of the Subscription |
160+-------------------------+------------------+-------------------------------------------------+
161|UserParams |Array |The product family Id. |
162+-------------------------+------------------+-------------------------------------------------+
163|aLaCarte |Boolean | aLaCarte |
164+-------------------------+------------------+-------------------------------------------------+
165|autoBuildVfModules |Boolean |autoBuildVfModules |
166+-------------------------+------------------+-------------------------------------------------+
167|cascadeDelete |Boolean |cascadeDelete |
168+-------------------------+------------------+-------------------------------------------------+
169|usePreload |Boolean |usePreload |
170+-------------------------+------------------+-------------------------------------------------+
171|rebuildVolumeGroups |Boolean |rebuildVolumeGroups |
172+-------------------------+------------------+-------------------------------------------------+
173|payload |String |payload |
174+-------------------------+------------------+-------------------------------------------------+
175|controllerType |String |controllerType |
176+-------------------------+------------------+-------------------------------------------------+
177
178UserParams Object
179
180+-------------------------+------------------+-------------------------------------------------+
181|Attribute |Content |Description |
182+=========================+==================+=================================================+
183|name |String |Tag name of attribute |
184+-------------------------+------------------+-------------------------------------------------+
185|value |String |Value of the tag |
186+-------------------------+------------------+-------------------------------------------------+
187
188CloudConfiguration Object
189
190+-------------------------+------------------+-------------------------------------------------+
191|Attribute |Content |Description |
192+=========================+==================+=================================================+
193|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
194+-------------------------+------------------+-------------------------------------------------+
195|tenantId |String |Name of the Subscriber |
196+-------------------------+------------------+-------------------------------------------------+
197|aicNodeClli |String |aicNodeClli property |
198+-------------------------+------------------+-------------------------------------------------+
199
200Project Object
201
202+-------------------------+------------------+-------------------------------------------------+
203|Attribute |Content |Description |
204+=========================+==================+=================================================+
205|projectName |String |Name of the project |
206+-------------------------+------------------+-------------------------------------------------+
207
208OwningEntity Object
209
210+-------------------------+------------------+-------------------------------------------------+
211|Attribute |Content |Description |
212+=========================+==================+=================================================+
213|owningEntityId |String |owningEntityId of the owingEntity |
214+-------------------------+------------------+-------------------------------------------------+
215|owningEntityName |String |owningEntityName of the owingEntity |
216+-------------------------+------------------+-------------------------------------------------+
217
218Platform Object
219
220+-------------------------+------------------+-------------------------------------------------+
221|Attribute |Content |Description |
222+=========================+==================+=================================================+
223|platformName |String |Platform Name |
224+-------------------------+------------------+-------------------------------------------------+
225
226LineOfBusiness Object
227
228+-------------------------+------------------+-------------------------------------------------+
229|Attribute |Content |Description |
230+=========================+==================+=================================================+
231|lineOfBusinessName |String |Line Of Business Name |
232+-------------------------+------------------+-------------------------------------------------+
233
234
235.. _delete_service_instance:
236
237Delete service instance
238+++++++++++++++++++++++
239
240+--------------------+--------------------------------------------------------------------------------+
241|Interface Definition|Description |
242+====================+================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]243|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId} |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]244+--------------------+--------------------------------------------------------------------------------+
245|Operation Type |DELETE |
246+--------------------+--------------------------------------------------------------------------------+
247|Content-Type |application/json |
248+--------------------+--------------------------------------------------------------------------------+
249
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]250Request Headers:
251
252+-------------------+---------+-----------------------------------------------------------------------------------------+
253|Header Name |Required |Description |
254+===================+=========+=========================================================================================+
255|Authorization |Y |Base64 encoded username:password |
256+-------------------+---------+-----------------------------------------------------------------------------------------+
257
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]258Request Body:
259
260+----------------+---------+-----------+--------------------------+-------------------------------------------+
261|Attribute |Qualifier|Cardinality|Content |Description |
262+================+=========+===========+==========================+===========================================+
263|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
264+----------------+---------+-----------+--------------------------+-------------------------------------------+
265
266RequestDetails Object
267
268+-------------------+-------------------------+-------------------------------------------------+
269|Attribute |Content |Description |
270+===================+=========================+=================================================+
271|modelInfo |modelInfo Object |Content of modelInfo object. |
272+-------------------+-------------------------+-------------------------------------------------+
273|requestInfo |requestInfo Object |Content of requestInfo object. |
274+-------------------+-------------------------+-------------------------------------------------+
275
276ModelInfo Object
277
278+-------------------------+------------------+-------------------------------------------------+
279|Attribute |Content |Description |
280+=========================+==================+=================================================+
281|ModelType |String |Type of model |
282+-------------------------+------------------+-------------------------------------------------+
283|ModelInvariantId |String |The Model Invariant Id. |
284+-------------------------+------------------+-------------------------------------------------+
285|ModelName |String |Name of the Model |
286+-------------------------+------------------+-------------------------------------------------+
287|ModelVersion |String |Version of the model |
288+-------------------------+------------------+-------------------------------------------------+
289
290RequestInfo Object
291
292+-------------------------+------------------+-------------------------------------------------+
293|Attribute |Content |Description |
294+=========================+==================+=================================================+
295|Source |String |source of the request |
296+-------------------------+------------------+-------------------------------------------------+
297
298
299.. _create_volume_group:
300
301Create Volume Group
302+++++++++++++++++++
303
304+--------------------+------------------------------------------------------------------------------------------------------------------+
305|Interface Definition|Description |
306+====================+==================================================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]307|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]308+--------------------+------------------------------------------------------------------------------------------------------------------+
309|Operation Type |POST |
310+--------------------+------------------------------------------------------------------------------------------------------------------+
311|Content-Type |application/json |
312+--------------------+------------------------------------------------------------------------------------------------------------------+
313
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]314Request Headers:
315
316+-------------------+---------+-----------------------------------------------------------------------------------------+
317|Header Name |Required |Description |
318+===================+=========+=========================================================================================+
319|Authorization |Y |Base64 encoded username:password |
320+-------------------+---------+-----------------------------------------------------------------------------------------+
321
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]322Request Body:
323
324+----------------+---------+-----------+--------------------------+-------------------------------------------+
325|Attribute |Qualifier|Cardinality|Content |Description |
326+================+=========+===========+==========================+===========================================+
327|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
328+----------------+---------+-----------+--------------------------+-------------------------------------------+
329
330RequestDetails Object
331
332+-------------------+--------------------------+-------------------------------------------------+
333|Attribute |Content |Description |
334+===================+==========================+=================================================+
335|modelInfo |modelInfo Object |Content of modelInfo object. |
336+-------------------+--------------------------+-------------------------------------------------+
337|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
338+-------------------+--------------------------+-------------------------------------------------+
339|requestInfo |requestInfo Object |Content of requestInfo object. |
340+-------------------+--------------------------+-------------------------------------------------+
341|requestParameters |requestParameters Object |Content of requestParameters object. |
342+-------------------+--------------------------+-------------------------------------------------+
343|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
344+-------------------+--------------------------+-------------------------------------------------+
345|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
346+-------------------+--------------------------+-------------------------------------------------+
347|project |project Object |Content of project object. |
348+-------------------+--------------------------+-------------------------------------------------+
349|owningEntity |owningEntity Object |Content of owningEntity object. |
350+-------------------+--------------------------+-------------------------------------------------+
351|platform |platform Object |Content of platform object. |
352+-------------------+--------------------------+-------------------------------------------------+
353|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
354+-------------------+--------------------------+-------------------------------------------------+
355
356ModelInfo Object
357
358+-------------------------+------------------+-------------------------------------------------+
359|Attribute |Content |Description |
360+=========================+==================+=================================================+
361|ModelType |String |Type of model |
362+-------------------------+------------------+-------------------------------------------------+
363|ModelInvariantId |String |The Model Invariant Id. |
364+-------------------------+------------------+-------------------------------------------------+
365|ModelNameVersionId |String |The modelname Version Id |
366+-------------------------+------------------+-------------------------------------------------+
367|ModelName |String |Name of the Model |
368+-------------------------+------------------+-------------------------------------------------+
369|ModelVersion |String |Version of the model |
370+-------------------------+------------------+-------------------------------------------------+
371|ModelCustomization Name |String |The Model Customization name |
372+-------------------------+------------------+-------------------------------------------------+
373|modelCustomizationUuid |String |The Model Customization UUid |
374+-------------------------+------------------+-------------------------------------------------+
375|modelVersionId |String |The Model version id |
376+-------------------------+------------------+-------------------------------------------------+
377|modelUuid |String |The Model UUid |
378+-------------------------+------------------+-------------------------------------------------+
379|modelInvariantUuid |String |The Model Invariant UUid |
380+-------------------------+------------------+-------------------------------------------------+
381|modelInstanceName |String |The Model Instance name |
382+-------------------------+------------------+-------------------------------------------------+
383
384CloudConfiguration Object
385
386+-------------------------+------------------+-------------------------------------------------+
387|Attribute |Content |Description |
388+=========================+==================+=================================================+
389|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
390+-------------------------+------------------+-------------------------------------------------+
391|tenantId |String |Name of the Subscriber |
392+-------------------------+------------------+-------------------------------------------------+
393|aicNodeClli |String |aicNodeClli property |
394+-------------------------+------------------+-------------------------------------------------+
395
396RequestInfo Object
397
398+-------------------------+------------------+-------------------------------------------------+
399|Attribute |Content |Description |
400+=========================+==================+=================================================+
401|Source |String |source of the request |
402+-------------------------+------------------+-------------------------------------------------+
403|billingAccountNumber |String |billingAccountNumber of the request |
404+-------------------------+------------------+-------------------------------------------------+
405|callbackUrl |String |callbackUrl of the request |
406+-------------------------+------------------+-------------------------------------------------+
407|correlator |String |correlator of the request |
408+-------------------------+------------------+-------------------------------------------------+
409|orderNumber |String |orderNumber of the request |
410+-------------------------+------------------+-------------------------------------------------+
411|productFamilyId |String |productFamilyId of the request |
412+-------------------------+------------------+-------------------------------------------------+
413|orderVersion |String |orderVersion of the request |
414+-------------------------+------------------+-------------------------------------------------+
415|instanceName |String |instanceName of the request |
416+-------------------------+------------------+-------------------------------------------------+
417|suppressRollback |String |suppressRollback of the request |
418+-------------------------+------------------+-------------------------------------------------+
419|requestorId |String |requestorId of the request |
420+-------------------------+------------------+-------------------------------------------------+
421
422relatedInstance List
423
424+-------------------------+------------------+-------------------------------------------------+
425|Attribute |Content |Description |
426+=========================+==================+=================================================+
427|relatedInstance |Object |relatedInstance Object |
428+-------------------------+------------------+-------------------------------------------------+
429
430relatedInstance List
431
432+-------------------------+------------------+-------------------------------------------------+
433|Attribute |Content |Description |
434+=========================+==================+=================================================+
435|instanceId |String |instanceId |
436+-------------------------+------------------+-------------------------------------------------+
437|modelInfo |Object |Content of modelInfo object. |
438+-------------------------+------------------+-------------------------------------------------+
439
440.. _delete_volume_group:
441
442Delete Volume Group
443+++++++++++++++++++
444
445+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
446|Interface Definition|Description |
447+====================+============================================================================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]448|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]449+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
450|Operation Type |DELETE |
451+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
452|Content-Type |application/json |
453+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
454
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]455Request Headers:
456
457+-------------------+---------+-----------------------------------------------------------------------------------------+
458|Header Name |Required |Description |
459+===================+=========+=========================================================================================+
460|Authorization |Y |Base64 encoded username:password |
461+-------------------+---------+-----------------------------------------------------------------------------------------+
462
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]463Request Body:
464
465+----------------+---------+-----------+--------------------------+-------------------------------------------+
466|Attribute |Qualifier|Cardinality|Content |Description |
467+================+=========+===========+==========================+===========================================+
468|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
469+----------------+---------+-----------+--------------------------+-------------------------------------------+
470
471RequestDetails Object
472
473+---------------------+-------------------------+-------------------------------------------------+
474|Attribute |Content |Description |
475+=====================+=========================+=================================================+
476|modelInfo |modelInfo Object |Content of modelInfo object. |
477+---------------------+-------------------------+-------------------------------------------------+
478|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
479+---------------------+-------------------------+-------------------------------------------------+
480|requestInfo |requestInfo Object |Content of requestInfo object. |
481+---------------------+-------------------------+-------------------------------------------------+
482
483ModelInfo Object
484
485+-------------------------+------------------+-------------------------------------------------+
486|Attribute |Content |Description |
487+=========================+==================+=================================================+
488|ModelType |String |Type of model |
489+-------------------------+------------------+-------------------------------------------------+
490|ModelName |String |Name of the Model |
491+-------------------------+------------------+-------------------------------------------------+
492
493CloudConfiguration Object
494
495+-------------------------+------------------+-------------------------------------------------+
496|Attribute |Content |Description |
497+=========================+==================+=================================================+
498|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
499+-------------------------+------------------+-------------------------------------------------+
500|tenantId |String |Name of the Subscriber |
501+-------------------------+------------------+-------------------------------------------------+
502
503RequestInfo Object
504
505+-------------------------+------------------+-------------------------------------------------+
506|Attribute |Content |Description |
507+=========================+==================+=================================================+
508|Source |String |source of the request |
509+-------------------------+------------------+-------------------------------------------------+
510
511.. _create_vf_module:
512
513Create VF Module
514++++++++++++++++
515
516+--------------------+---------------------------------------------------------------------------------------------------------------+
517|Interface Definition|Description |
518+====================+===============================================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]519|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]520+--------------------+---------------------------------------------------------------------------------------------------------------+
521|Operation Type |POST |
522+--------------------+---------------------------------------------------------------------------------------------------------------+
523|Content-Type |application/json |
524+--------------------+---------------------------------------------------------------------------------------------------------------+
525
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]526Request Headers:
527
528+-------------------+---------+-----------------------------------------------------------------------------------------+
529|Header Name |Required |Description |
530+===================+=========+=========================================================================================+
531|Authorization |Y |Base64 encoded username:password |
532+-------------------+---------+-----------------------------------------------------------------------------------------+
533
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]534Request Body:
535
536+----------------+---------+-----------+--------------------------+-------------------------------------------+
537|Attribute |Qualifier|Cardinality|Content |Description |
538+================+=========+===========+==========================+===========================================+
539|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
540+----------------+---------+-----------+--------------------------+-------------------------------------------+
541
542RequestDetails Object
543
544+---------------------+-------------------------+-------------------------------------------------+
545|Attribute |Content |Description |
546+=====================+=========================+=================================================+
547|modelInfo |modelInfo Object |Content of modelInfo object. |
548+---------------------+-------------------------+-------------------------------------------------+
549|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
550+---------------------+-------------------------+-------------------------------------------------+
551|requestInfo |requestInfo Object |Content of requestInfo object. |
552+---------------------+-------------------------+-------------------------------------------------+
553|relatedInstanceList |List |Content of relatedInstanceList. |
554+---------------------+-------------------------+-------------------------------------------------+
555
556ModelInfo Object
557
558+-------------------------+------------------+-------------------------------------------------+
559|Attribute |Content |Description |
560+=========================+==================+=================================================+
561|ModelType |String |Type of model |
562+-------------------------+------------------+-------------------------------------------------+
563|ModelInvariantId |String |The Model Invariant Id. |
564+-------------------------+------------------+-------------------------------------------------+
565|ModelNameVersionId |String |The modelname Version Id |
566+-------------------------+------------------+-------------------------------------------------+
567|ModelName |String |Name of the Model |
568+-------------------------+------------------+-------------------------------------------------+
569|ModelVersion |String |Version of the model |
570+-------------------------+------------------+-------------------------------------------------+
571|ModelCustomization Name |String |The Model Customization name |
572+-------------------------+------------------+-------------------------------------------------+
573
574CloudConfiguration Object
575
576+-------------------------+------------------+-------------------------------------------------+
577|Attribute |Content |Description |
578+=========================+==================+=================================================+
579|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
580+-------------------------+------------------+-------------------------------------------------+
581|tenantId |String |Name of the Subscriber |
582+-------------------------+------------------+-------------------------------------------------+
583
584RequestInfo Object
585
586+-------------------------+------------------+-------------------------------------------------+
587|Attribute |Content |Description |
588+=========================+==================+=================================================+
589|InstanceName |String |The instance Name |
590+-------------------------+------------------+-------------------------------------------------+
591|Source |String |source of the request |
592+-------------------------+------------------+-------------------------------------------------+
593|SuppressRollback |Boolean |SuppressRollback |
594+-------------------------+------------------+-------------------------------------------------+
595
596relatedInstance List
597
598+-------------------------+------------------+-------------------------------------------------+
599|Attribute |Content |Description |
600+=========================+==================+=================================================+
601|relatedInstance |Object |relatedInstance Object |
602+-------------------------+------------------+-------------------------------------------------+
603
604relatedInstance List
605
606+-------------------------+------------------+-------------------------------------------------+
607|Attribute |Content |Description |
608+=========================+==================+=================================================+
609|instanceId |String |instanceId |
610+-------------------------+------------------+-------------------------------------------------+
611|modelInfo |Object |Content of modelInfo object. |
612+-------------------------+------------------+-------------------------------------------------+
613|instanceName |String |Name of the instance |
614+-------------------------+------------------+-------------------------------------------------+
615
616.. _delete_vf_module:
617
618Delete VF Module
619++++++++++++++++
620
621+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
622|Interface Definition|Description |
623+====================+=====================================================================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]624|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]625+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
626|Operation Type |DELETE |
627+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
628|Content-Type |application/json |
629+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
630
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]631Request Headers:
632
633+-------------------+---------+-----------------------------------------------------------------------------------------+
634|Header Name |Required |Description |
635+===================+=========+=========================================================================================+
636|Authorization |Y |Base64 encoded username:password |
637+-------------------+---------+-----------------------------------------------------------------------------------------+
638
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]639Request Body:
640
641+----------------+---------+-----------+--------------------------+-------------------------------------------+
642|Attribute |Qualifier|Cardinality|Content |Description |
643+================+=========+===========+==========================+===========================================+
644|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
645+----------------+---------+-----------+--------------------------+-------------------------------------------+
646
647RequestDetails Object
648
649+---------------------+-------------------------+-------------------------------------------------+
650|Attribute |Content |Description |
651+=====================+=========================+=================================================+
652|modelInfo |modelInfo Object |Content of modelInfo object. |
653+---------------------+-------------------------+-------------------------------------------------+
654|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
655+---------------------+-------------------------+-------------------------------------------------+
656|requestInfo |requestInfo Object |Content of requestInfo object. |
657+---------------------+-------------------------+-------------------------------------------------+
658
659ModelInfo Object
660
661+-------------------------+------------------+-------------------------------------------------+
662|Attribute |Content |Description |
663+=========================+==================+=================================================+
664|ModelType |String |Type of model |
665+-------------------------+------------------+-------------------------------------------------+
666|ModelInvariantId |String |The Model Invariant Id. |
667+-------------------------+------------------+-------------------------------------------------+
668|ModelNameVersionId |String |The modelname Version Id |
669+-------------------------+------------------+-------------------------------------------------+
670|ModelName |String |Name of the Model |
671+-------------------------+------------------+-------------------------------------------------+
672|ModelVersion |String |Version of the model |
673+-------------------------+------------------+-------------------------------------------------+
674|ModelCustomization Name |String |The Model Customization name |
675+-------------------------+------------------+-------------------------------------------------+
676
677CloudConfiguration Object
678
679+-------------------------+------------------+-------------------------------------------------+
680|Attribute |Content |Description |
681+=========================+==================+=================================================+
682|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
683+-------------------------+------------------+-------------------------------------------------+
684|tenantId |String |Name of the Subscriber |
685+-------------------------+------------------+-------------------------------------------------+
686
687RequestInfo Object
688
689+-------------------------+------------------+-------------------------------------------------+
690|Attribute |Content |Description |
691+=========================+==================+=================================================+
692|Source |String |source of the request |
693+-------------------------+------------------+-------------------------------------------------+
694
695
696.. _create_vnf:
697
698Create VNF
699++++++++++
700
701+--------------------+-------------------------------------------------------------------------------------+
702|Interface Definition|Description |
703+====================+=====================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]704|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]705+--------------------+-------------------------------------------------------------------------------------+
706|Operation Type |POST |
707+--------------------+-------------------------------------------------------------------------------------+
708|Content-Type |application/json |
709+--------------------+-------------------------------------------------------------------------------------+
710
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]711Request Headers:
712
713+-------------------+---------+-----------------------------------------------------------------------------------------+
714|Header Name |Required |Description |
715+===================+=========+=========================================================================================+
716|Authorization |Y |Base64 encoded username:password |
717+-------------------+---------+-----------------------------------------------------------------------------------------+
718
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]719Request Body:
720
721+----------------+---------+-----------+--------------------------+-------------------------------------------+
722|Attribute |Qualifier|Cardinality|Content |Description |
723+================+=========+===========+==========================+===========================================+
724|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
725+----------------+---------+-----------+--------------------------+-------------------------------------------+
726
727RequestDetails Object
728
729+-------------------+--------------------------+-------------------------------------------------+
730|Attribute |Content |Description |
731+===================+==========================+=================================================+
732|modelInfo |modelInfo Object |Content of modelInfo object. |
733+-------------------+--------------------------+-------------------------------------------------+
734|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
735+-------------------+--------------------------+-------------------------------------------------+
736|requestInfo |requestInfo Object |Content of requestInfo object. |
737+-------------------+--------------------------+-------------------------------------------------+
738|requestParameters |requestParameters Object |Content of requestParameters object. |
739+-------------------+--------------------------+-------------------------------------------------+
740|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
741+-------------------+--------------------------+-------------------------------------------------+
742|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
743+-------------------+--------------------------+-------------------------------------------------+
744|project |project Object |Content of project object. |
745+-------------------+--------------------------+-------------------------------------------------+
746|owningEntity |owningEntity Object |Content of owningEntity object. |
747+-------------------+--------------------------+-------------------------------------------------+
748|platform |platform Object |Content of platform object. |
749+-------------------+--------------------------+-------------------------------------------------+
750|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
751+-------------------+--------------------------+-------------------------------------------------+
752
753ModelInfo Object
754
755+-------------------------+------------------+-------------------------------------------------+
756|Attribute |Content |Description |
757+=========================+==================+=================================================+
758|ModelType |String |Type of model |
759+-------------------------+------------------+-------------------------------------------------+
760|ModelInvariantId |String |The Model Invariant Id. |
761+-------------------------+------------------+-------------------------------------------------+
762|ModelNameVersionId |String |The modelname Version Id |
763+-------------------------+------------------+-------------------------------------------------+
764|ModelName |String |Name of the Model |
765+-------------------------+------------------+-------------------------------------------------+
766|ModelVersion |String |Version of the model |
767+-------------------------+------------------+-------------------------------------------------+
768|ModelCustomization Name |String |The Model Customization name |
769+-------------------------+------------------+-------------------------------------------------+
770|modelCustomizationUuid |String |The Model Customization UUid |
771+-------------------------+------------------+-------------------------------------------------+
772|modelVersionId |String |The Model version id |
773+-------------------------+------------------+-------------------------------------------------+
774|modelUuid |String |The Model UUid |
775+-------------------------+------------------+-------------------------------------------------+
776|modelInvariantUuid |String |The Model Invariant UUid |
777+-------------------------+------------------+-------------------------------------------------+
778|modelInstanceName |String |The Model Instance name |
779+-------------------------+------------------+-------------------------------------------------+
780
781CloudConfiguration Object
782
783+-------------------------+------------------+-------------------------------------------------+
784|Attribute |Content |Description |
785+=========================+==================+=================================================+
786|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
787+-------------------------+------------------+-------------------------------------------------+
788|tenantId |String |Name of the Subscriber |
789+-------------------------+------------------+-------------------------------------------------+
790
791RequestInfo Object
792
793+-------------------------+------------------+-------------------------------------------------+
794|Attribute |Content |Description |
795+=========================+==================+=================================================+
796|Source |String |source of the request |
797+-------------------------+------------------+-------------------------------------------------+
798|billingAccountNumber |String |billingAccountNumber of the request |
799+-------------------------+------------------+-------------------------------------------------+
800|callbackUrl |String |callbackUrl of the request |
801+-------------------------+------------------+-------------------------------------------------+
802|correlator |String |correlator of the request |
803+-------------------------+------------------+-------------------------------------------------+
804|orderNumber |String |orderNumber of the request |
805+-------------------------+------------------+-------------------------------------------------+
806|productFamilyId |String |productFamilyId of the request |
807+-------------------------+------------------+-------------------------------------------------+
808|orderVersion |String |orderVersion of the request |
809+-------------------------+------------------+-------------------------------------------------+
810|instanceName |String |instanceName of the request |
811+-------------------------+------------------+-------------------------------------------------+
812|suppressRollback |String |suppressRollback of the request |
813+-------------------------+------------------+-------------------------------------------------+
814|requestorId |String |requestorId of the request |
815+-------------------------+------------------+-------------------------------------------------+
816
817relatedInstance List
818
819+-------------------------+------------------+-------------------------------------------------+
820|Attribute |Content |Description |
821+=========================+==================+=================================================+
822|relatedInstance |Object |relatedInstance Object |
823+-------------------------+------------------+-------------------------------------------------+
824
825relatedInstance List
826
827+-------------------------+------------------+-------------------------------------------------+
828|Attribute |Content |Description |
829+=========================+==================+=================================================+
830|instanceId |String |instanceId |
831+-------------------------+------------------+-------------------------------------------------+
832|modelInfo |Object |Content of modelInfo object. |
833+-------------------------+------------------+-------------------------------------------------+
834
835RequestParameters Object
836
837+-------------------------+------------------+-------------------------------------------------+
838|Attribute |Content |Description |
839+=========================+==================+=================================================+
840|UserParams |Array |The product family Id. |
841+-------------------------+------------------+-------------------------------------------------+
842
843UserParams Object
844
845+-------------------------+------------------+-------------------------------------------------+
846|Attribute |Content |Description |
847+=========================+==================+=================================================+
848|name |String |Tag name of attribute |
849+-------------------------+------------------+-------------------------------------------------+
850|value |String |Value of the tag |
851+-------------------------+------------------+-------------------------------------------------+
852
853.. _delete_vnf:
854
855Delete VNF
856++++++++++
857
858+--------------------+-----------------------------------------------------------------------------------------------------+
859|Interface Definition|Description |
860+====================+=====================================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]861|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId} |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]862+--------------------+-----------------------------------------------------------------------------------------------------+
863|Operation Type |DELETE |
864+--------------------+-----------------------------------------------------------------------------------------------------+
865|Content-Type |application/json |
866+--------------------+-----------------------------------------------------------------------------------------------------+
867
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]868Request Headers:
869
870+-------------------+---------+-----------------------------------------------------------------------------------------+
871|Header Name |Required |Description |
872+===================+=========+=========================================================================================+
873|Authorization |Y |Base64 encoded username:password |
874+-------------------+---------+-----------------------------------------------------------------------------------------+
875
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]876Request Body:
877
878+----------------+---------+-----------+--------------------------+-------------------------------------------+
879|Attribute |Qualifier|Cardinality|Content |Description |
880+================+=========+===========+==========================+===========================================+
881|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
882+----------------+---------+-----------+--------------------------+-------------------------------------------+
883
884RequestDetails Object
885
886+---------------------+-------------------------+-------------------------------------------------+
887|Attribute |Content |Description |
888+=====================+=========================+=================================================+
889|modelInfo |modelInfo Object |Content of modelInfo object. |
890+---------------------+-------------------------+-------------------------------------------------+
891|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
892+---------------------+-------------------------+-------------------------------------------------+
893|requestInfo |requestInfo Object |Content of requestInfo object. |
894+---------------------+-------------------------+-------------------------------------------------+
895|requestParameters |requestParameters Object |Content of requestParameters object. |
896+---------------------+-------------------------+-------------------------------------------------+
897
898ModelInfo Object
899
900+-------------------------+------------------+-------------------------------------------------+
901|Attribute |Content |Description |
902+=========================+==================+=================================================+
903|ModelType |String |Type of model |
904+-------------------------+------------------+-------------------------------------------------+
905|ModelName |String |Name of the Model |
906+-------------------------+------------------+-------------------------------------------------+
907
908CloudConfiguration Object
909
910+-------------------------+------------------+-------------------------------------------------+
911|Attribute |Content |Description |
912+=========================+==================+=================================================+
913|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
914+-------------------------+------------------+-------------------------------------------------+
915|tenantId |String |Name of the Subscriber |
916+-------------------------+------------------+-------------------------------------------------+
917
918RequestInfo Object
919
920+-------------------------+------------------+-------------------------------------------------+
921|Attribute |Content |Description |
922+=========================+==================+=================================================+
923|Source |String |source of the request |
924+-------------------------+------------------+-------------------------------------------------+
925
926RequestParameters Object
927
928+-------------------------+------------------+-------------------------------------------------+
929|Attribute |Content |Description |
930+=========================+==================+=================================================+
931|UserParams |Array |The product family Id. |
932+-------------------------+------------------+-------------------------------------------------+
933
934UserParams Object
935
936+-------------------------+------------------+-------------------------------------------------+
937|Attribute |Content |Description |
938+=========================+==================+=================================================+
939|name |String |Tag name of attribute |
940+-------------------------+------------------+-------------------------------------------------+
941|value |String |Value of the tag |
942+-------------------------+------------------+-------------------------------------------------+
943
944.. _get_orchestration_request_by_id:
945
946GET Orchestration Request
947+++++++++++++++++++++++++
948
949+--------------------+-------------------------------------------------------------------------------------+
950|Interface Definition|Description |
951+====================+=====================================================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]952|URI |/onap/so/infra/orchestrationRequests/v7/{request-id} |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]953+--------------------+-------------------------------------------------------------------------------------+
954|Operation Type |GET |
955+--------------------+-------------------------------------------------------------------------------------+
956|Content-Type |application/json |
957+--------------------+-------------------------------------------------------------------------------------+
958
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]959Request Headers:
960
961+-------------------+---------+-----------------------------------------------------------------------------------------+
962|Header Name |Required |Description |
963+===================+=========+=========================================================================================+
964|Authorization |Y |Base64 encoded username:password |
965+-------------------+---------+-----------------------------------------------------------------------------------------+
966
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]967Response Body:
968
969+----------------+---------+-----------+--------------------------+-------------------------------------------+
970|Attribute |Qualifier|Cardinality|Content |Description |
971+================+=========+===========+==========================+===========================================+
972|request |M |1 |request Object |Content of request object. |
973+----------------+---------+-----------+--------------------------+-------------------------------------------+
974
975Request Object
976
977+-------------------+---------+-----------+--------------------------+-------------------------------------------+
978|Attribute |Qualifier|Cardinality|Content |Description |
979+===================+=========+===========+==========================+===========================================+
980|requestId |M |1 |String |Request Id |
981+-------------------+---------+-----------+--------------------------+-------------------------------------------+
982|startTime |M |1 |request Object |Start time. |
983+-------------------+---------+-----------+--------------------------+-------------------------------------------+
984|requestScope |M |1 |request Object |Scope of the request. |
985+-------------------+---------+-----------+--------------------------+-------------------------------------------+
986|requestType |M |1 |request Object |Type of the request. |
987+-------------------+---------+-----------+--------------------------+-------------------------------------------+
988|requestDetails |M |1 |requestDetails Object |Type of the request. |
989+-------------------+---------+-----------+--------------------------+-------------------------------------------+
990|requestStatus |M |1 |requestStatus Object |Type of the request. |
991+-------------------+---------+-----------+--------------------------+-------------------------------------------+
992
993RequestDetails Object
994
995+-------------------+--------------------------+-------------------------------------------------+
996|Attribute |Content |Description |
997+===================+==========================+=================================================+
998|modelInfo |modelInfo Object |Content of modelInfo object. |
999+-------------------+--------------------------+-------------------------------------------------+
1000|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
1001+-------------------+--------------------------+-------------------------------------------------+
1002|requestInfo |requestInfo Object |Content of requestInfo object. |
1003+-------------------+--------------------------+-------------------------------------------------+
1004|requestParameters |requestParameters Object |Content of requestParameters object. |
1005+-------------------+--------------------------+-------------------------------------------------+
1006|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
1007+-------------------+--------------------------+-------------------------------------------------+
1008|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
1009+-------------------+--------------------------+-------------------------------------------------+
1010|project |project Object |Content of project object. |
1011+-------------------+--------------------------+-------------------------------------------------+
1012|owningEntity |owningEntity Object |Content of owningEntity object. |
1013+-------------------+--------------------------+-------------------------------------------------+
1014|platform |platform Object |Content of platform object. |
1015+-------------------+--------------------------+-------------------------------------------------+
1016|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
1017+-------------------+--------------------------+-------------------------------------------------+
1018
1019ModelInfo Object
1020
1021+-------------------------+------------------+-------------------------------------------------+
1022|Attribute |Content |Description |
1023+=========================+==================+=================================================+
1024|ModelType |String |Type of model |
1025+-------------------------+------------------+-------------------------------------------------+
1026|ModelInvariantId |String |The Model Invariant Id. |
1027+-------------------------+------------------+-------------------------------------------------+
1028|ModelNameVersionId |String |The modelname Version Id |
1029+-------------------------+------------------+-------------------------------------------------+
1030|ModelName |String |Name of the Model |
1031+-------------------------+------------------+-------------------------------------------------+
1032|ModelVersion |String |Version of the model |
1033+-------------------------+------------------+-------------------------------------------------+
1034|ModelCustomization Name |String |The Model Customization name |
1035+-------------------------+------------------+-------------------------------------------------+
1036|modelCustomizationUuid |String |The Model Customization UUid |
1037+-------------------------+------------------+-------------------------------------------------+
1038|modelVersionId |String |The Model version id |
1039+-------------------------+------------------+-------------------------------------------------+
1040|modelUuid |String |The Model UUid |
1041+-------------------------+------------------+-------------------------------------------------+
1042|modelInvariantUuid |String |The Model Invariant UUid |
1043+-------------------------+------------------+-------------------------------------------------+
1044|modelInstanceName |String |The Model Instance name |
1045+-------------------------+------------------+-------------------------------------------------+
1046
1047SubscriberInfo Object
1048
1049+-------------------------+------------------+-------------------------------------------------+
1050|Attribute |Content |Description |
1051+=========================+==================+=================================================+
1052|GlobalSubscriberId |String |Global customer Id (in A&AI) |
1053+-------------------------+------------------+-------------------------------------------------+
1054|SubscriberName |String |Name of the Subscriber |
1055+-------------------------+------------------+-------------------------------------------------+
1056
1057RequestInfo Object
1058
1059+-------------------------+------------------+-------------------------------------------------+
1060|Attribute |Content |Description |
1061+=========================+==================+=================================================+
1062|Source |String |source of the request |
1063+-------------------------+------------------+-------------------------------------------------+
1064|billingAccountNumber |String |billingAccountNumber of the request |
1065+-------------------------+------------------+-------------------------------------------------+
1066|callbackUrl |String |callbackUrl of the request |
1067+-------------------------+------------------+-------------------------------------------------+
1068|correlator |String |correlator of the request |
1069+-------------------------+------------------+-------------------------------------------------+
1070|orderNumber |String |orderNumber of the request |
1071+-------------------------+------------------+-------------------------------------------------+
1072|productFamilyId |String |productFamilyId of the request |
1073+-------------------------+------------------+-------------------------------------------------+
1074|orderVersion |String |orderVersion of the request |
1075+-------------------------+------------------+-------------------------------------------------+
1076|instanceName |String |instanceName of the request |
1077+-------------------------+------------------+-------------------------------------------------+
1078|suppressRollback |String |suppressRollback of the request |
1079+-------------------------+------------------+-------------------------------------------------+
1080|requestorId |String |requestorId of the request |
1081+-------------------------+------------------+-------------------------------------------------+
1082
1083RequestParameters Object
1084
1085+-------------------------+------------------+-------------------------------------------------+
1086|Attribute |Content |Description |
1087+=========================+==================+=================================================+
1088|SubscriptionServiceType |String |The service type of the Subscription |
1089+-------------------------+------------------+-------------------------------------------------+
1090
1091RequestStatus Object
1092
1093+-------------------------+------------------+-------------------------------------------------+
1094|Attribute |Content |Description |
1095+=========================+==================+=================================================+
1096|finishTime |String |Time |
1097+-------------------------+------------------+-------------------------------------------------+
1098|requestState |String |state of the request |
1099+-------------------------+------------------+-------------------------------------------------+
1100|statusMessage |String |statusMessage |
1101+-------------------------+------------------+-------------------------------------------------+
1102|percentProgress |String |percentage of progress |
1103+-------------------------+------------------+-------------------------------------------------+
1104
1105
1106.. _get_orchestration_request_all:
1107
1108GET Orchestration Requests
1109++++++++++++++++++++++++++
1110
1111+--------------------+--------------------------------------------------------------+
1112|Interface Definition|Description |
1113+====================+==============================================================+
Rene_Robert3d531ff2019-10-24 09:45:08 +0200[diff] [blame]1114|URI |/onap/so/infra/orchestrationRequests/v7 |
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]1115+--------------------+--------------------------------------------------------------+
1116|Operation Type |GET |
1117+--------------------+--------------------------------------------------------------+
1118|Content-Type |application/json |
1119+--------------------+--------------------------------------------------------------+
1120
Marcin Rzepecki76fd52c2021-03-24 15:22:33 +0100[diff] [blame]1121Request Headers:
1122
1123+-------------------+---------+-----------------------------------------------------------------------------------------+
1124|Header Name |Required |Description |
1125+===================+=========+=========================================================================================+
1126|Authorization |Y |Base64 encoded username:password |
1127+-------------------+---------+-----------------------------------------------------------------------------------------+
1128
1129Query Parameters:
1130
1131+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1132|Attribute |Required |Cardinality|Content|Description |
1133+===================+=========+===========+=======+=====================================================================================================+
1134|filter |Y |1 |String | Orchestration filter (scheme KeyTypes:Option:Value) |
1135| | | | | |
1136| | | | | KeyTypes: |
1137| | | | | serviceInstanceId, serviceInstanceName, vnfInstanceId, pnfName, vnfInstanceName, |
1138| | | | | vfModuleInstanceId, vfModuleInstanceName, volumeGroupInstanceId, volumeGroupInstanceName, |
1139| | | | | networkInstanceId, networkInstanceName, configurationInstanceId, configurationInstanceName, |
1140| | | | | lcpCloudRegionId, tenantId, modelType, requestorId, requestExecutionDate, startTime, requestScope |
1141| | | | | |
1142| | | | | Option: |
1143| | | | | EQUALS (or any not null string), DOES_NOT_EQUAL [e.g. modelType:EQUALS:VNF, modelType:qwe:VNF] |
1144| | | | | for KeyTypes equals startTime or requestExecutionDate: DOES_NOT_EQUAL, BETWEEN_DATES |
1145| | | | | [e.g. startTime:BETWEEN_DATES:30-5-2000:30-5-2030] |
1146+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1147|includeCloudRequest|N |1 |Boolean| Enable or disable cloud data request |
1148+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1149|format |N |1 |String | Orchestration request format [DETAIL, STATUSDETAIL, SIMPLE, SIMPLENOTASKINFO] |
1150+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1151
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame]1152Response Body:
1153
1154+----------------+---------+-----------+--------------------------+-------------------------------------------+
1155|Attribute |Qualifier|Cardinality|Content |Description |
1156+================+=========+===========+==========================+===========================================+
1157|requestList |M |1 |Array |Content of request List. |
1158+----------------+---------+-----------+--------------------------+-------------------------------------------+
1159
1160RequestList :
1161
1162+----------------+---------+-----------+--------------------------+-------------------------------------------+
1163|Attribute |Qualifier|Cardinality|Content |Description |
1164+================+=========+===========+==========================+===========================================+
1165|request |M |1 |request Object |Content of request object. |
1166+----------------+---------+-----------+--------------------------+-------------------------------------------+
1167
1168Request Object
1169
1170+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1171|Attribute |Qualifier|Cardinality|Content |Description |
1172+===================+=========+===========+==========================+===========================================+
1173|requestId |M |1 |String |Request Id. |
1174+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1175|startTime |M |1 |request Object |Start time. |
1176+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1177|requestScope |M |1 |request Object |Scope of the request. |
1178+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1179|requestType |M |1 |request Object |Type of the request. |
1180+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1181|requestDetails |M |1 |requestDetails Object |Type of the request. |
1182+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1183|requestStatus |M |1 |requestStatus Object |Type of the request. |
1184+-------------------+---------+-----------+--------------------------+-------------------------------------------+
1185
1186RequestDetails Object
1187
1188+-------------------+--------------------------+-------------------------------------------------+
1189|Attribute |Content |Description |
1190+===================+==========================+=================================================+
1191|modelInfo |modelInfo Object |Content of modelInfo object. |
1192+-------------------+--------------------------+-------------------------------------------------+
1193|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
1194+-------------------+--------------------------+-------------------------------------------------+
1195|requestInfo |requestInfo Object |Content of requestInfo object. |
1196+-------------------+--------------------------+-------------------------------------------------+
1197|requestParameters |requestParameters Object |Content of requestParameters object. |
1198+-------------------+--------------------------+-------------------------------------------------+
1199|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
1200+-------------------+--------------------------+-------------------------------------------------+
1201|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
1202+-------------------+--------------------------+-------------------------------------------------+
1203|project |project Object |Content of project object. |
1204+-------------------+--------------------------+-------------------------------------------------+
1205|owningEntity |owningEntity Object |Content of owningEntity object. |
1206+-------------------+--------------------------+-------------------------------------------------+
1207|platform |platform Object |Content of platform object. |
1208+-------------------+--------------------------+-------------------------------------------------+
1209|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
1210+-------------------+--------------------------+-------------------------------------------------+
1211
1212ModelInfo Object
1213
1214+-------------------------+------------------+-------------------------------------------------+
1215|Attribute |Content |Description |
1216+=========================+==================+=================================================+
1217|ModelType |String |Type of model |
1218+-------------------------+------------------+-------------------------------------------------+
1219|ModelInvariantId |String |The Model Invariant Id. |
1220+-------------------------+------------------+-------------------------------------------------+
1221|ModelNameVersionId |String |The modelname Version Id |
1222+-------------------------+------------------+-------------------------------------------------+
1223|ModelName |String |Name of the Model |
1224+-------------------------+------------------+-------------------------------------------------+
1225|ModelVersion |String |Version of the model |
1226+-------------------------+------------------+-------------------------------------------------+
1227|ModelCustomization Name |String |The Model Customization name |
1228+-------------------------+------------------+-------------------------------------------------+
1229|modelCustomizationUuid |String |The Model Customization UUid |
1230+-------------------------+------------------+-------------------------------------------------+
1231|modelVersionId |String |The Model version id |
1232+-------------------------+------------------+-------------------------------------------------+
1233|modelUuid |String |The Model UUid |
1234+-------------------------+------------------+-------------------------------------------------+
1235|modelInvariantUuid |String |The Model Invariant UUid |
1236+-------------------------+------------------+-------------------------------------------------+
1237|modelInstanceName |String |The Model Instance name |
1238+-------------------------+------------------+-------------------------------------------------+
1239
1240SubscriberInfo Object
1241
1242+-------------------------+------------------+-------------------------------------------------+
1243|Attribute |Content |Description |
1244+=========================+==================+=================================================+
1245|GlobalSubscriberId |String |Global customer Id (in A&AI) |
1246+-------------------------+------------------+-------------------------------------------------+
1247|SubscriberName |String |Name of the Subscriber |
1248+-------------------------+------------------+-------------------------------------------------+
1249
1250RequestInfo Object
1251
1252+-------------------------+------------------+-------------------------------------------------+
1253|Attribute |Content |Description |
1254+=========================+==================+=================================================+
1255|Source |String |source of the request |
1256+-------------------------+------------------+-------------------------------------------------+
1257|billingAccountNumber |String |billingAccountNumber of the request |
1258+-------------------------+------------------+-------------------------------------------------+
1259|callbackUrl |String |callbackUrl of the request |
1260+-------------------------+------------------+-------------------------------------------------+
1261|correlator |String |correlator of the request |
1262+-------------------------+------------------+-------------------------------------------------+
1263|orderNumber |String |orderNumber of the request |
1264+-------------------------+------------------+-------------------------------------------------+
1265|productFamilyId |String |productFamilyId of the request |
1266+-------------------------+------------------+-------------------------------------------------+
1267|orderVersion |String |orderVersion of the request |
1268+-------------------------+------------------+-------------------------------------------------+
1269|instanceName |String |instanceName of the request |
1270+-------------------------+------------------+-------------------------------------------------+
1271|suppressRollback |String |suppressRollback of the request |
1272+-------------------------+------------------+-------------------------------------------------+
1273|requestorId |String |requestorId of the request |
1274+-------------------------+------------------+-------------------------------------------------+
1275
1276RequestParameters Object
1277
1278+-------------------------+------------------+-------------------------------------------------+
1279|Attribute |Content |Description |
1280+=========================+==================+=================================================+
1281|SubscriptionServiceType |String |The service type of the Subscription |
1282+-------------------------+------------------+-------------------------------------------------+
1283
1284RequestStatus Object
1285
1286+-------------------------+------------------+-------------------------------------------------+
1287|Attribute |Content |Description |
1288+=========================+==================+=================================================+
1289|finishTime |String |Time |
1290+-------------------------+------------------+-------------------------------------------------+
1291|requestState |String |state of the request |
1292+-------------------------+------------------+-------------------------------------------------+
1293|statusMessage |String |statusMessage |
1294+-------------------------+------------------+-------------------------------------------------+
1295|percentProgress |String |percentage of progress |
1296+-------------------------+------------------+-------------------------------------------------+
sanket12345b0c2c002021-10-05 14:04:10 +0530[diff] [blame^]1297
1298.. _healthCheck:
1299
1300CNF healthCheck
1301++++++++++++++++
1302
1303+--------------------+---------------------------------------------------------------------------------------------------------------+
1304|Interface Definition|Description |
1305+====================+===============================================================================================================+
1306|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/healthcheck |
1307+--------------------+---------------------------------------------------------------------------------------------------------------+
1308|Operation Type |POST |
1309+--------------------+---------------------------------------------------------------------------------------------------------------+
1310|Content-Type |application/json |
1311+--------------------+---------------------------------------------------------------------------------------------------------------+
1312
1313Request Headers:
1314
1315+-------------------+---------+-----------------------------------------------------------------------------------------+
1316|Header Name |Required |Description |
1317+===================+=========+=========================================================================================+
1318|Authorization |Y |Base64 encoded username:password |
1319+-------------------+---------+-----------------------------------------------------------------------------------------+
1320
1321Request Body:
1322
1323+----------------+---------+-----------+--------------------------+-------------------------------------------+
1324|Attribute |Qualifier|Cardinality|Content |Description |
1325+================+=========+===========+==========================+===========================================+
1326|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
1327+----------------+---------+-----------+--------------------------+-------------------------------------------+
1328
1329RequestDetails Object
1330
1331+---------------------+-------------------------+-------------------------------------------------+
1332|Attribute |Content |Description |
1333+=====================+=========================+=================================================+
1334|modelInfo |modelInfo Object |Content of modelInfo object. |
1335+---------------------+-------------------------+-------------------------------------------------+
1336|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
1337+---------------------+-------------------------+-------------------------------------------------+
1338|requestInfo |requestInfo Object |Content of requestInfo object. |
1339+---------------------+-------------------------+-------------------------------------------------+
1340|relatedInstanceList |List |Content of relatedInstanceList. |
1341+---------------------+-------------------------+-------------------------------------------------+
1342
1343ModelInfo Object
1344
1345+-------------------------+------------------+-------------------------------------------------+
1346|Attribute |Content |Description |
1347+=========================+==================+=================================================+
1348|ModelType |String |Type of model |
1349+-------------------------+------------------+-------------------------------------------------+
1350|ModelInvariantId |String |The Model Invariant Id. |
1351+-------------------------+------------------+-------------------------------------------------+
1352|ModelNameVersionId |String |The modelname Version Id |
1353+-------------------------+------------------+-------------------------------------------------+
1354|ModelName |String |Name of the Model |
1355+-------------------------+------------------+-------------------------------------------------+
1356|ModelVersion |String |Version of the model |
1357+-------------------------+------------------+-------------------------------------------------+
1358|ModelCustomization Name |String |The Model Customization name |
1359+-------------------------+------------------+-------------------------------------------------+
1360
1361CloudConfiguration Object
1362
1363+-------------------------+------------------+-------------------------------------------------+
1364|Attribute |Content |Description |
1365+=========================+==================+=================================================+
1366|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
1367+-------------------------+------------------+-------------------------------------------------+
1368|tenantId |String |Name of the Subscriber |
1369+-------------------------+------------------+-------------------------------------------------+
1370
1371RequestInfo Object
1372
1373+-------------------------+------------------+-------------------------------------------------+
1374|Attribute |Content |Description |
1375+=========================+==================+=================================================+
1376|InstanceName |String |The instance Name |
1377+-------------------------+------------------+-------------------------------------------------+
1378|Source |String |source of the request |
1379+-------------------------+------------------+-------------------------------------------------+
1380|SuppressRollback |Boolean |SuppressRollback |
1381+-------------------------+------------------+-------------------------------------------------+
1382
1383relatedInstance List
1384
1385+-------------------------+------------------+-------------------------------------------------+
1386|Attribute |Content |Description |
1387+=========================+==================+=================================================+
1388|relatedInstance |Object |relatedInstance Object |
1389+-------------------------+------------------+-------------------------------------------------+
1390
1391relatedInstance List
1392
1393+-------------------------+------------------+-------------------------------------------------+
1394|Attribute |Content |Description |
1395+=========================+==================+=================================================+
1396|instanceId |String |instanceId |
1397+-------------------------+------------------+-------------------------------------------------+
1398|modelInfo |Object |Content of modelInfo object. |
1399+-------------------------+------------------+-------------------------------------------------+
1400|instanceName |String |Name of the instance |
1401+-------------------------+------------------+-------------------------------------------------+