docs/templates/sections/apiexample/vfcexample.rst

   1 =================================================
   2 ONAP VFC Network Service Lifecycle Management API
   3 =================================================
   4
   5 :Date:   2017-10-09
   6
   7 .. contents::
   8    :depth: 3
   9 ..
  10
  11 Overview
  12 ========
  13
  14 VFC Network Service Lifecycle Management Rest API.
  15
  16 Version information
  17 -------------------
  18
  19 *Version* : 1.0.0
  20
  21 Contact information
  22 -------------------
  23
  24 | *Contact* : ONAP VFC team
  25 | *Contact Email* : onap-discuss@lists.onap.org
  26
  27 URI scheme
  28 ----------
  29
  30 | *BasePath* : /api/nslcm/v1
  31 | *Schemes* : HTTP, HTTPS
  32
  33 Consumes
  34 --------
  35
  36 -  ``application/json``
  37
  38 Produces
  39 --------
  40
  41 -  ``application/json``
  42
  43 Paths
  44 =====
  45
  46 jobstatus
  47 ---------
  48
  49 ::
  50
  51     GET /jobs/{jobId}
  52
  53 Parameters
  54 ~~~~~~~~~~
  55
  56 +---------+-------------+--------------------------------------+------------------+
  57 | Type    | Name        | Description                          | Schema           |
  58 +=========+=============+======================================+==================+
  59 | **Path* | | **jobId** | job Id                               | string           |
  60 | *       | | *required |                                      |                  |
  61 |         | *           |                                      |                  |
  62 +---------+-------------+--------------------------------------+------------------+
  63 | **Query | | **respons | job response message id              | string           |
  64 | **      | eId**       |                                      |                  |
  65 |         | | *required |                                      |                  |
  66 |         | *           |                                      |                  |
  67 +---------+-------------+--------------------------------------+------------------+
  68
  69 Responses
  70 ~~~~~~~~~
  71
  72 +-------------------------+--------------------------------------------------+
  73 | HTTP Code               | Schema                                           |
  74 +=========================+==================================================+
  75 | **202**                 | `JobDetailInfo <#_jobdetailinfo>`__              |
  76 +-------------------------+--------------------------------------------------+
  77
  78 Tags
  79 ~~~~
  80
  81 -  job
  82
  83 ns create
  84 ---------
  85
  86 ::
  87
  88     POST /ns
  89
  90 Description
  91 ~~~~~~~~~~~
  92
  93 ns create
  94
  95 Parameters
  96 ~~~~~~~~~~
  97
  98 +---------+-------------+--------------------------------------+------------------+
  99 | Type    | Name        | Description                          | Schema           |
 100 +=========+=============+======================================+==================+
 101 | **Body* | | **NSCreat | NS Instance Create Request           | `NsCreateRequest |
 102 | *       | eRequest**  |                                      |  <#_nscreaterequ |
 103 |         | | *required |                                      | est>`__          |
 104 |         | *           |                                      |                  |
 105 +---------+-------------+--------------------------------------+------------------+
 106
 107 Responses
 108 ~~~~~~~~~
 109
 110 +---------+----------------------------------------------------+----------------+
 111 | HTTP    | Description                                        | Schema         |
 112 | Code    |                                                    |                |
 113 +=========+====================================================+================+
 114 | **200** | successful operation                               | `NsCreateRespo |
 115 |         |                                                    | nse <#_nscreat |
 116 |         |                                                    | eresponse>`__  |
 117 +---------+----------------------------------------------------+----------------+
 118 | **404** | URL not found                                      | No Content     |
 119 +---------+----------------------------------------------------+----------------+
 120
 121 Tags
 122 ~~~~
 123
 124 -  ns
 125
 126 ns get
 127 ------
 128
 129 ::
 130
 131     GET /ns
 132
 133 Description
 134 ~~~~~~~~~~~
 135
 136 ns get
 137
 138 Parameters
 139 ~~~~~~~~~~
 140
 141 +---------+-------------+--------------------------------------+------------------+
 142 | Type    | Name        | Description                          | Schema           |
 143 +=========+=============+======================================+==================+
 144 | **Query | | **csarId* | job response message id              | string           |
 145 | **      | *           |                                      |                  |
 146 |         | | *required |                                      |                  |
 147 |         | *           |                                      |                  |
 148 +---------+-------------+--------------------------------------+------------------+
 149
 150 Responses
 151 ~~~~~~~~~
 152
 153 +---------+----------------------------------------------------+----------------+
 154 | HTTP    | Description                                        | Schema         |
 155 | Code    |                                                    |                |
 156 +=========+====================================================+================+
 157 | **200** | successful operation                               | `NsInstancesIn |
 158 |         |                                                    | fo <#_nsinstan |
 159 |         |                                                    | cesinfo>`__    |
 160 +---------+----------------------------------------------------+----------------+
 161 | **404** | URL not found                                      | No Content     |
 162 +---------+----------------------------------------------------+----------------+
 163
 164 Tags
 165 ~~~~
 166
 167 -  ns
 168
 169 ns Instantiate
 170 --------------
 171
 172 ::
 173
 174     POST /ns/{nsInstanceId}/Instantiate
 175
 176 Description
 177 ~~~~~~~~~~~
 178
 179 ns Instantiate
 180
 181 Parameters
 182 ~~~~~~~~~~
 183
 184 +---------+-------------+--------------------------------------+------------------+
 185 | Type    | Name        | Description                          | Schema           |
 186 +=========+=============+======================================+==================+
 187 | **Path* | | **nsInsta |                                      | string           |
 188 | *       | nceId**     |                                      |                  |
 189 |         | | *required |                                      |                  |
 190 |         | *           |                                      |                  |
 191 +---------+-------------+--------------------------------------+------------------+
 192 | **Body* | | **NSInsta | NS Instantiate Request Body          | `NsInstantiateRe |
 193 | *       | ntiateReque |                                      | quest <#_nsinsta |
 194 |         | st**        |                                      | ntiaterequest>`_ |
 195 |         | | *required |                                      | _                |
 196 |         | *           |                                      |                  |
 197 +---------+-------------+--------------------------------------+------------------+
 198
 199 Responses
 200 ~~~~~~~~~
 201
 202 +---------+----------------------------------------------------+----------------+
 203 | HTTP    | Description                                        | Schema         |
 204 | Code    |                                                    |                |
 205 +=========+====================================================+================+
 206 | **200** |                                                    | `JobInfo <#_jo |
 207 |         |                                                    | binfo>`__      |
 208 +---------+----------------------------------------------------+----------------+
 209 | **201** | Invalid Request                                    | No Content     |
 210 +---------+----------------------------------------------------+----------------+
 211 | **404** | URL not found                                      | No Content     |
 212 +---------+----------------------------------------------------+----------------+
 213
 214 Tags
 215 ~~~~
 216
 217 -  ns
 218
 219 ns scale
 220 --------
 221
 222 ::
 223
 224     POST /ns/{nsInstanceId}/scale
 225
 226 Description
 227 ~~~~~~~~~~~
 228
 229 ns scale
 230
 231 Parameters
 232 ~~~~~~~~~~
 233
 234 +---------+-------------+--------------------------------------+------------------+
 235 | Type    | Name        | Description                          | Schema           |
 236 +=========+=============+======================================+==================+
 237 | **Path* | | **nsInsta |                                      | string           |
 238 | *       | nceId**     |                                      |                  |
 239 |         | | *required |                                      |                  |
 240 |         | *           |                                      |                  |
 241 +---------+-------------+--------------------------------------+------------------+
 242 | **Body* | | **ScaleNS | Scale NS Request Body                | `NsScaleRequest  |
 243 | *       | Request**   |                                      | <#_nsscalereques |
 244 |         | | *required |                                      | t>`__            |
 245 |         | *           |                                      |                  |
 246 +---------+-------------+--------------------------------------+------------------+
 247
 248 Responses
 249 ~~~~~~~~~
 250
 251 +---------+----------------------------------------------------+----------------+
 252 | HTTP    | Description                                        | Schema         |
 253 | Code    |                                                    |                |
 254 +=========+====================================================+================+
 255 | **200** |                                                    | `JobInfo <#_jo |
 256 |         |                                                    | binfo>`__      |
 257 +---------+----------------------------------------------------+----------------+
 258 | **201** | Invalid Request                                    | No Content     |
 259 +---------+----------------------------------------------------+----------------+
 260 | **404** | URL not found                                      | No Content     |
 261 +---------+----------------------------------------------------+----------------+
 262
 263 Tags
 264 ~~~~
 265
 266 -  ns
 267
 268 ns get
 269 ------
 270
 271 ::
 272
 273     GET /ns/{ns_instance_id}
 274
 275 Description
 276 ~~~~~~~~~~~
 277
 278 ns get
 279
 280 Responses
 281 ~~~~~~~~~
 282
 283 +---------+----------------------------------------------------+----------------+
 284 | HTTP    | Description                                        | Schema         |
 285 | Code    |                                                    |                |
 286 +=========+====================================================+================+
 287 | **200** | successful operation                               | `NsInstanceInf |
 288 |         |                                                    | o <#_nsinstanc |
 289 |         |                                                    | einfo>`__      |
 290 +---------+----------------------------------------------------+----------------+
 291
 292 Tags
 293 ~~~~
 294
 295 -  ns
 296
 297 ns delete
 298 ---------
 299
 300 ::
 301
 302     DELETE /ns/{ns_instance_id}
 303
 304 Description
 305 ~~~~~~~~~~~
 306
 307 ns delete
 308
 309 Parameters
 310 ~~~~~~~~~~
 311
 312 +---------+-------------+--------------------------------------+------------------+
 313 | Type    | Name        | Description                          | Schema           |
 314 +=========+=============+======================================+==================+
 315 | **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
 316 | *       | tance\_id** |                                      |                  |
 317 |         | | *required |                                      |                  |
 318 |         | *           |                                      |                  |
 319 +---------+-------------+--------------------------------------+------------------+
 320
 321 Responses
 322 ~~~~~~~~~
 323
 324 +---------+----------------------------------------------------+----------------+
 325 | HTTP    | Description                                        | Schema         |
 326 | Code    |                                                    |                |
 327 +=========+====================================================+================+
 328 | **204** | The NS instance resource and the associated NS     | No Content     |
 329 |         | identifier were deleted successfully.              |                |
 330 +---------+----------------------------------------------------+----------------+
 331
 332 Tags
 333 ~~~~
 334
 335 -  ns
 336
 337 ns heal
 338 -------
 339
 340 ::
 341
 342     POST /ns/{ns_instance_id}/heal
 343
 344 Description
 345 ~~~~~~~~~~~
 346
 347 ns heal
 348
 349 Parameters
 350 ~~~~~~~~~~
 351
 352 +---------+-------------+--------------------------------------+------------------+
 353 | Type    | Name        | Description                          | Schema           |
 354 +=========+=============+======================================+==================+
 355 | **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
 356 | *       | tance\_id** |                                      |                  |
 357 |         | | *required |                                      |                  |
 358 |         | *           |                                      |                  |
 359 +---------+-------------+--------------------------------------+------------------+
 360 | **Body* | | **healVnf | healVnfData                          | `NsHealRequest < |
 361 | *       | Data**      |                                      | #_nshealrequest> |
 362 |         | | *required |                                      | `__              |
 363 |         | *           |                                      |                  |
 364 +---------+-------------+--------------------------------------+------------------+
 365
 366 Responses
 367 ~~~~~~~~~
 368
 369 +---------+----------------------------------------------------+----------------+
 370 | HTTP    | Description                                        | Schema         |
 371 | Code    |                                                    |                |
 372 +=========+====================================================+================+
 373 | **202** |                                                    | `JobInfo <#_jo |
 374 |         |                                                    | binfo>`__      |
 375 +---------+----------------------------------------------------+----------------+
 376 | **404** | URL not found                                      | No Content     |
 377 +---------+----------------------------------------------------+----------------+
 378 | **500** | the url is invalid                                 | No Content     |
 379 +---------+----------------------------------------------------+----------------+
 380
 381 Tags
 382 ~~~~
 383
 384 -  ns
 385
 386 ns terminate
 387 ------------
 388
 389 ::
 390
 391     POST /ns/{ns_instance_id}/terminate
 392
 393 Description
 394 ~~~~~~~~~~~
 395
 396 ns terminate
 397
 398 Parameters
 399 ~~~~~~~~~~
 400
 401 +---------+-------------+--------------------------------------+------------------+
 402 | Type    | Name        | Description                          | Schema           |
 403 +=========+=============+======================================+==================+
 404 | **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
 405 | *       | tance\_id** |                                      |                  |
 406 |         | | *required |                                      |                  |
 407 |         | *           |                                      |                  |
 408 +---------+-------------+--------------------------------------+------------------+
 409 | **Body* | | **NsTermi | NsTerminateRequest                   | `NsTerminateRequ |
 410 | *       | nateRequest |                                      | est <#_nstermina |
 411 |         | **          |                                      | terequest>`__    |
 412 |         | | *required |                                      |                  |
 413 |         | *           |                                      |                  |
 414 +---------+-------------+--------------------------------------+------------------+
 415
 416 Responses
 417 ~~~~~~~~~
 418
 419 +---------+----------------------------------------------------+----------------+
 420 | HTTP    | Description                                        | Schema         |
 421 | Code    |                                                    |                |
 422 +=========+====================================================+================+
 423 | **202** |                                                    | `JobInfo <#_jo |
 424 |         |                                                    | binfo>`__      |
 425 +---------+----------------------------------------------------+----------------+
 426 | **500** | the url is invalid                                 | No Content     |
 427 +---------+----------------------------------------------------+----------------+
 428
 429 Tags
 430 ~~~~
 431
 432 -  ns
 433
 434 Definitions
 435 ===========
 436
 437 JobDetailInfo
 438 -------------
 439
 440 +--------------------------------+-------------------------------------------+
 441 | Name                           | Schema                                    |
 442 +================================+===========================================+
 443 | | **jobId**                    | string                                    |
 444 | | *optional*                   |                                           |
 445 +--------------------------------+-------------------------------------------+
 446 | | **responseDescriptor**       | `responseDescriptor <#_jobdetailinfo_resp |
 447 | | *optional*                   | onsedescriptor>`__                        |
 448 +--------------------------------+-------------------------------------------+
 449
 450 **responseDescriptor**
 451
 452 +--------------------------------+-------------------------------------------+
 453 | Name                           | Schema                                    |
 454 +================================+===========================================+
 455 | | **errorCode**                | string                                    |
 456 | | *optional*                   |                                           |
 457 +--------------------------------+-------------------------------------------+
 458 | | **progress**                 | string                                    |
 459 | | *optional*                   |                                           |
 460 +--------------------------------+-------------------------------------------+
 461 | | **responseHistoryList**      | < `jobResponseInfo <#_jobresponseinfo>`__ |
 462 | | *optional*                   | > array                                   |
 463 +--------------------------------+-------------------------------------------+
 464 | | **responseId**               | string                                    |
 465 | | *optional*                   |                                           |
 466 +--------------------------------+-------------------------------------------+
 467 | | **status**                   | string                                    |
 468 | | *optional*                   |                                           |
 469 +--------------------------------+-------------------------------------------+
 470 | | **statusDescription**        | string                                    |
 471 | | *optional*                   |                                           |
 472 +--------------------------------+-------------------------------------------+
 473
 474 JobInfo
 475 -------
 476
 477 +--------------------------------+-------------------------------------------+
 478 | Name                           | Schema                                    |
 479 +================================+===========================================+
 480 | | **jobId**                    | string                                    |
 481 | | *optional*                   |                                           |
 482 +--------------------------------+-------------------------------------------+
 483
 484 LocationConstraint
 485 ------------------
 486
 487 +--------------------------------+-------------------------------------------+
 488 | Name                           | Schema                                    |
 489 +================================+===========================================+
 490 | | **locationConstraints**      | `locationConstraints <#_locationconstrain |
 491 | | *optional*                   | t_locationconstraints>`__                 |
 492 +--------------------------------+-------------------------------------------+
 493 | | **vnfProfileId**             | string                                    |
 494 | | *optional*                   |                                           |
 495 +--------------------------------+-------------------------------------------+
 496
 497 **locationConstraints**
 498
 499 +--------------------------------+-------------------------------------------+
 500 | Name                           | Schema                                    |
 501 +================================+===========================================+
 502 | | **vimid**                    | string                                    |
 503 | | *optional*                   |                                           |
 504 +--------------------------------+-------------------------------------------+
 505
 506 NsCreateRequest
 507 ---------------
 508
 509 +-------------+---------------------------------------------+------------------+
 510 | Name        | Description                                 | Schema           |
 511 +=============+=============================================+==================+
 512 | | **csarId* | the NS package ID                           | string           |
 513 | *           |                                             |                  |
 514 | | *optional |                                             |                  |
 515 | *           |                                             |                  |
 516 +-------------+---------------------------------------------+------------------+
 517 | | **descrip |                                             | string           |
 518 | tion**      |                                             |                  |
 519 | | *optional |                                             |                  |
 520 | *           |                                             |                  |
 521 +-------------+---------------------------------------------+------------------+
 522 | | **nsName* |                                             | string           |
 523 | *           |                                             |                  |
 524 | | *optional |                                             |                  |
 525 | *           |                                             |                  |
 526 +-------------+---------------------------------------------+------------------+
 527
 528 NsCreateResponse
 529 ----------------
 530
 531 +--------------------------------+-------------------------------------------+
 532 | Name                           | Schema                                    |
 533 +================================+===========================================+
 534 | | **nsInstanceId**             | string                                    |
 535 | | *optional*                   |                                           |
 536 +--------------------------------+-------------------------------------------+
 537
 538 NsHealRequest
 539 -------------
 540
 541 +--------------------------------+-------------------------------------------+
 542 | Name                           | Schema                                    |
 543 +================================+===========================================+
 544 | | **additionalParams**         | `additionalParams <#_nshealrequest_additi |
 545 | | *optional*                   | onalparams>`__                            |
 546 +--------------------------------+-------------------------------------------+
 547 | | **cause**                    | string                                    |
 548 | | *optional*                   |                                           |
 549 +--------------------------------+-------------------------------------------+
 550 | | **vnfInstanceId**            | string                                    |
 551 | | *optional*                   |                                           |
 552 +--------------------------------+-------------------------------------------+
 553
 554 **additionalParams**
 555
 556 +--------------------------------+-------------------------------------------+
 557 | Name                           | Schema                                    |
 558 +================================+===========================================+
 559 | | **action**                   | string                                    |
 560 | | *optional*                   |                                           |
 561 +--------------------------------+-------------------------------------------+
 562 | | **actionvminfo**             | `actionvminfo <#_nshealrequest_actionvmin |
 563 | | *optional*                   | fo>`__                                    |
 564 +--------------------------------+-------------------------------------------+
 565
 566 **actionvminfo**
 567
 568 +--------------------------------+-------------------------------------------+
 569 | Name                           | Schema                                    |
 570 +================================+===========================================+
 571 | | **vmid**                     | string                                    |
 572 | | *optional*                   |                                           |
 573 +--------------------------------+-------------------------------------------+
 574 | | **vmname**                   | string                                    |
 575 | | *optional*                   |                                           |
 576 +--------------------------------+-------------------------------------------+
 577
 578 NsInstanceInfo
 579 --------------
 580
 581 +--------------------------------+-------------------------------------------+
 582 | Name                           | Schema                                    |
 583 +================================+===========================================+
 584 | | **description**              | string                                    |
 585 | | *optional*                   |                                           |
 586 +--------------------------------+-------------------------------------------+
 587 | | **nsInstanceId**             | string                                    |
 588 | | *optional*                   |                                           |
 589 +--------------------------------+-------------------------------------------+
 590 | | **nsName**                   | string                                    |
 591 | | *optional*                   |                                           |
 592 +--------------------------------+-------------------------------------------+
 593 | | **nsState**                  | string                                    |
 594 | | *optional*                   |                                           |
 595 +--------------------------------+-------------------------------------------+
 596 | | **nsdId**                    | string                                    |
 597 | | *optional*                   |                                           |
 598 +--------------------------------+-------------------------------------------+
 599 | | **vlInfo**                   | < `vlInfo <#_vlinfo>`__ > array           |
 600 | | *optional*                   |                                           |
 601 +--------------------------------+-------------------------------------------+
 602 | | **vnfInfo**                  | < `vnfInfo <#_vnfinfo>`__ > array         |
 603 | | *optional*                   |                                           |
 604 +--------------------------------+-------------------------------------------+
 605 | | **vnffgInfo**                | < `vnffgInfo <#_vnffginfo>`__ > array     |
 606 | | *optional*                   |                                           |
 607 +--------------------------------+-------------------------------------------+
 608
 609 NsInstancesInfo
 610 ---------------
 611
 612 *Type* : < `NsInstanceInfo <#_nsinstanceinfo>`__ > array
 613
 614 NsInstantiateRequest
 615 --------------------
 616
 617 +--------------------------------+-------------------------------------------+
 618 | Name                           | Schema                                    |
 619 +================================+===========================================+
 620 | | **LocationConstraints**      | <                                         |
 621 | | *optional*                   | `LocationConstraint <#_locationconstraint |
 622 |                                | >`__                                      |
 623 |                                | > array                                   |
 624 +--------------------------------+-------------------------------------------+
 625 | | **additionalParamForNs**     | string                                    |
 626 | | *optional*                   |                                           |
 627 +--------------------------------+-------------------------------------------+
 628
 629 NsScaleByStepsData
 630 ------------------
 631
 632 +--------------------------------+-------------------------------------------+
 633 | Name                           | Schema                                    |
 634 +================================+===========================================+
 635 | | **aspectId**                 | string                                    |
 636 | | *optional*                   |                                           |
 637 +--------------------------------+-------------------------------------------+
 638 | | **numberOfSteps**            | integer                                   |
 639 | | *optional*                   |                                           |
 640 +--------------------------------+-------------------------------------------+
 641 | | **scalingDirection**         | string                                    |
 642 | | *optional*                   |                                           |
 643 +--------------------------------+-------------------------------------------+
 644
 645 NsScaleRequest
 646 --------------
 647
 648 +--------------------------------+-------------------------------------------+
 649 | Name                           | Schema                                    |
 650 +================================+===========================================+
 651 | | **scaleNsByStepsData**       | `NsScaleByStepsData <#_nsscalebystepsdata |
 652 | | *optional*                   | >`__                                      |
 653 +--------------------------------+-------------------------------------------+
 654 | | **scaleType**                | string                                    |
 655 | | *optional*                   |                                           |
 656 +--------------------------------+-------------------------------------------+
 657
 658 NsTerminateRequest
 659 ------------------
 660
 661 +--------------------------------+-------------------------------------------+
 662 | Name                           | Schema                                    |
 663 +================================+===========================================+
 664 | | **gracefulTerminationTimeout | string                                    |
 665 | **                             |                                           |
 666 | | *optional*                   |                                           |
 667 +--------------------------------+-------------------------------------------+
 668 | | **terminationType**          | string                                    |
 669 | | *optional*                   |                                           |
 670 +--------------------------------+-------------------------------------------+
 671
 672 cpInfo
 673 ------
 674
 675 +--------------------------------+-------------------------------------------+
 676 | Name                           | Schema                                    |
 677 +================================+===========================================+
 678 | | **cpInstanceId**             | string                                    |
 679 | | *optional*                   |                                           |
 680 +--------------------------------+-------------------------------------------+
 681 | | **cpInstanceName**           | string                                    |
 682 | | *optional*                   |                                           |
 683 +--------------------------------+-------------------------------------------+
 684 | | **cpdId**                    | string                                    |
 685 | | *optional*                   |                                           |
 686 +--------------------------------+-------------------------------------------+
 687
 688 jobResponseInfo
 689 ---------------
 690
 691 +--------------------------------+-------------------------------------------+
 692 | Name                           | Schema                                    |
 693 +================================+===========================================+
 694 | | **errorCode**                | string                                    |
 695 | | *optional*                   |                                           |
 696 +--------------------------------+-------------------------------------------+
 697 | | **progress**                 | string                                    |
 698 | | *optional*                   |                                           |
 699 +--------------------------------+-------------------------------------------+
 700 | | **responseId**               | string                                    |
 701 | | *optional*                   |                                           |
 702 +--------------------------------+-------------------------------------------+
 703 | | **status**                   | string                                    |
 704 | | *optional*                   |                                           |
 705 +--------------------------------+-------------------------------------------+
 706 | | **statusDescription**        | string                                    |
 707 | | *optional*                   |                                           |
 708 +--------------------------------+-------------------------------------------+
 709
 710 vlInfo
 711 ------
 712
 713 +--------------------------------+-------------------------------------------+
 714 | Name                           | Schema                                    |
 715 +================================+===========================================+
 716 | | **relatedCpInstanceId**      | < `cpInfo <#_cpinfo>`__ > array           |
 717 | | *optional*                   |                                           |
 718 +--------------------------------+-------------------------------------------+
 719 | | **vlInstanceId**             | string                                    |
 720 | | *optional*                   |                                           |
 721 +--------------------------------+-------------------------------------------+
 722 | | **vlInstanceName**           | string                                    |
 723 | | *optional*                   |                                           |
 724 +--------------------------------+-------------------------------------------+
 725 | | **vldId**                    | string                                    |
 726 | | *optional*                   |                                           |
 727 +--------------------------------+-------------------------------------------+
 728
 729 vnfInfo
 730 -------
 731
 732 +--------------------------------+-------------------------------------------+
 733 | Name                           | Schema                                    |
 734 +================================+===========================================+
 735 | | **vnfInstanceId**            | string                                    |
 736 | | *optional*                   |                                           |
 737 +--------------------------------+-------------------------------------------+
 738 | | **vnfInstanceName**          | string                                    |
 739 | | *optional*                   |                                           |
 740 +--------------------------------+-------------------------------------------+
 741 | | **vnfdId**                   | string                                    |
 742 | | *optional*                   |                                           |
 743 +--------------------------------+-------------------------------------------+
 744
 745 vnffgInfo
 746 ---------
 747
 748 +--------------------------------+-------------------------------------------+
 749 | Name                           | Schema                                    |
 750 +================================+===========================================+
 751 | | **cpId**                     | string                                    |
 752 | | *optional*                   |                                           |
 753 +--------------------------------+-------------------------------------------+
 754 | | **nfp**                      | string                                    |
 755 | | *optional*                   |                                           |
 756 +--------------------------------+-------------------------------------------+
 757 | | **pnfId**                    | string                                    |
 758 | | *optional*                   |                                           |
 759 +--------------------------------+-------------------------------------------+
 760 | | **virtualLinkId**            | string                                    |
 761 | | *optional*                   |                                           |
 762 +--------------------------------+-------------------------------------------+
 763 | | **vnfId**                    | string                                    |
 764 | | *optional*                   |                                           |
 765 +--------------------------------+-------------------------------------------+
 766 | | **vnffgInstanceId**          | string                                    |
 767 | | *optional*                   |                                           |
 768 +--------------------------------+-------------------------------------------+