summaryrefslogtreecommitdiffstats
path: root/docs/templates/sections/apiexample/vfcexample.rst
blob: 71d3b7814f130b8e1e2d3f346774750c9c1fa46d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
=================================================
ONAP VFC Network Service Lifecycle Management API
=================================================

:Date:   2017-10-09

.. contents::
   :depth: 3
..

Overview
========

VFC Network Service Lifecycle Management Rest API.

Version information
-------------------

*Version* : 1.0.0

Contact information
-------------------

| *Contact* : ONAP VFC team
| *Contact Email* : onap-discuss@lists.onap.org

URI scheme
----------

| *BasePath* : /api/nslcm/v1
| *Schemes* : HTTP, HTTPS

Consumes
--------

-  ``application/json``

Produces
--------

-  ``application/json``

Paths
=====

jobstatus
---------

::

    GET /jobs/{jobId}

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Path* | | **jobId** | job Id                               | string           |
| *       | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+
| **Query | | **respons | job response message id              | string           |
| **      | eId**       |                                      |                  |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+-------------------------+--------------------------------------------------+
| HTTP Code               | Schema                                           |
+=========================+==================================================+
| **202**                 | `JobDetailInfo <#_jobdetailinfo>`__              |
+-------------------------+--------------------------------------------------+

Tags
~~~~

-  job

ns create
---------

::

    POST /ns

Description
~~~~~~~~~~~

ns create

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Body* | | **NSCreat | NS Instance Create Request           | `NsCreateRequest |
| *       | eRequest**  |                                      |  <#_nscreaterequ |
|         | | *required |                                      | est>`__          |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **200** | successful operation                               | `NsCreateRespo |
|         |                                                    | nse <#_nscreat |
|         |                                                    | eresponse>`__  |
+---------+----------------------------------------------------+----------------+
| **404** | URL not found                                      | No Content     |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

ns get
------

::

    GET /ns

Description
~~~~~~~~~~~

ns get

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Query | | **csarId* | job response message id              | string           |
| **      | *           |                                      |                  |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **200** | successful operation                               | `NsInstancesIn |
|         |                                                    | fo <#_nsinstan |
|         |                                                    | cesinfo>`__    |
+---------+----------------------------------------------------+----------------+
| **404** | URL not found                                      | No Content     |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

ns Instantiate
--------------

::

    POST /ns/{nsInstanceId}/Instantiate

Description
~~~~~~~~~~~

ns Instantiate

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Path* | | **nsInsta |                                      | string           |
| *       | nceId**     |                                      |                  |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+
| **Body* | | **NSInsta | NS Instantiate Request Body          | `NsInstantiateRe |
| *       | ntiateReque |                                      | quest <#_nsinsta |
|         | st**        |                                      | ntiaterequest>`_ |
|         | | *required |                                      | _                |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **200** |                                                    | `JobInfo <#_jo |
|         |                                                    | binfo>`__      |
+---------+----------------------------------------------------+----------------+
| **201** | Invalid Request                                    | No Content     |
+---------+----------------------------------------------------+----------------+
| **404** | URL not found                                      | No Content     |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

ns scale
--------

::

    POST /ns/{nsInstanceId}/scale

Description
~~~~~~~~~~~

ns scale

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Path* | | **nsInsta |                                      | string           |
| *       | nceId**     |                                      |                  |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+
| **Body* | | **ScaleNS | Scale NS Request Body                | `NsScaleRequest  |
| *       | Request**   |                                      | <#_nsscalereques |
|         | | *required |                                      | t>`__            |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **200** |                                                    | `JobInfo <#_jo |
|         |                                                    | binfo>`__      |
+---------+----------------------------------------------------+----------------+
| **201** | Invalid Request                                    | No Content     |
+---------+----------------------------------------------------+----------------+
| **404** | URL not found                                      | No Content     |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

ns get
------

::

    GET /ns/{ns_instance_id}

Description
~~~~~~~~~~~

ns get

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **200** | successful operation                               | `NsInstanceInf |
|         |                                                    | o <#_nsinstanc |
|         |                                                    | einfo>`__      |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

ns delete
---------

::

    DELETE /ns/{ns_instance_id}

Description
~~~~~~~~~~~

ns delete

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
| *       | tance\_id** |                                      |                  |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **204** | The NS instance resource and the associated NS     | No Content     |
|         | identifier were deleted successfully.              |                |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

ns heal
-------

::

    POST /ns/{ns_instance_id}/heal

Description
~~~~~~~~~~~

ns heal

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
| *       | tance\_id** |                                      |                  |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+
| **Body* | | **healVnf | healVnfData                          | `NsHealRequest < |
| *       | Data**      |                                      | #_nshealrequest> |
|         | | *required |                                      | `__              |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **202** |                                                    | `JobInfo <#_jo |
|         |                                                    | binfo>`__      |
+---------+----------------------------------------------------+----------------+
| **404** | URL not found                                      | No Content     |
+---------+----------------------------------------------------+----------------+
| **500** | the url is invalid                                 | No Content     |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

ns terminate
------------

::

    POST /ns/{ns_instance_id}/terminate

Description
~~~~~~~~~~~

ns terminate

Parameters
~~~~~~~~~~

+---------+-------------+--------------------------------------+------------------+
| Type    | Name        | Description                          | Schema           |
+=========+=============+======================================+==================+
| **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
| *       | tance\_id** |                                      |                  |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+
| **Body* | | **NsTermi | NsTerminateRequest                   | `NsTerminateRequ |
| *       | nateRequest |                                      | est <#_nstermina |
|         | **          |                                      | terequest>`__    |
|         | | *required |                                      |                  |
|         | *           |                                      |                  |
+---------+-------------+--------------------------------------+------------------+

Responses
~~~~~~~~~

+---------+----------------------------------------------------+----------------+
| HTTP    | Description                                        | Schema         |
| Code    |                                                    |                |
+=========+====================================================+================+
| **202** |                                                    | `JobInfo <#_jo |
|         |                                                    | binfo>`__      |
+---------+----------------------------------------------------+----------------+
| **500** | the url is invalid                                 | No Content     |
+---------+----------------------------------------------------+----------------+

Tags
~~~~

-  ns

Definitions
===========

JobDetailInfo
-------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **jobId**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **responseDescriptor**       | `responseDescriptor <#_jobdetailinfo_resp |
| | *optional*                   | onsedescriptor>`__                        |
+--------------------------------+-------------------------------------------+

**responseDescriptor**

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **errorCode**                | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **progress**                 | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **responseHistoryList**      | < `jobResponseInfo <#_jobresponseinfo>`__ |
| | *optional*                   | > array                                   |
+--------------------------------+-------------------------------------------+
| | **responseId**               | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **status**                   | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **statusDescription**        | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

JobInfo
-------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **jobId**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

LocationConstraint
------------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **locationConstraints**      | `locationConstraints <#_locationconstrain |
| | *optional*                   | t_locationconstraints>`__                 |
+--------------------------------+-------------------------------------------+
| | **vnfProfileId**             | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

**locationConstraints**

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **vimid**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

NsCreateRequest
---------------

+-------------+---------------------------------------------+------------------+
| Name        | Description                                 | Schema           |
+=============+=============================================+==================+
| | **csarId* | the NS package ID                           | string           |
| *           |                                             |                  |
| | *optional |                                             |                  |
| *           |                                             |                  |
+-------------+---------------------------------------------+------------------+
| | **descrip |                                             | string           |
| tion**      |                                             |                  |
| | *optional |                                             |                  |
| *           |                                             |                  |
+-------------+---------------------------------------------+------------------+
| | **nsName* |                                             | string           |
| *           |                                             |                  |
| | *optional |                                             |                  |
| *           |                                             |                  |
+-------------+---------------------------------------------+------------------+

NsCreateResponse
----------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **nsInstanceId**             | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

NsHealRequest
-------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **additionalParams**         | `additionalParams <#_nshealrequest_additi |
| | *optional*                   | onalparams>`__                            |
+--------------------------------+-------------------------------------------+
| | **cause**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vnfInstanceId**            | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

**additionalParams**

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **action**                   | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **actionvminfo**             | `actionvminfo <#_nshealrequest_actionvmin |
| | *optional*                   | fo>`__                                    |
+--------------------------------+-------------------------------------------+

**actionvminfo**

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **vmid**                     | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vmname**                   | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

NsInstanceInfo
--------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **description**              | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **nsInstanceId**             | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **nsName**                   | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **nsState**                  | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **nsdId**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vlInfo**                   | < `vlInfo <#_vlinfo>`__ > array           |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vnfInfo**                  | < `vnfInfo <#_vnfinfo>`__ > array         |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vnffgInfo**                | < `vnffgInfo <#_vnffginfo>`__ > array     |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

NsInstancesInfo
---------------

*Type* : < `NsInstanceInfo <#_nsinstanceinfo>`__ > array

NsInstantiateRequest
--------------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **LocationConstraints**      | <                                         |
| | *optional*                   | `LocationConstraint <#_locationconstraint |
|                                | >`__                                      |
|                                | > array                                   |
+--------------------------------+-------------------------------------------+
| | **additionalParamForNs**     | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

NsScaleByStepsData
------------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **aspectId**                 | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **numberOfSteps**            | integer                                   |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **scalingDirection**         | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

NsScaleRequest
--------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **scaleNsByStepsData**       | `NsScaleByStepsData <#_nsscalebystepsdata |
| | *optional*                   | >`__                                      |
+--------------------------------+-------------------------------------------+
| | **scaleType**                | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

NsTerminateRequest
------------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **gracefulTerminationTimeout | string                                    |
| **                             |                                           |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **terminationType**          | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

cpInfo
------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **cpInstanceId**             | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **cpInstanceName**           | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **cpdId**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

jobResponseInfo
---------------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **errorCode**                | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **progress**                 | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **responseId**               | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **status**                   | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **statusDescription**        | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

vlInfo
------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **relatedCpInstanceId**      | < `cpInfo <#_cpinfo>`__ > array           |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vlInstanceId**             | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vlInstanceName**           | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vldId**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

vnfInfo
-------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **vnfInstanceId**            | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vnfInstanceName**          | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vnfdId**                   | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+

vnffgInfo
---------

+--------------------------------+-------------------------------------------+
| Name                           | Schema                                    |
+================================+===========================================+
| | **cpId**                     | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **nfp**                      | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **pnfId**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **virtualLinkId**            | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vnfId**                    | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+
| | **vnffgInstanceId**          | string                                    |
| | *optional*                   |                                           |
+--------------------------------+-------------------------------------------+