docs/SO_R1_Interface.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 Huawei Technologies Co., Ltd.
   4
   5 SO Amsterdam Interfaces
   6 ================
   7
   8 .. image:: images/SO_R1_1.png
   9
  10 SO APIs
  11 ============
  12
  13 North Bound APIs
  14 ----------------
  15 Create service instance
  16 ++++++++++++++++++++++++
  17
  18 +--------------------+-------------------------------------+
  19 |Interface Definition|Description                          |
  20 +====================+=====================================+
  21 |URI                 |{serverRoot}/serviceInstances/v4     |
  22 +--------------------+-------------------------------------+
  23 |Operation Type      |POST                                 |
  24 +--------------------+-------------------------------------+
  25 |Content-Type        |application/json                     |
  26 +--------------------+-------------------------------------+
  27
  28 Request Body:
  29
  30 +----------------+---------+-----------+--------------------------+-------------------------------------------+
  31 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
  32 +================+=========+===========+==========================+===========================================+
  33 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
  34 +----------------+---------+-----------+--------------------------+-------------------------------------------+
  35
  36 RequestDetails Object
  37
  38 +-------------------+--------------------------+-------------------------------------------------+
  39 |Attribute          |Content                   |Description                                      |
  40 +===================+==========================+=================================================+
  41 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
  42 +-------------------+--------------------------+-------------------------------------------------+
  43 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
  44 +-------------------+--------------------------+-------------------------------------------------+
  45 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
  46 +-------------------+--------------------------+-------------------------------------------------+
  47 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
  48 +-------------------+--------------------------+-------------------------------------------------+
  49 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
  50 +-------------------+--------------------------+-------------------------------------------------+
  51 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
  52 +-------------------+--------------------------+-------------------------------------------------+
  53 |project            |project Object            |Content of project object.                       |
  54 +-------------------+--------------------------+-------------------------------------------------+
  55 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
  56 +-------------------+--------------------------+-------------------------------------------------+
  57 |platform           |platform Object           |Content of platform object.                      |
  58 +-------------------+--------------------------+-------------------------------------------------+
  59 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
  60 +-------------------+--------------------------+-------------------------------------------------+
  61
  62 ModelInfo Object
  63
  64 +-------------------------+------------------+-------------------------------------------------+
  65 |Attribute                |Content           |Description                                      |
  66 +=========================+==================+=================================================+
  67 |ModelType                |String            |Type of model                                    |
  68 +-------------------------+------------------+-------------------------------------------------+
  69 |ModelInvariantId         |String            |The Model Invariant Id.                          |
  70 +-------------------------+------------------+-------------------------------------------------+
  71 |ModelNameVersionId       |String            |The modelname Version Id                         |
  72 +-------------------------+------------------+-------------------------------------------------+
  73 |ModelName                |String            |Name of the Model                                |
  74 +-------------------------+------------------+-------------------------------------------------+
  75 |ModelVersion             |String            |Version of the model                             |
  76 +-------------------------+------------------+-------------------------------------------------+
  77 |ModelCustomization Name  |String            |The Model Customization name                     |
  78 +-------------------------+------------------+-------------------------------------------------+
  79 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
  80 +-------------------------+------------------+-------------------------------------------------+
  81 |modelVersionId           |String            |The Model version id                             |
  82 +-------------------------+------------------+-------------------------------------------------+
  83 |modelUuid                |String            |The Model UUid                                   |
  84 +-------------------------+------------------+-------------------------------------------------+
  85 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
  86 +-------------------------+------------------+-------------------------------------------------+
  87 |modelInstanceName        |String            |The Model Instance  name                         |
  88 +-------------------------+------------------+-------------------------------------------------+
  89
  90
  91 SubscriberInfo Object
  92
  93 +-------------------------+------------------+-------------------------------------------------+
  94 |Attribute                |Content           |Description                                      |
  95 +=========================+==================+=================================================+
  96 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
  97 +-------------------------+------------------+-------------------------------------------------+
  98 |SubscriberName           |String            |Name of the Subscriber                           |
  99 +-------------------------+------------------+-------------------------------------------------+
 100
 101 RequestInfo Object
 102
 103 +-------------------------+------------------+-------------------------------------------------+
 104 |Attribute                |Content           |Description                                      |
 105 +=========================+==================+=================================================+
 106 |Source                   |String            |source of the request                            |
 107 +-------------------------+------------------+-------------------------------------------------+
 108 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 109 +-------------------------+------------------+-------------------------------------------------+
 110 |callbackUrl              |String            |callbackUrl of the request                       |
 111 +-------------------------+------------------+-------------------------------------------------+
 112 |correlator               |String            |correlator of the request                        |
 113 +-------------------------+------------------+-------------------------------------------------+
 114 |orderNumber              |String            |orderNumber of the request                       |
 115 +-------------------------+------------------+-------------------------------------------------+
 116 |productFamilyId          |String            |productFamilyId of the request                   |
 117 +-------------------------+------------------+-------------------------------------------------+
 118 |orderVersion             |String            |orderVersion of the request                      |
 119 +-------------------------+------------------+-------------------------------------------------+
 120 |instanceName             |String            |instanceName of the request                      |
 121 +-------------------------+------------------+-------------------------------------------------+
 122 |suppressRollback         |String            |suppressRollback of the request                  |
 123 +-------------------------+------------------+-------------------------------------------------+
 124 |requestorId              |String            |requestorId of the request                       |
 125 +-------------------------+------------------+-------------------------------------------------+
 126
 127 RequestParameters Object
 128
 129 +-------------------------+------------------+-------------------------------------------------+
 130 |Attribute                |Content           |Description                                      |
 131 +=========================+==================+=================================================+
 132 |SubscriptionServiceType  |String            |The service type of the Subscription             |
 133 +-------------------------+------------------+-------------------------------------------------+
 134 |UserParams               |Array             |The product family Id.                           |
 135 +-------------------------+------------------+-------------------------------------------------+
 136 |aLaCarte                 |Boolean           | aLaCarte                                        |
 137 +-------------------------+------------------+-------------------------------------------------+
 138 |autoBuildVfModules       |Boolean           |autoBuildVfModules                               |
 139 +-------------------------+------------------+-------------------------------------------------+
 140 |cascadeDelete            |Boolean           |cascadeDelete                                    |
 141 +-------------------------+------------------+-------------------------------------------------+
 142 |usePreload               |Boolean           |usePreload                                       |
 143 +-------------------------+------------------+-------------------------------------------------+
 144 |rebuildVolumeGroups      |Boolean           |rebuildVolumeGroups                              |
 145 +-------------------------+------------------+-------------------------------------------------+
 146 |payload                  |String            |payload                                          |
 147 +-------------------------+------------------+-------------------------------------------------+
 148 |controllerType           |String            |controllerType                                   |
 149 +-------------------------+------------------+-------------------------------------------------+
 150
 151 UserParams Object
 152
 153 +-------------------------+------------------+-------------------------------------------------+
 154 |Attribute                |Content           |Description                                      |
 155 +=========================+==================+=================================================+
 156 |name                     |String            |Tag name of attribute                            |
 157 +-------------------------+------------------+-------------------------------------------------+
 158 |value                    |String            |Value of the tag                                 |
 159 +-------------------------+------------------+-------------------------------------------------+
 160
 161 CloudConfiguration Object
 162
 163 +-------------------------+------------------+-------------------------------------------------+
 164 |Attribute                |Content           |Description                                      |
 165 +=========================+==================+=================================================+
 166 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 167 +-------------------------+------------------+-------------------------------------------------+
 168 |tenantId                 |String            |Name of the Subscriber                           |
 169 +-------------------------+------------------+-------------------------------------------------+
 170 |aicNodeClli              |String            |aicNodeClli property                             |
 171 +-------------------------+------------------+-------------------------------------------------+
 172
 173 Project Object
 174
 175 +-------------------------+------------------+-------------------------------------------------+
 176 |Attribute                |Content           |Description                                      |
 177 +=========================+==================+=================================================+
 178 |projectName              |String            |Name of the project                              |
 179 +-------------------------+------------------+-------------------------------------------------+
 180
 181 OwningEntity Object
 182
 183 +-------------------------+------------------+-------------------------------------------------+
 184 |Attribute                |Content           |Description                                      |
 185 +=========================+==================+=================================================+
 186 |owningEntityId           |String            |owningEntityId of the owingEntity                |
 187 +-------------------------+------------------+-------------------------------------------------+
 188 |owningEntityName         |String            |owningEntityName of the owingEntity              |
 189 +-------------------------+------------------+-------------------------------------------------+
 190
 191 Platform Object
 192
 193 +-------------------------+------------------+-------------------------------------------------+
 194 |Attribute                |Content           |Description                                      |
 195 +=========================+==================+=================================================+
 196 |platformName             |String            |Platform Name                                    |
 197 +-------------------------+------------------+-------------------------------------------------+
 198
 199 LineOfBusiness Object
 200 +-------------------------+------------------+-------------------------------------------------+
 201 |Attribute                |Content           |Description                                      |
 202 +=========================+==================+=================================================+
 203 |lineOfBusinessName       |String            |Line Of Business Name                            |
 204 +-------------------------+------------------+-------------------------------------------------+
 205
 206 Delete service instance
 207 ++++++++++++++++++++++++
 208
 209 +--------------------+---------------------------------------------------------+
 210 |Interface Definition|Description                                              |
 211 +====================+=========================================================+
 212 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}     |
 213 +--------------------+---------------------------------------------------------+
 214 |Operation Type      |DELETE                                                   |
 215 +--------------------+---------------------------------------------------------+
 216 |Content-Type        |application/json                                         |
 217 +--------------------+---------------------------------------------------------+
 218
 219 Request Body:
 220
 221 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 222 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 223 +================+=========+===========+==========================+===========================================+
 224 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 225 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 226
 227 RequestDetails Object
 228
 229 +-------------------+-------------------------+-------------------------------------------------+
 230 |Attribute          |Content                  |Description                                      |
 231 +===================+=========================+=================================================+
 232 |modelInfo          |modelInfo Object         |Content of modelInfo object.                     |
 233 +-------------------+-------------------------+-------------------------------------------------+
 234 |requestInfo        |requestInfo Object       |Content of requestInfo object.                   |
 235 +-------------------+-------------------------+-------------------------------------------------+
 236
 237 ModelInfo Object
 238
 239 +-------------------------+------------------+-------------------------------------------------+
 240 |Attribute                |Content           |Description                                      |
 241 +=========================+==================+=================================================+
 242 |ModelType                |String            |Type of model                                    |
 243 +-------------------------+------------------+-------------------------------------------------+
 244 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 245 +-------------------------+------------------+-------------------------------------------------+
 246 |ModelName                |String            |Name of the Model                                |
 247 +-------------------------+------------------+-------------------------------------------------+
 248 |ModelVersion             |String            |Version of the model                             |
 249 +-------------------------+------------------+-------------------------------------------------+
 250
 251 RequestInfo Object
 252
 253 +-------------------------+------------------+-------------------------------------------------+
 254 |Attribute                |Content           |Description                                      |
 255 +=========================+==================+=================================================+
 256 |Source                   |String            |source of the request                            |
 257 +-------------------------+------------------+-------------------------------------------------+
 258
 259 Create Volume Group
 260 ++++++++++++++++++++++++
 261
 262 +--------------------+-------------------------------------------------------------------------------------------+
 263 |Interface Definition|Description                                                                                |
 264 +====================+===========================================================================================+
 265 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups     |
 266 +--------------------+-------------------------------------------------------------------------------------------+
 267 |Operation Type      |POST                                                                                       |
 268 +--------------------+-------------------------------------------------------------------------------------------+
 269 |Content-Type        |application/json                                                                           |
 270 +--------------------+-------------------------------------------------------------------------------------------+
 271
 272 Request Body:
 273
 274 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 275 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 276 +================+=========+===========+==========================+===========================================+
 277 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 278 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 279
 280 RequestDetails Object
 281
 282 +-------------------+--------------------------+-------------------------------------------------+
 283 |Attribute          |Content                   |Description                                      |
 284 +===================+==========================+=================================================+
 285 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 286 +-------------------+--------------------------+-------------------------------------------------+
 287 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 288 +-------------------+--------------------------+-------------------------------------------------+
 289 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 290 +-------------------+--------------------------+-------------------------------------------------+
 291 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 292 +-------------------+--------------------------+-------------------------------------------------+
 293 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 294 +-------------------+--------------------------+-------------------------------------------------+
 295 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 296 +-------------------+--------------------------+-------------------------------------------------+
 297 |project            |project Object            |Content of project object.                       |
 298 +-------------------+--------------------------+-------------------------------------------------+
 299 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 300 +-------------------+--------------------------+-------------------------------------------------+
 301 |platform           |platform Object           |Content of platform object.                      |
 302 +-------------------+--------------------------+-------------------------------------------------+
 303 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 304 +-------------------+--------------------------+-------------------------------------------------+
 305
 306 ModelInfo Object
 307
 308 +-------------------------+------------------+-------------------------------------------------+
 309 |Attribute                |Content           |Description                                      |
 310 +=========================+==================+=================================================+
 311 |ModelType                |String            |Type of model                                    |
 312 +-------------------------+------------------+-------------------------------------------------+
 313 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 314 +-------------------------+------------------+-------------------------------------------------+
 315 |ModelNameVersionId       |String            |The modelname Version Id                         |
 316 +-------------------------+------------------+-------------------------------------------------+
 317 |ModelName                |String            |Name of the Model                                |
 318 +-------------------------+------------------+-------------------------------------------------+
 319 |ModelVersion             |String            |Version of the model                             |
 320 +-------------------------+------------------+-------------------------------------------------+
 321 |ModelCustomization Name  |String            |The Model Customization name                     |
 322 +-------------------------+------------------+-------------------------------------------------+
 323 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 324 +-------------------------+------------------+-------------------------------------------------+
 325 |modelVersionId           |String            |The Model version id                             |
 326 +-------------------------+------------------+-------------------------------------------------+
 327 |modelUuid                |String            |The Model UUid                                   |
 328 +-------------------------+------------------+-------------------------------------------------+
 329 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 330 +-------------------------+------------------+-------------------------------------------------+
 331 |modelInstanceName        |String            |The Model Instance  name                         |
 332 +-------------------------+------------------+-------------------------------------------------+
 333
 334 CloudConfiguration Object
 335
 336 +-------------------------+------------------+-------------------------------------------------+
 337 |Attribute                |Content           |Description                                      |
 338 +=========================+==================+=================================================+
 339 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 340 +-------------------------+------------------+-------------------------------------------------+
 341 |tenantId                 |String            |Name of the Subscriber                           |
 342 +-------------------------+------------------+-------------------------------------------------+
 343 |aicNodeClli              |String            |aicNodeClli property                             |
 344 +-------------------------+------------------+-------------------------------------------------+
 345
 346 RequestInfo Object
 347
 348 +-------------------------+------------------+-------------------------------------------------+
 349 |Attribute                |Content           |Description                                      |
 350 +=========================+==================+=================================================+
 351 |Source                   |String            |source of the request                            |
 352 +-------------------------+------------------+-------------------------------------------------+
 353 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 354 +-------------------------+------------------+-------------------------------------------------+
 355 |callbackUrl              |String            |callbackUrl of the request                       |
 356 +-------------------------+------------------+-------------------------------------------------+
 357 |correlator               |String            |correlator of the request                        |
 358 +-------------------------+------------------+-------------------------------------------------+
 359 |orderNumber              |String            |orderNumber of the request                       |
 360 +-------------------------+------------------+-------------------------------------------------+
 361 |productFamilyId          |String            |productFamilyId of the request                   |
 362 +-------------------------+------------------+-------------------------------------------------+
 363 |orderVersion             |String            |orderVersion of the request                      |
 364 +-------------------------+------------------+-------------------------------------------------+
 365 |instanceName             |String            |instanceName of the request                      |
 366 +-------------------------+------------------+-------------------------------------------------+
 367 |suppressRollback         |String            |suppressRollback of the request                  |
 368 +-------------------------+------------------+-------------------------------------------------+
 369 |requestorId              |String            |requestorId of the request                       |
 370 +-------------------------+------------------+-------------------------------------------------+
 371
 372 relatedInstance List
 373
 374 +-------------------------+------------------+-------------------------------------------------+
 375 |Attribute                |Content           |Description                                      |
 376 +=========================+==================+=================================================+
 377 |relatedInstance          |Object            |relatedInstance Object                           |
 378 +-------------------------+------------------+-------------------------------------------------+
 379
 380 relatedInstance List
 381
 382 +-------------------------+------------------+-------------------------------------------------+
 383 |Attribute                |Content           |Description                                      |
 384 +=========================+==================+=================================================+
 385 |instanceId               |String            |instanceId                                       |
 386 +-------------------------+------------------+-------------------------------------------------+
 387 |modelInfo                |Object            |Content of modelInfo object.                     |
 388 +-------------------------+------------------+-------------------------------------------------+
 389
 390 Delete Volume Group
 391 ++++++++++++++++++++++++
 392
 393 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 394 |Interface Definition|Description                                                                                                          |
 395 +====================+=====================================================================================================================+
 396 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id}     |
 397 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 398 |Operation Type      |DELETE                                                                                                               |
 399 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 400 |Content-Type        |application/json                                                                                                     |
 401 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 402
 403 Request Body:
 404
 405 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 406 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 407 +================+=========+===========+==========================+===========================================+
 408 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 409 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 410
 411 RequestDetails Object
 412
 413 +---------------------+-------------------------+-------------------------------------------------+
 414 |Attribute            |Content                  |Description                                      |
 415 +=====================+=========================+=================================================+
 416 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 417 +---------------------+-------------------------+-------------------------------------------------+
 418 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 419 +---------------------+-------------------------+-------------------------------------------------+
 420 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 421 +---------------------+-------------------------+-------------------------------------------------+
 422
 423 ModelInfo Object
 424
 425 +-------------------------+------------------+-------------------------------------------------+
 426 |Attribute                |Content           |Description                                      |
 427 +=========================+==================+=================================================+
 428 |ModelType                |String            |Type of model                                    |
 429 +-------------------------+------------------+-------------------------------------------------+
 430 |ModelName                |String            |Name of the Model                                |
 431 +-------------------------+------------------+-------------------------------------------------+
 432
 433 CloudConfiguration Object
 434
 435 +-------------------------+------------------+-------------------------------------------------+
 436 |Attribute                |Content           |Description                                      |
 437 +=========================+==================+=================================================+
 438 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 439 +-------------------------+------------------+-------------------------------------------------+
 440 |tenantId                 |String            |Name of the Subscriber                           |
 441 +-------------------------+------------------+-------------------------------------------------+
 442
 443 RequestInfo Object
 444
 445 +-------------------------+------------------+-------------------------------------------------+
 446 |Attribute                |Content           |Description                                      |
 447 +=========================+==================+=================================================+
 448 |Source                   |String            |source of the request                            |
 449 +-------------------------+------------------+-------------------------------------------------+
 450
 451 Create VF Module
 452 +++++++++++++++++
 453
 454 +--------------------+----------------------------------------------------------------------------------------+
 455 |Interface Definition|Description                                                                             |
 456 +====================+========================================================================================+
 457 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules     |
 458 +--------------------+----------------------------------------------------------------------------------------+
 459 |Operation Type      |POST                                                                                    |
 460 +--------------------+----------------------------------------------------------------------------------------+
 461 |Content-Type        |application/json                                                                        |
 462 +--------------------+----------------------------------------------------------------------------------------+
 463
 464 Request Body:
 465
 466 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 467 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 468 +================+=========+===========+==========================+===========================================+
 469 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 470 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 471
 472 RequestDetails Object
 473
 474 +---------------------+-------------------------+-------------------------------------------------+
 475 |Attribute            |Content                  |Description                                      |
 476 +=====================+=========================+=================================================+
 477 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 478 +---------------------+-------------------------+-------------------------------------------------+
 479 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 480 +---------------------+-------------------------+-------------------------------------------------+
 481 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 482 +---------------------+-------------------------+-------------------------------------------------+
 483 |relatedInstanceList  |List                     |Content of relatedInstanceList.                  |
 484 +---------------------+-------------------------+-------------------------------------------------+
 485
 486 ModelInfo Object
 487
 488 +-------------------------+------------------+-------------------------------------------------+
 489 |Attribute                |Content           |Description                                      |
 490 +=========================+==================+=================================================+
 491 |ModelType                |String            |Type of model                                    |
 492 +-------------------------+------------------+-------------------------------------------------+
 493 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 494 +-------------------------+------------------+-------------------------------------------------+
 495 |ModelNameVersionId       |String            |The modelname Version Id                         |
 496 +-------------------------+------------------+-------------------------------------------------+
 497 |ModelName                |String            |Name of the Model                                |
 498 +-------------------------+------------------+-------------------------------------------------+
 499 |ModelVersion             |String            |Version of the model                             |
 500 +-------------------------+------------------+-------------------------------------------------+
 501 |ModelCustomization Name  |String            |The Model Customization name                     |
 502 +-------------------------+------------------+-------------------------------------------------+
 503
 504 CloudConfiguration Object
 505
 506 +-------------------------+------------------+-------------------------------------------------+
 507 |Attribute                |Content           |Description                                      |
 508 +=========================+==================+=================================================+
 509 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 510 +-------------------------+------------------+-------------------------------------------------+
 511 |tenantId                 |String            |Name of the Subscriber                           |
 512 +-------------------------+------------------+-------------------------------------------------+
 513
 514 RequestInfo Object
 515
 516 +-------------------------+------------------+-------------------------------------------------+
 517 |Attribute                |Content           |Description                                      |
 518 +=========================+==================+=================================================+
 519 |InstanceName             |String            |The instance Name                                |
 520 +-------------------------+------------------+-------------------------------------------------+
 521 |Source                   |String            |source of the request                            |
 522 +-------------------------+------------------+-------------------------------------------------+
 523 |SuppressRollback         |Boolean           |SuppressRollback                                 |
 524 +-------------------------+------------------+-------------------------------------------------+
 525
 526 relatedInstance List
 527
 528 +-------------------------+------------------+-------------------------------------------------+
 529 |Attribute                |Content           |Description                                      |
 530 +=========================+==================+=================================================+
 531 |relatedInstance          |Object            |relatedInstance Object                           |
 532 +-------------------------+------------------+-------------------------------------------------+
 533
 534 relatedInstance List
 535
 536 +-------------------------+------------------+-------------------------------------------------+
 537 |Attribute                |Content           |Description                                      |
 538 +=========================+==================+=================================================+
 539 |instanceId               |String            |instanceId                                       |
 540 +-------------------------+------------------+-------------------------------------------------+
 541 |modelInfo                |Object            |Content of modelInfo object.                     |
 542 +-------------------------+------------------+-------------------------------------------------+
 543 |instanceName             |String            |Name of the instance                             |
 544 +-------------------------+------------------+-------------------------------------------------+
 545
 546 Delete VF Module
 547 ++++++++++++++++++++++++
 548
 549 +--------------------+--------------------------------------------------------------------------------------------------------------+
 550 |Interface Definition|Description                                                                                                   |
 551 +====================+==============================================================================================================+
 552 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id}     |
 553 +--------------------+--------------------------------------------------------------------------------------------------------------+
 554 |Operation Type      |DELETE                                                                                                        |
 555 +--------------------+--------------------------------------------------------------------------------------------------------------+
 556 |Content-Type        |application/json                                                                                              |
 557 +--------------------+--------------------------------------------------------------------------------------------------------------+
 558
 559 Request Body:
 560
 561 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 562 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 563 +================+=========+===========+==========================+===========================================+
 564 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 565 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 566
 567 RequestDetails Object
 568
 569 +---------------------+-------------------------+-------------------------------------------------+
 570 |Attribute            |Content                  |Description                                      |
 571 +=====================+=========================+=================================================+
 572 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 573 +---------------------+-------------------------+-------------------------------------------------+
 574 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 575 +---------------------+-------------------------+-------------------------------------------------+
 576 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 577 +---------------------+-------------------------+-------------------------------------------------+
 578
 579 ModelInfo Object
 580
 581 +-------------------------+------------------+-------------------------------------------------+
 582 |Attribute                |Content           |Description                                      |
 583 +=========================+==================+=================================================+
 584 |ModelType                |String            |Type of model                                    |
 585 +-------------------------+------------------+-------------------------------------------------+
 586 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 587 +-------------------------+------------------+-------------------------------------------------+
 588 |ModelNameVersionId       |String            |The modelname Version Id                         |
 589 +-------------------------+------------------+-------------------------------------------------+
 590 |ModelName                |String            |Name of the Model                                |
 591 +-------------------------+------------------+-------------------------------------------------+
 592 |ModelVersion             |String            |Version of the model                             |
 593 +-------------------------+------------------+-------------------------------------------------+
 594 |ModelCustomization Name  |String            |The Model Customization name                     |
 595 +-------------------------+------------------+-------------------------------------------------+
 596
 597 CloudConfiguration Object
 598
 599 +-------------------------+------------------+-------------------------------------------------+
 600 |Attribute                |Content           |Description                                      |
 601 +=========================+==================+=================================================+
 602 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 603 +-------------------------+------------------+-------------------------------------------------+
 604 |tenantId                 |String            |Name of the Subscriber                           |
 605 +-------------------------+------------------+-------------------------------------------------+
 606
 607 RequestInfo Object
 608
 609 +-------------------------+------------------+-------------------------------------------------+
 610 |Attribute                |Content           |Description                                      |
 611 +=========================+==================+=================================================+
 612 |Source                   |String            |source of the request                            |
 613 +-------------------------+------------------+-------------------------------------------------+
 614
 615 Create VNF
 616 +++++++++++++++
 617
 618 +--------------------+--------------------------------------------------------------+
 619 |Interface Definition|Description                                                   |
 620 +====================+==============================================================+
 621 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs     |
 622 +--------------------+--------------------------------------------------------------+
 623 |Operation Type      |POST                                                          |
 624 +--------------------+--------------------------------------------------------------+
 625 |Content-Type        |application/json                                              |
 626 +--------------------+--------------------------------------------------------------+
 627
 628 Request Body:
 629
 630 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 631 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 632 +================+=========+===========+==========================+===========================================+
 633 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 634 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 635
 636 RequestDetails Object
 637
 638 +-------------------+--------------------------+-------------------------------------------------+
 639 |Attribute          |Content                   |Description                                      |
 640 +===================+==========================+=================================================+
 641 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 642 +-------------------+--------------------------+-------------------------------------------------+
 643 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 644 +-------------------+--------------------------+-------------------------------------------------+
 645 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 646 +-------------------+--------------------------+-------------------------------------------------+
 647 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 648 +-------------------+--------------------------+-------------------------------------------------+
 649 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 650 +-------------------+--------------------------+-------------------------------------------------+
 651 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 652 +-------------------+--------------------------+-------------------------------------------------+
 653 |project            |project Object            |Content of project object.                       |
 654 +-------------------+--------------------------+-------------------------------------------------+
 655 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 656 +-------------------+--------------------------+-------------------------------------------------+
 657 |platform           |platform Object           |Content of platform object.                      |
 658 +-------------------+--------------------------+-------------------------------------------------+
 659 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 660 +-------------------+--------------------------+-------------------------------------------------+
 661
 662 ModelInfo Object
 663
 664 +-------------------------+------------------+-------------------------------------------------+
 665 |Attribute                |Content           |Description                                      |
 666 +=========================+==================+=================================================+
 667 |ModelType                |String            |Type of model                                    |
 668 +-------------------------+------------------+-------------------------------------------------+
 669 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 670 +-------------------------+------------------+-------------------------------------------------+
 671 |ModelNameVersionId       |String            |The modelname Version Id                         |
 672 +-------------------------+------------------+-------------------------------------------------+
 673 |ModelName                |String            |Name of the Model                                |
 674 +-------------------------+------------------+-------------------------------------------------+
 675 |ModelVersion             |String            |Version of the model                             |
 676 +-------------------------+------------------+-------------------------------------------------+
 677 |ModelCustomization Name  |String            |The Model Customization name                     |
 678 +-------------------------+------------------+-------------------------------------------------+
 679 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 680 +-------------------------+------------------+-------------------------------------------------+
 681 |modelVersionId           |String            |The Model version id                             |
 682 +-------------------------+------------------+-------------------------------------------------+
 683 |modelUuid                |String            |The Model UUid                                   |
 684 +-------------------------+------------------+-------------------------------------------------+
 685 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 686 +-------------------------+------------------+-------------------------------------------------+
 687 |modelInstanceName        |String            |The Model Instance  name                         |
 688 +-------------------------+------------------+-------------------------------------------------+
 689
 690 CloudConfiguration Object
 691
 692 +-------------------------+------------------+-------------------------------------------------+
 693 |Attribute                |Content           |Description                                      |
 694 +=========================+==================+=================================================+
 695 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 696 +-------------------------+------------------+-------------------------------------------------+
 697 |tenantId                 |String            |Name of the Subscriber                           |
 698 +-------------------------+------------------+-------------------------------------------------+
 699
 700 RequestInfo Object
 701
 702 +-------------------------+------------------+-------------------------------------------------+
 703 |Attribute                |Content           |Description                                      |
 704 +=========================+==================+=================================================+
 705 |Source                   |String            |source of the request                            |
 706 +-------------------------+------------------+-------------------------------------------------+
 707 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 708 +-------------------------+------------------+-------------------------------------------------+
 709 |callbackUrl              |String            |callbackUrl of the request                       |
 710 +-------------------------+------------------+-------------------------------------------------+
 711 |correlator               |String            |correlator of the request                        |
 712 +-------------------------+------------------+-------------------------------------------------+
 713 |orderNumber              |String            |orderNumber of the request                       |
 714 +-------------------------+------------------+-------------------------------------------------+
 715 |productFamilyId          |String            |productFamilyId of the request                   |
 716 +-------------------------+------------------+-------------------------------------------------+
 717 |orderVersion             |String            |orderVersion of the request                      |
 718 +-------------------------+------------------+-------------------------------------------------+
 719 |instanceName             |String            |instanceName of the request                      |
 720 +-------------------------+------------------+-------------------------------------------------+
 721 |suppressRollback         |String            |suppressRollback of the request                  |
 722 +-------------------------+------------------+-------------------------------------------------+
 723 |requestorId              |String            |requestorId of the request                       |
 724 +-------------------------+------------------+-------------------------------------------------+
 725
 726 relatedInstance List
 727
 728 +-------------------------+------------------+-------------------------------------------------+
 729 |Attribute                |Content           |Description                                      |
 730 +=========================+==================+=================================================+
 731 |relatedInstance          |Object            |relatedInstance Object                           |
 732 +-------------------------+------------------+-------------------------------------------------+
 733
 734 relatedInstance List
 735
 736 +-------------------------+------------------+-------------------------------------------------+
 737 |Attribute                |Content           |Description                                      |
 738 +=========================+==================+=================================================+
 739 |instanceId               |String            |instanceId                                       |
 740 +-------------------------+------------------+-------------------------------------------------+
 741 |modelInfo                |Object            |Content of modelInfo object.                     |
 742 +-------------------------+------------------+-------------------------------------------------+
 743
 744 RequestParameters Object
 745
 746 +-------------------------+------------------+-------------------------------------------------+
 747 |Attribute                |Content           |Description                                      |
 748 +=========================+==================+=================================================+
 749 |UserParams               |Array             |The product family Id.                           |
 750 +-------------------------+------------------+-------------------------------------------------+
 751
 752 UserParams Object
 753
 754 +-------------------------+------------------+-------------------------------------------------+
 755 |Attribute                |Content           |Description                                      |
 756 +=========================+==================+=================================================+
 757 |name                     |String            |Tag name of attribute                            |
 758 +-------------------------+------------------+-------------------------------------------------+
 759 |value                    |String            |Value of the tag                                 |
 760 +-------------------------+------------------+-------------------------------------------------+
 761
 762 Delete VNF
 763 +++++++++++++++
 764
 765 +--------------------+------------------------------------------------------------------------------+
 766 |Interface Definition|Description                                                                   |
 767 +====================+==============================================================================+
 768 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}     |
 769 +--------------------+------------------------------------------------------------------------------+
 770 |Operation Type      |DELETE                                                                        |
 771 +--------------------+------------------------------------------------------------------------------+
 772 |Content-Type        |application/json                                                              |
 773 +--------------------+------------------------------------------------------------------------------+
 774
 775 Request Body:
 776
 777 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 778 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 779 +================+=========+===========+==========================+===========================================+
 780 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 781 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 782
 783 RequestDetails Object
 784
 785 +---------------------+-------------------------+-------------------------------------------------+
 786 |Attribute            |Content                  |Description                                      |
 787 +=====================+=========================+=================================================+
 788 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 789 +---------------------+-------------------------+-------------------------------------------------+
 790 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 791 +---------------------+-------------------------+-------------------------------------------------+
 792 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 793 +---------------------+-------------------------+-------------------------------------------------+
 794 |requestParameters    |requestParameters Object |Content of requestParameters object.             |
 795 +---------------------+-------------------------+-------------------------------------------------+
 796
 797 ModelInfo Object
 798
 799 +-------------------------+------------------+-------------------------------------------------+
 800 |Attribute                |Content           |Description                                      |
 801 +=========================+==================+=================================================+
 802 |ModelType                |String            |Type of model                                    |
 803 +-------------------------+------------------+-------------------------------------------------+
 804 |ModelName                |String            |Name of the Model                                |
 805 +-------------------------+------------------+-------------------------------------------------+
 806
 807 CloudConfiguration Object
 808
 809 +-------------------------+------------------+-------------------------------------------------+
 810 |Attribute                |Content           |Description                                      |
 811 +=========================+==================+=================================================+
 812 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 813 +-------------------------+------------------+-------------------------------------------------+
 814 |tenantId                 |String            |Name of the Subscriber                           |
 815 +-------------------------+------------------+-------------------------------------------------+
 816
 817 RequestInfo Object
 818
 819 +-------------------------+------------------+-------------------------------------------------+
 820 |Attribute                |Content           |Description                                      |
 821 +=========================+==================+=================================================+
 822 |Source                   |String            |source of the request                            |
 823 +-------------------------+------------------+-------------------------------------------------+
 824
 825 RequestParameters Object
 826
 827 +-------------------------+------------------+-------------------------------------------------+
 828 |Attribute                |Content           |Description                                      |
 829 +=========================+==================+=================================================+
 830 |UserParams               |Array             |The product family Id.                           |
 831 +-------------------------+------------------+-------------------------------------------------+
 832
 833 UserParams Object
 834
 835 +-------------------------+------------------+-------------------------------------------------+
 836 |Attribute                |Content           |Description                                      |
 837 +=========================+==================+=================================================+
 838 |name                     |String            |Tag name of attribute                            |
 839 +-------------------------+------------------+-------------------------------------------------+
 840 |value                    |String            |Value of the tag                                 |
 841 +-------------------------+------------------+-------------------------------------------------+
 842
 843 GET Orchestration Request
 844 ++++++++++++++++++++++++++
 845
 846 +--------------------+--------------------------------------------------------------+
 847 |Interface Definition|Description                                                   |
 848 +====================+==============================================================+
 849 |URI                 |{serverRoot}/orchestrationRequests/v4/{request-id}            |
 850 +--------------------+--------------------------------------------------------------+
 851 |Operation Type      |GET                                                           |
 852 +--------------------+--------------------------------------------------------------+
 853 |Content-Type        |application/json                                              |
 854 +--------------------+--------------------------------------------------------------+
 855
 856 Response Body:
 857
 858 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 859 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 860 +================+=========+===========+==========================+===========================================+
 861 |request         |M        |1          |request Object            |Content of request object.                 |
 862 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 863
 864 Request Object
 865
 866 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 867 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
 868 +===================+=========+===========+==========================+===========================================+
 869 |requestId          |M        |1          |String                    |Request Id                                 |
 870 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 871 |startTime          |M        |1          |request Object            |Start time.                                |
 872 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 873 |requestScope       |M        |1          |request Object            |Scope of the request.                      |
 874 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 875 |requestType        |M        |1          |request Object            |Type of the request.                       |
 876 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 877 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
 878 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 879 |requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
 880 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 881
 882 RequestDetails Object
 883
 884 +-------------------+--------------------------+-------------------------------------------------+
 885 |Attribute          |Content                   |Description                                      |
 886 +===================+==========================+=================================================+
 887 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 888 +-------------------+--------------------------+-------------------------------------------------+
 889 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 890 +-------------------+--------------------------+-------------------------------------------------+
 891 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 892 +-------------------+--------------------------+-------------------------------------------------+
 893 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 894 +-------------------+--------------------------+-------------------------------------------------+
 895 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 896 +-------------------+--------------------------+-------------------------------------------------+
 897 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 898 +-------------------+--------------------------+-------------------------------------------------+
 899 |project            |project Object            |Content of project object.                       |
 900 +-------------------+--------------------------+-------------------------------------------------+
 901 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 902 +-------------------+--------------------------+-------------------------------------------------+
 903 |platform           |platform Object           |Content of platform object.                      |
 904 +-------------------+--------------------------+-------------------------------------------------+
 905 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 906 +-------------------+--------------------------+-------------------------------------------------+
 907
 908 ModelInfo Object
 909
 910 +-------------------------+------------------+-------------------------------------------------+
 911 |Attribute                |Content           |Description                                      |
 912 +=========================+==================+=================================================+
 913 |ModelType                |String            |Type of model                                    |
 914 +-------------------------+------------------+-------------------------------------------------+
 915 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 916 +-------------------------+------------------+-------------------------------------------------+
 917 |ModelNameVersionId       |String            |The modelname Version Id                         |
 918 +-------------------------+------------------+-------------------------------------------------+
 919 |ModelName                |String            |Name of the Model                                |
 920 +-------------------------+------------------+-------------------------------------------------+
 921 |ModelVersion             |String            |Version of the model                             |
 922 +-------------------------+------------------+-------------------------------------------------+
 923 |ModelCustomization Name  |String            |The Model Customization name                     |
 924 +-------------------------+------------------+-------------------------------------------------+
 925 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 926 +-------------------------+------------------+-------------------------------------------------+
 927 |modelVersionId           |String            |The Model version id                             |
 928 +-------------------------+------------------+-------------------------------------------------+
 929 |modelUuid                |String            |The Model UUid                                   |
 930 +-------------------------+------------------+-------------------------------------------------+
 931 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 932 +-------------------------+------------------+-------------------------------------------------+
 933 |modelInstanceName        |String            |The Model Instance  name                         |
 934 +-------------------------+------------------+-------------------------------------------------+
 935
 936 SubscriberInfo Object
 937
 938 +-------------------------+------------------+-------------------------------------------------+
 939 |Attribute                |Content           |Description                                      |
 940 +=========================+==================+=================================================+
 941 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
 942 +-------------------------+------------------+-------------------------------------------------+
 943 |SubscriberName           |String            |Name of the Subscriber                           |
 944 +-------------------------+------------------+-------------------------------------------------+
 945
 946 RequestInfo Object
 947
 948 +-------------------------+------------------+-------------------------------------------------+
 949 |Attribute                |Content           |Description                                      |
 950 +=========================+==================+=================================================+
 951 |Source                   |String            |source of the request                            |
 952 +-------------------------+------------------+-------------------------------------------------+
 953 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 954 +-------------------------+------------------+-------------------------------------------------+
 955 |callbackUrl              |String            |callbackUrl of the request                       |
 956 +-------------------------+------------------+-------------------------------------------------+
 957 |correlator               |String            |correlator of the request                        |
 958 +-------------------------+------------------+-------------------------------------------------+
 959 |orderNumber              |String            |orderNumber of the request                       |
 960 +-------------------------+------------------+-------------------------------------------------+
 961 |productFamilyId          |String            |productFamilyId of the request                   |
 962 +-------------------------+------------------+-------------------------------------------------+
 963 |orderVersion             |String            |orderVersion of the request                      |
 964 +-------------------------+------------------+-------------------------------------------------+
 965 |instanceName             |String            |instanceName of the request                      |
 966 +-------------------------+------------------+-------------------------------------------------+
 967 |suppressRollback         |String            |suppressRollback of the request                  |
 968 +-------------------------+------------------+-------------------------------------------------+
 969 |requestorId              |String            |requestorId of the request                       |
 970 +-------------------------+------------------+-------------------------------------------------+
 971
 972 RequestParameters Object
 973
 974 +-------------------------+------------------+-------------------------------------------------+
 975 |Attribute                |Content           |Description                                      |
 976 +=========================+==================+=================================================+
 977 |SubscriptionServiceType  |String            |The service type of the Subscription             |
 978 +-------------------------+------------------+-------------------------------------------------+
 979
 980 RequestStatus Object
 981
 982 +-------------------------+------------------+-------------------------------------------------+
 983 |Attribute                |Content           |Description                                      |
 984 +=========================+==================+=================================================+
 985 |finishTime               |String            |Time                                             |
 986 +-------------------------+------------------+-------------------------------------------------+
 987 |requestState             |String            |state of the request                             |
 988 +-------------------------+------------------+-------------------------------------------------+
 989 |statusMessage            |String            |statusMessage                                    |
 990 +-------------------------+------------------+-------------------------------------------------+
 991 |percentProgress          |String            |percentage of progress                           |
 992 +-------------------------+------------------+-------------------------------------------------+
 993
 994 GET Orchestration Requests
 995 ++++++++++++++++++++++++++
 996
 997 +--------------------+--------------------------------------------------------------+
 998 |Interface Definition|Description                                                   |
 999 +====================+==============================================================+
1000 |URI                 |{serverRoot}/orchestrationRequests/v4                         |
1001 +--------------------+--------------------------------------------------------------+
1002 |Operation Type      |GET                                                           |
1003 +--------------------+--------------------------------------------------------------+
1004 |Content-Type        |application/json                                              |
1005 +--------------------+--------------------------------------------------------------+
1006
1007 Response Body:
1008
1009 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1010 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
1011 +================+=========+===========+==========================+===========================================+
1012 |requestList     |M        |1          |Array                     |Content of request List.                   |
1013 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1014
1015 RequestList :
1016
1017 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1018 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
1019 +================+=========+===========+==========================+===========================================+
1020 |request         |M        |1          |request Object            |Content of request object.                 |
1021 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1022
1023 Request Object
1024
1025 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1026 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
1027 +===================+=========+===========+==========================+===========================================+
1028 |requestId          |M        |1          |String                    |Request Id                                 |
1029 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1030 |startTime          |M        |1          |request Object            |Start time.                                |
1031 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1032 |requestScope       |M        |1          |request Object            |Scope of the request.                      |
1033 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1034 |requestType        |M        |1          |request Object            |Type of the request.                       |
1035 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1036 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
1037 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1038 |requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
1039 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1040
1041 RequestDetails Object
1042
1043 +-------------------+--------------------------+-------------------------------------------------+
1044 |Attribute          |Content                   |Description                                      |
1045 +===================+==========================+=================================================+
1046 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
1047 +-------------------+--------------------------+-------------------------------------------------+
1048 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
1049 +-------------------+--------------------------+-------------------------------------------------+
1050 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
1051 +-------------------+--------------------------+-------------------------------------------------+
1052 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
1053 +-------------------+--------------------------+-------------------------------------------------+
1054 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
1055 +-------------------+--------------------------+-------------------------------------------------+
1056 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
1057 +-------------------+--------------------------+-------------------------------------------------+
1058 |project            |project Object            |Content of project object.                       |
1059 +-------------------+--------------------------+-------------------------------------------------+
1060 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
1061 +-------------------+--------------------------+-------------------------------------------------+
1062 |platform           |platform Object           |Content of platform object.                      |
1063 +-------------------+--------------------------+-------------------------------------------------+
1064 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
1065 +-------------------+--------------------------+-------------------------------------------------+
1066
1067 ModelInfo Object
1068
1069 +-------------------------+------------------+-------------------------------------------------+
1070 |Attribute                |Content           |Description                                      |
1071 +=========================+==================+=================================================+
1072 |ModelType                |String            |Type of model                                    |
1073 +-------------------------+------------------+-------------------------------------------------+
1074 |ModelInvariantId         |String            |The Model Invariant Id.                          |
1075 +-------------------------+------------------+-------------------------------------------------+
1076 |ModelNameVersionId       |String            |The modelname Version Id                         |
1077 +-------------------------+------------------+-------------------------------------------------+
1078 |ModelName                |String            |Name of the Model                                |
1079 +-------------------------+------------------+-------------------------------------------------+
1080 |ModelVersion             |String            |Version of the model                             |
1081 +-------------------------+------------------+-------------------------------------------------+
1082 |ModelCustomization Name  |String            |The Model Customization name                     |
1083 +-------------------------+------------------+-------------------------------------------------+
1084 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
1085 +-------------------------+------------------+-------------------------------------------------+
1086 |modelVersionId           |String            |The Model version id                             |
1087 +-------------------------+------------------+-------------------------------------------------+
1088 |modelUuid                |String            |The Model UUid                                   |
1089 +-------------------------+------------------+-------------------------------------------------+
1090 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
1091 +-------------------------+------------------+-------------------------------------------------+
1092 |modelInstanceName        |String            |The Model Instance  name                         |
1093 +-------------------------+------------------+-------------------------------------------------+
1094
1095 SubscriberInfo Object
1096
1097 +-------------------------+------------------+-------------------------------------------------+
1098 |Attribute                |Content           |Description                                      |
1099 +=========================+==================+=================================================+
1100 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
1101 +-------------------------+------------------+-------------------------------------------------+
1102 |SubscriberName           |String            |Name of the Subscriber                           |
1103 +-------------------------+------------------+-------------------------------------------------+
1104
1105 RequestInfo Object
1106
1107 +-------------------------+------------------+-------------------------------------------------+
1108 |Attribute                |Content           |Description                                      |
1109 +=========================+==================+=================================================+
1110 |Source                   |String            |source of the request                            |
1111 +-------------------------+------------------+-------------------------------------------------+
1112 |billingAccountNumber     |String            |billingAccountNumber of the request              |
1113 +-------------------------+------------------+-------------------------------------------------+
1114 |callbackUrl              |String            |callbackUrl of the request                       |
1115 +-------------------------+------------------+-------------------------------------------------+
1116 |correlator               |String            |correlator of the request                        |
1117 +-------------------------+------------------+-------------------------------------------------+
1118 |orderNumber              |String            |orderNumber of the request                       |
1119 +-------------------------+------------------+-------------------------------------------------+
1120 |productFamilyId          |String            |productFamilyId of the request                   |
1121 +-------------------------+------------------+-------------------------------------------------+
1122 |orderVersion             |String            |orderVersion of the request                      |
1123 +-------------------------+------------------+-------------------------------------------------+
1124 |instanceName             |String            |instanceName of the request                      |
1125 +-------------------------+------------------+-------------------------------------------------+
1126 |suppressRollback         |String            |suppressRollback of the request                  |
1127 +-------------------------+------------------+-------------------------------------------------+
1128 |requestorId              |String            |requestorId of the request                       |
1129 +-------------------------+------------------+-------------------------------------------------+
1130
1131 RequestParameters Object
1132
1133 +-------------------------+------------------+-------------------------------------------------+
1134 |Attribute                |Content           |Description                                      |
1135 +=========================+==================+=================================================+
1136 |SubscriptionServiceType  |String            |The service type of the Subscription             |
1137 +-------------------------+------------------+-------------------------------------------------+
1138
1139 RequestStatus Object
1140
1141 +-------------------------+------------------+-------------------------------------------------+
1142 |Attribute                |Content           |Description                                      |
1143 +=========================+==================+=================================================+
1144 |finishTime               |String            |Time                                             |
1145 +-------------------------+------------------+-------------------------------------------------+
1146 |requestState             |String            |state of the request                             |
1147 +-------------------------+------------------+-------------------------------------------------+
1148 |statusMessage            |String            |statusMessage                                    |
1149 +-------------------------+------------------+-------------------------------------------------+
1150 |percentProgress          |String            |percentage of progress                           |
1151 +-------------------------+------------------+-------------------------------------------------+
1152
1153 SDC API
1154 --------
1155
1156 Get List of Existing Catalog Assets
1157 +++++++++++++++++++++++++++++++++++
1158
1159 +--------------------+--------------------------+
1160 |Interface Definition|Description               |
1161 +====================+==========================+
1162 |URI                 |sdc/v1/catalog/{assetType}|
1163 +--------------------+--------------------------+
1164 |Operation Type      |GET                       |
1165 +--------------------+--------------------------+
1166
1167 Request Parameters:
1168
1169 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1170 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
1171 +===================+=========+===========+=======+=============================================================+
1172 |assetType          |M        |1          |String |The requested asset type.valid values are resources/services.|
1173 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1174 |service-type       |M        |1          |String |Service Type                                                 |
1175 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1176 |service-instance-id|M        |1          |String |Service Instance ID                                          |
1177 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1178
1179 Request Headers:
1180
1181 +-------------------+---------+-----------------------------------------------------------------------------------------+
1182 |Header Name        |Qualifier|Description                                                                              |
1183 +===================+=========+=========================================================================================+
1184 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1185 +-------------------+---------+-----------------------------------------------------------------------------------------+
1186 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1187 +-------------------+---------+-----------------------------------------------------------------------------------------+
1188 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1189 +-------------------+---------+-----------------------------------------------------------------------------------------+
1190 |Authorization      |Y        |Base64 encoded username:password                                                         |
1191 +-------------------+---------+-----------------------------------------------------------------------------------------+
1192
1193 Response:
1194
1195 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1196 |Attribute         |Qualifier|Cardinality|Content|Description                                                                           |
1197 +==================+=========+===========+=======+======================================================================================+
1198 |uuid              |M        |1          |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1199 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1200 |invariantUUID     |M        |1          |String |UUID generated by SDC per each asset.                                                 |
1201 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1202 |name              |M        |1          |String |The name of the asset                                                                 |
1203 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1204 |version           |M        |1          |String |The asset version in SDC catalog.                                                     |
1205 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1206 |toscaModelURL     |M        |1          |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.    |
1207 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1208 |category          |M        |1          |String |Category of the asset.                                                                |
1209 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1210 |subcategory       |M        |1          |String |Sub-category of the asset                                                             |
1211 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1212 |resourceType      |M        |1          |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF.                  |
1213 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1214 |lifecycleState    |M        |1          |String |The lifecycle state of the asset                                                      |
1215 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1216 |lastUpdaterUserId |M        |1          |String |UserID of the SDC designer who was the last to update the asset for this major version|
1217 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1218
1219 Get Specific Asset Detailed Metadata
1220 ++++++++++++++++++++++++++++++++++++
1221
1222 +--------------------+-------------------------------------------+
1223 |Interface Definition|Description                                |
1224 +====================+===========================================+
1225 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
1226 +--------------------+-------------------------------------------+
1227 |Operation Type      |GET                                        |
1228 +--------------------+-------------------------------------------+
1229
1230 Request Parameters:
1231
1232 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1233 |Attribute          |Qualifier|Cardinality|Content|Description                                                                          |
1234 +===================+=========+===========+=======+=====================================================================================+
1235 |assetType          |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1236 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1237 |uuid               |M        |1          |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
1238 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1239
1240 Request Headers:
1241
1242 +-------------------+---------+-----------------------------------------------------------------------------------------+
1243 |Header Name        |Qualifier|Description                                                                              |
1244 +===================+=========+=========================================================================================+
1245 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1246 +-------------------+---------+-----------------------------------------------------------------------------------------+
1247 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1248 +-------------------+---------+-----------------------------------------------------------------------------------------+
1249 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1250 +-------------------+---------+-----------------------------------------------------------------------------------------+
1251 |Authorization      |Y        |Base64 encoded username:password                                                         |
1252 +-------------------+---------+-----------------------------------------------------------------------------------------+
1253
1254 Response:
1255
1256 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1257 |Attribute           |Qualifier|Content|Description                                                                           |
1258 +====================+=========+=======+======================================================================================+
1259 |uuid                |M        |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1260 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1261 |invariantUUID       |M        |String |UUID generated by SDC per each asset.                                                 |
1262 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1263 |name                |M        |String |The name of the asset                                                                 |
1264 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1265 |version             |M        |String |The asset version in SDC catalog.                                                     |
1266 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1267 |toscaModelURL       |M        |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.    |
1268 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1269 |description         |M        |String |Short description of the resource                                                     |
1270 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1271 |lastUpdaterUserId   |M        |String |UserID of the SDC designer who was the last to update the asset for this major version|
1272 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1273 |lastUpdaterFullName |M        |String |UserID of the SDC designer who was the last to update the asset for this major version|
1274 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1275 |category            |M        |String |Category of the asset                                                                 |
1276 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1277 |subCategory         |M        |String |Sub-category of the asset.                                                            |
1278 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1279 |toscaResourceName   |M        |String |The full name of the asset                                                            |
1280 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1281 |resourceType        |M        |String |The type of resource.                                                                 |
1282 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1283 |lifecycleState      |M        |String |The lifecycle state of the asset                                                      |
1284 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1285 |resources           |N        |Object |Category of the asset                                                                 |
1286 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1287 |artifacts           |M        |Object |Category of the asset                                                                 |
1288 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1289
1290 Resource Object:
1291
1292 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1293 |Attribute            |Qualifier|Content|Description                                                                                                        |                                                                         |
1294 +=====================+=========+=======+===================================================================================================================+
1295 |resourceInstanceName |M        |String |Logical Resource Instance Name.Unique Identifier of  the instance of the  specific resource in the service context.|
1296 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1297 |resourceName         |M        |String |Resource Name                                                                                                      |
1298 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1299 |resourceInvariantUUID|M        |String |The invariant UUID of the resource                                                                                 |
1300 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1301 |resourceVersion      |M        |String |Resource Version                                                                                                   |
1302 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1303 |resoucreType         |M        |String |Resource Type                                                                                                      |
1304 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1305 |resourceUUID         |M        |String |Global UUID of the resource that specific artifact belongs to                                                      |
1306 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1307 |artifacts            |M        |Object |Array of  resource instance deployment artifacts.                                                                  |
1308 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1309
1310 Artifact Metadata Object:
1311
1312 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1313 |Attribute            |Qualifier|Content |Description                                                                                                        |
1314 +=====================+=========+========+===================================================================================================================+
1315 |artifactName         |M        |String  |Artifact File name                                                                                                 |
1316 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1317 |artifactLabel        |M        |String  |Identifier of the artifact within the VF / Service.                                                                |
1318 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1319 |artifactType         |M        |String  |Artifact Type                                                                                                      |
1320 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1321 |artifactGroupType    |M        |String  |Whether the artifact is informational or deployment.                                                               |
1322 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1323 |artifactURL          |M        |String  |Relative artifact’s URL.                                                                                           |
1324 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1325 |artifactDescription  |M        |String  |Artifact Description                                                                                               |
1326 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1327 |artifactTimeout      |N        |Integer |Artifact Description                                                                                               |
1328 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1329 |artifactChecksum     |M        |String  |Base-64 encoded MD5 checksum of the artifact’s payload.                                                            |
1330 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1331 |artifactUUID         |M        |String  |Global UUID generated by SDC each time  when artifact payload is  updated.                                         |
1332 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1333 |artifactVersion      |M        |String  |Service Version                                                                                                    |
1334 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1335 |generatedFromUUID    |N        |String  |This attribute will be  sent only  in the case of  an artifact  generated on basis of  other artifact              |
1336 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1337
1338 Download (CSAR of) Specific Asset
1339 +++++++++++++++++++++++++++++++++
1340
1341 +--------------------+-----------------------------------------------------------+
1342 |Interface Definition|Description                                                |
1343 +====================+===========================================================+
1344 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
1345 +--------------------+-----------------------------------------------------------+
1346 |Operation Type      |GET                                                        |
1347 +--------------------+-----------------------------------------------------------+
1348
1349 Request Parameters:
1350
1351 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1352 |Attribute          |Qualifier|Cardinality|Content|Description                                                                          |
1353 +===================+=========+===========+=======+=====================================================================================+
1354 |assetType          |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1355 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1356 |Uuid               |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1357 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1358 |artifactUUID       |M        |1          |String |The artifactUUID of the asset as published in the metadata                           |
1359 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1360
1361 Response:
1362
1363 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1364 |Header name         |Qualifier|Description                                                                                                               |
1365 +====================+=========+==========================================================================================================================+
1366 |Content-Type        |M        |Specifies the  downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
1367 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1368 |Content-Length      |M        |Streamed artifact payload size                                                                                            |
1369 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1370 |Content-Disposition |M        |Specifies  the name of  file to  store the  downloaded artifact’s  payload  ( RFC 2183) .                                 |
1371 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1372
1373 Upload Artifact
1374 +++++++++++++++
1375
1376 +--------------------+-----------------------------------------------------------------------------------------------+
1377 |Interface Definition|Description                                                                                    |
1378 +====================+===============================================================================================+
1379 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
1380 +--------------------+-----------------------------------------------------------------------------------------------+
1381 |Operation Type      |POST                                                                                           |
1382 +--------------------+-----------------------------------------------------------------------------------------------+
1383
1384 Request Parameters:
1385
1386 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1387 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1388 +==============================+=========+===========+=======+=====================================================================================+
1389 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1390 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1391 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1392 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1393 |resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
1394 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1395
1396 Request Body
1397 ++++++++++++
1398
1399 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1400 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1401 +==============================+=========+===========+=======+=====================================================================================+
1402 |payloadData                   |M        |1          |String |The data of the artifact after Base64 encoding                                       |
1403 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1404 |artifactLabel                 |M        |1          |String |Identifier of the artifact within the VF / Service.                                  |
1405 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1406 |artifactName                  |M        |1          |String |The name of the artifact                                                             |
1407 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1408 |artifactType                  |M        |1          |String |The type of the artifact                                                             |
1409 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1410 |artifactGroupType             |M        |1          |String |Whether the artifact is informational or deployment.                                 |
1411 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1412 |description                   |M        |1          |String |Description of the artifact                                                          |
1413 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1414
1415 Request Headers:
1416
1417 +-------------------+---------+-----------------------------------------------------------------------------------------+
1418 |Header Name        |Qualifier|Description                                                                              |
1419 +===================+=========+=========================================================================================+
1420 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1421 +-------------------+---------+-----------------------------------------------------------------------------------------+
1422 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1423 +-------------------+---------+-----------------------------------------------------------------------------------------+
1424 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1425 +-------------------+---------+-----------------------------------------------------------------------------------------+
1426 |Authorization      |Y        |Base64 encoded username:password                                                         |
1427 +-------------------+---------+-----------------------------------------------------------------------------------------+
1428 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1429 +-------------------+---------+-----------------------------------------------------------------------------------------+
1430 |Content-Type       |Y        |Valid value is : application/json                                                        |
1431 +-------------------+---------+-----------------------------------------------------------------------------------------+
1432 |Content-MD5        |Y        |The value for this header must be the MD5 checksum over the whole json body              |
1433 +-------------------+---------+-----------------------------------------------------------------------------------------+
1434
1435 Response:
1436
1437 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1438 |Attribute           |Qualifier|Content|Description                                                                                        |
1439 +====================+=========+=======+===================================================================================================+
1440 |artifactName        |M        |String |Artifact File name                                                                                 |
1441 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1442 |artifactType        |M        |String |Artifact Type                                                                                      |
1443 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1444 |artifactURL         |M        |String |Relative artifact’s URL.                                                                           |
1445 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1446 |artifactDescription |M        |String |Artifact Description.                                                                              |
1447 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1448 |artifactTimeout     |N        |String |Will be populated only if its value is not 0.                                                      |
1449 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1450 |artifactChecksum    |Y        |String |Base-64 encoded MD5 checksum of the artifact’s payload.                                            |
1451 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1452 |artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
1453 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1454 |artifactVersion     |Y        |String |Service Version .                                                                                  |
1455 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1456 |generatedFromUUID   |N        |String |This attribute will be sent only  in the case of an artifact generated on basis of other artifact  |
1457 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1458
1459 Update Artifact
1460 +++++++++++++++
1461
1462 +--------------------+--------------------------------------------------------------------------------------------------------------+
1463 |Interface Definition|Description                                                                                                   |
1464 +====================+==============================================================================================================+
1465 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1466 +--------------------+--------------------------------------------------------------------------------------------------------------+
1467 |Operation Type      |POST                                                                                                          |
1468 +--------------------+--------------------------------------------------------------------------------------------------------------+
1469
1470 Request Parameters:
1471
1472 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1473 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1474 +==============================+=========+===========+=======+=====================================================================================+
1475 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1476 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1477 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1478 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1479 |artifactUUID                  |M        |1          |String |The uuid of the artifact as published in the response of the upload/update operation |
1480 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1481 |resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
1482 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1483
1484 Request Headers:
1485
1486 +-------------------+---------+-----------------------------------------------------------------------------------------+
1487 |Header Name        |Qualifier|Description                                                                              |
1488 +===================+=========+=========================================================================================+
1489 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1490 +-------------------+---------+-----------------------------------------------------------------------------------------+
1491 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1492 +-------------------+---------+-----------------------------------------------------------------------------------------+
1493 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1494 +-------------------+---------+-----------------------------------------------------------------------------------------+
1495 |Authorization      |Y        |Base64 encoded username:password                                                         |
1496 +-------------------+---------+-----------------------------------------------------------------------------------------+
1497 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1498 +-------------------+---------+-----------------------------------------------------------------------------------------+
1499 |Content-Type       |Y        |Valid value is : application/json                                                        |
1500 +-------------------+---------+-----------------------------------------------------------------------------------------+
1501 |Content-MD5        |Y        |The value for this header must be the MD5 checksum over the whole json body              |
1502 +-------------------+---------+-----------------------------------------------------------------------------------------+
1503
1504 Request Body:
1505
1506 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1507 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1508 +==============================+=========+===========+=======+=====================================================================================+
1509 |payloadData                   |M        |1          |String |The data of the artifact after Base64 encoding                                       |
1510 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1511 |artifactLabel                 |M        |1          |String |Identifier of the artifact within the VF / Service.                                  |
1512 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1513 |artifactName                  |M        |1          |String |The name of the artifact                                                             |
1514 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1515 |artifactType                  |M        |1          |String |The type of the artifact                                                             |
1516 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1517 |artifactGroupType             |M        |1          |String |Whether the artifact is informational or deployment.                                 |
1518 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1519 |description                   |M        |1          |String |Description of the artifact                                                          |
1520 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1521
1522 Response:
1523
1524 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1525 |Attribute           |Qualifier|Content|Description                                                                                        |
1526 +====================+=========+=======+===================================================================================================+
1527 |artifactName        |M        |String |Artifact File name                                                                                 |
1528 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1529 |artifactType        |M        |String |Artifact Type                                                                                      |
1530 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1531 |artifactURL         |M        |String |Relative artifact’s URL.                                                                           |
1532 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1533 |artifactDescription |M        |String |Artifact Description.                                                                              |
1534 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1535 |artifactTimeout     |N        |String |Will be populated only if its value is not 0.                                                      |
1536 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1537 |artifactChecksum    |Y        |String |Base-64 encoded MD5 checksum of the artifact’s payload.                                            |
1538 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1539 |artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
1540 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1541 |artifactVersion     |Y        |String |Service Version .                                                                                  |
1542 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1543 |generatedFromUUID   |N        |String |This attribute will be sent only  in the case of an artifact generated on basis of other artifact  |
1544 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1545
1546 Delete Artifact
1547 +++++++++++++++
1548
1549 +--------------------+--------------------------------------------------------------------------------------------------------------+
1550 |Interface Definition|Description                                                                                                   |
1551 +====================+==============================================================================================================+
1552 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1553 +--------------------+--------------------------------------------------------------------------------------------------------------+
1554 |Operation Type      |DELETE                                                                                                        |
1555 +--------------------+--------------------------------------------------------------------------------------------------------------+
1556
1557 Request Parameters:
1558
1559 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1560 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1561 +==============================+=========+===========+=======+=====================================================================================+
1562 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1563 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1564 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1565 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1566 |artifactUUID                  |M        |1          |String |The uuid of the artifact as published in the response of the upload/update operation |
1567 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1568 |resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
1569 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1570
1571 Request Headers:
1572
1573 +-------------------+---------+-----------------------------------------------------------------------------------------+
1574 |Header Name        |Qualifier|Description                                                                              |
1575 +===================+=========+=========================================================================================+
1576 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1577 +-------------------+---------+-----------------------------------------------------------------------------------------+
1578 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1579 +-------------------+---------+-----------------------------------------------------------------------------------------+
1580 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1581 +-------------------+---------+-----------------------------------------------------------------------------------------+
1582 |Authorization      |Y        |Base64 encoded username:password                                                         |
1583 +-------------------+---------+-----------------------------------------------------------------------------------------+
1584 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1585 +-------------------+---------+-----------------------------------------------------------------------------------------+
1586
1587 Response:
1588
1589 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1590 |Attribute           |Qualifier|Content|Description                                                                                        |
1591 +====================+=========+=======+===================================================================================================+
1592 |artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
1593 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1594
1595 Update Lifecycle
1596 ++++++++++++++++
1597
1598 +--------------------+--------------------------------------------------------------------------------------------------------------+
1599 |Interface Definition|Description                                                                                                   |
1600 +====================+==============================================================================================================+
1601 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}                                        |
1602 +--------------------+--------------------------------------------------------------------------------------------------------------+
1603 |Operation Type      |POST                                                                                                          |
1604 +--------------------+--------------------------------------------------------------------------------------------------------------+
1605
1606 Request Parameters:
1607
1608 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1609 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                                          |
1610 +==============================+=========+===========+=======+=====================================================================================================+
1611 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                                        |
1612 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1613 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                                   |
1614 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1615 |lifecycleOperation            |M        |1          |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout /  Certify |
1616 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1617
1618 Request Headers:
1619
1620 +-------------------+---------+-----------------------------------------------------------------------------------------+
1621 |Header Name        |Qualifier|Description                                                                              |
1622 +===================+=========+=========================================================================================+
1623 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1624 +-------------------+---------+-----------------------------------------------------------------------------------------+
1625 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1626 +-------------------+---------+-----------------------------------------------------------------------------------------+
1627 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1628 +-------------------+---------+-----------------------------------------------------------------------------------------+
1629 |Authorization      |Y        |Base64 encoded username:password                                                         |
1630 +-------------------+---------+-----------------------------------------------------------------------------------------+
1631 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1632 +-------------------+---------+-----------------------------------------------------------------------------------------+
1633
1634 Request Parameters:
1635
1636 +-------------------+---------+-----------------------------------------------------------------------------------------+
1637 |Attribute          |Qualifier|Description                                                                              |
1638 +===================+=========+=========================================================================================+
1639 |userRemarks        |N        |Short description (free text) about the asset version being changed                      |
1640 +-------------------+---------+-----------------------------------------------------------------------------------------+
1641
1642 Response:
1643
1644 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1645 |Attribute           |Qualifier|Content|Description                                                                                        |
1646 +====================+=========+=======+===================================================================================================+
1647 |uuid                |Y        |String |UUID generated by SDC per each major version of the asset                                          |
1648 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1649 |invariantUUID       |Y        |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions        |
1650 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1651 |name                |Y        |String |The name of the asset.                                                                             |
1652 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1653 |version             |Y        |String |The asset version in SDC catalog                                                                   |
1654 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1655 |category            |Y        |String |Category of the asset.                                                                             |
1656 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1657 |subcategory         |Y        |String |Sub-category of the asset.                                                                         |
1658 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1659 |resourceType        |Y        |String |The type of resource.                                                                              |
1660 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1661 |lifecycleState      |Y        |String |The lifecycle state of the asset.                                                                  |
1662 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1663 |lastUpdaterUserId   |Y        |String |User ID of the SDC designer who was the last to update the asset for this major version.           |
1664 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1665
1666 Create Resource
1667 +++++++++++++++
1668
1669 +--------------------+--------------------------------------------------------------------------------------------------------------+
1670 |Interface Definition|Description                                                                                                   |
1671 +====================+==============================================================================================================+
1672 |URI                 |/sdc/v1/catalog/resources                                                                                     |
1673 +--------------------+--------------------------------------------------------------------------------------------------------------+
1674 |Operation Type      |POST                                                                                                          |
1675 +--------------------+--------------------------------------------------------------------------------------------------------------+
1676
1677 Request Headers:
1678
1679 +-------------------+---------+-----------------------------------------------------------------------------------------+
1680 |Header Name        |Qualifier|Description                                                                              |
1681 +===================+=========+=========================================================================================+
1682 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1683 +-------------------+---------+-----------------------------------------------------------------------------------------+
1684 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1685 +-------------------+---------+-----------------------------------------------------------------------------------------+
1686 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1687 +-------------------+---------+-----------------------------------------------------------------------------------------+
1688 |Authorization      |Y        |Base64 encoded username:password                                                         |
1689 +-------------------+---------+-----------------------------------------------------------------------------------------+
1690 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1691 +-------------------+---------+-----------------------------------------------------------------------------------------+
1692 |Content-Type       |Y        |Valid value is : application/json                                                        |
1693 +-------------------+---------+-----------------------------------------------------------------------------------------+
1694
1695 Request Parameters:
1696
1697 +-------------------+---------+-----------------------------------------------------------------------------------------+
1698 |Attribute          |Qualifier|Description                                                                              |
1699 +===================+=========+=========================================================================================+
1700 |name               |Y        |The name of the resource                                                                 |
1701 +-------------------+---------+-----------------------------------------------------------------------------------------+
1702 |description        |Y        |Short description of the resource                                                        |
1703 +-------------------+---------+-----------------------------------------------------------------------------------------+
1704 |resourceType       |Y        |“VFCMT” / “VF” / “PNF”                                                                   |
1705 +-------------------+---------+-----------------------------------------------------------------------------------------+
1706 |category           |Y        |VFCMT category is “Template”.                                                            |
1707 +-------------------+---------+-----------------------------------------------------------------------------------------+
1708 |subcategory        |Y        |VFCMT subcategory is “Monitoring Template”.                                              |
1709 +-------------------+---------+-----------------------------------------------------------------------------------------+
1710 |vendorName         |Y        |Vendor Name                                                                              |
1711 +-------------------+---------+-----------------------------------------------------------------------------------------+
1712 |vendorRelease      |Y        |Vendor Release                                                                           |
1713 +-------------------+---------+-----------------------------------------------------------------------------------------+
1714 |tags               |Y        |The tags are used for search options.                                                    |
1715 +-------------------+---------+-----------------------------------------------------------------------------------------+
1716 |icon               |Y        |The icon should be pre-defined in SDC.                                                   |
1717 +-------------------+---------+-----------------------------------------------------------------------------------------+
1718 |contactId          |Y        |The user ID of user responsible for this VFCMT.                                          |
1719 +-------------------+---------+-----------------------------------------------------------------------------------------+
1720
1721 Response:
1722
1723 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1724 |Attribute           |Qualifier|Content|Description                                                                                        |
1725 +====================+=========+=======+===================================================================================================+
1726 |uuid                |Y        |String |UUID generated by SDC per each major version of the asset                                          |
1727 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1728 |invariantUUID       |Y        |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions        |
1729 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1730 |name                |Y        |String |The name of the asset.                                                                             |
1731 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1732 |version             |Y        |String |The asset version in SDC catalog                                                                   |
1733 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1734 |category            |Y        |String |Category of the asset.                                                                             |
1735 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1736 |subcategory         |Y        |String |Sub-category of the asset.                                                                         |
1737 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1738 |resourceType        |Y        |String |The type of resource.                                                                              |
1739 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1740 |lifecycleState      |Y        |String |The lifecycle state of the asset.                                                                  |
1741 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1742 |lastUpdaterUserId   |Y        |String |User ID of the SDC designer who was the last to update the asset for this major version.           |
1743 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1744
1745 UUI API
1746 ----------------
1747 Create E2E service instance
1748 ++++++++++++++++++++++++++++
1749
1750 +--------------------+-------------------------------------+
1751 |Interface Definition|Description                          |
1752 +====================+=====================================+
1753 |URI                 |{serverRoot}/e2eServiceInstances/v3  |
1754 +--------------------+-------------------------------------+
1755 |Operation Type      |POST                                 |
1756 +--------------------+-------------------------------------+
1757 |Content-Type        |application/json                     |
1758 +--------------------+-------------------------------------+
1759
1760 Request Body:
1761
1762 +---------+---------+-----------+--------------------------+-----------------------------+
1763 |Attribute|Qualifier|Cardinality|Content                   |Description                  |
1764 +=========+=========+===========+==========================+=============================+
1765 |service  |M        |1          |Service Object            |Content of service object.   |
1766 +---------+---------+-----------+--------------------------+-----------------------------+
1767
1768 Service Object
1769
1770 +----------------+------------------+-------------------------------------------------+
1771 |Attribute       |Content           |Description                                      |
1772 +================+==================+=================================================+
1773 |name            |String            |Service instance name.                           |
1774 +----------------+------------------+-------------------------------------------------+
1775 |description     |String            |Service instance description                     |
1776 +----------------+------------------+-------------------------------------------------+
1777 |serviceDef ID   |String            |The service invariantUUID. It is defined in SDC. |
1778 +----------------+------------------+-------------------------------------------------+
1779 |templateId      |String            |The service Template UUID. It is defined in SDC. |
1780 +----------------+------------------+-------------------------------------------------+
1781 |parameters      |Parameter Object  |Parameter Object                                 |
1782 +----------------+------------------+-------------------------------------------------+
1783
1784 Parameter Object
1785
1786 +----------------------+------------------+-----------------------------------------------------+
1787 |Attribute             |Content           |Description                                          |
1788 +======================+==================+=====================================================+
1789 |globalSubscriberId    |String            |The subscriber id. It is defined in AAI              |
1790 +----------------------+------------------+-----------------------------------------------------+
1791 |subscriberName        |String            |The subscriber name. It is defined in AAI            |
1792 +----------------------+------------------+-----------------------------------------------------+
1793 |serviceType           |String            |The service type. It is defined in AAI               |
1794 +----------------------+------------------+-----------------------------------------------------+
1795 |templateName          |String            |The service Template name                            |
1796 +----------------------+------------------+-----------------------------------------------------+
1797 |resources             |Object            |This field manages parameters of resources           |
1798 +----------------------+------------------+-----------------------------------------------------+
1799 |resourceName          |String            |The resource name                                    |
1800 +----------------------+------------------+-----------------------------------------------------+
1801 |resouceDefId          |String            |The resource invariantUUID. It is defined in SDC.    |
1802 +----------------------+------------------+-----------------------------------------------------+
1803 |resourceId            |String            |The resource UUID. It is defined in SDC.             |
1804 +----------------------+------------------+-----------------------------------------------------+
1805 |nsParameters          |String            |Parameters for current resource object.              |
1806 +----------------------+------------------+-----------------------------------------------------+
1807 |locationConstraints   |String            |The DC location info for each VNF of current service |
1808 +----------------------+------------------+-----------------------------------------------------+
1809 |vnfProfileId          |String            |VNFD id                                              |
1810 +----------------------+------------------+-----------------------------------------------------+
1811 |additionalParamForNs  |String            |The parameter for current resource                   |
1812 +----------------------+------------------+-----------------------------------------------------+
1813
1814
1815 Response:
1816
1817 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1818 |Attribute    |Qualifier|Cardinality|Content|Description                                                             |
1819 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1820 |serviceId    |M        |1          |String |Service instance ID.                                                    |
1821 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1822 |operationId  |M        |1          |String |Service Operation ID.                                                   |
1823 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1824
1825 Delete E2E service instance
1826 ++++++++++++++++++++++++++++
1827
1828 +--------------------+-----------------------------------------------+
1829 |Interface Definition|Description                                    |
1830 +====================+===============================================+
1831 |URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
1832 +--------------------+-----------------------------------------------+
1833 |Operation Type      |DELETE                                         |
1834 +--------------------+-----------------------------------------------+
1835
1836 Request Parameters:
1837
1838 +-------------------+---------+-----------+-------+----------------------------------------+
1839 |Attribute          |Qualifier|Cardinality|Content|Description                             |
1840 +===================+=========+===========+=======+========================================+
1841 |globalSubscriberId |M        |1          |String |The subscriber id. It is defined in AAI |
1842 +-------------------+---------+-----------+-------+----------------------------------------+
1843 |serviceType        |M        |1          |String |The service type. It is defined in AAI  |
1844 +-------------------+---------+-----------+-------+----------------------------------------+
1845
1846 Response:
1847
1848 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1849 |Attribute    |Qualifier|Cardinality|Content|Description                                                             |
1850 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1851 |operationId  |M        |1          |String |The operation id.                                                       |
1852 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1853
1854 Query E2E service operation result
1855 ++++++++++++++++++++++++++
1856
1857 +--------------------+------------------------------------------------------------------------+
1858 |Interface Definition|Description                                                             |
1859 +====================+========================================================================+
1860 |URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
1861 +--------------------+------------------------------------------------------------------------+
1862 |Operation Type      |GET                                                                     |
1863 +--------------------+------------------------------------------------------------------------+
1864
1865 Request Parameters:
1866
1867 +--------------+---------+-----------+-------+--------------+
1868 |Attribute     |Qualifier|Cardinality|Content|Description   |
1869 +==============+=========+===========+=======+==============+
1870 |serviceId     |M        |1          |Service instance ID.  |
1871 +--------------+---------+-----------+-------+--------------+
1872 |operationId   |M        |1          |Service Operation ID. |
1873 +--------------+---------+-----------+-------+--------------+
1874
1875 Response:
1876
1877 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1878 |Attribute         |Qualifier|Cardinality|Content|Description                                                             |
1879 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1880 |operation         |M        |1          |String |Operation object identify.                                              |
1881 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1882 |operationId       |M        |1          |String |Operation ID.                                                           |
1883 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1884 |operation         |M        |1          |String |Operation type, create|delete.                                          |
1885 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1886 |result            |M        |1          |String |Operation result: finished, error, processing.                          |
1887 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1888 |reason            |M        |1          |String |If failing, need to write fail reason.                                  |
1889 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1890 |userId            |M        |1          |String |Operation user ID.                                                      |
1891 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1892 |operationContent  |M        |1          |String |The status detail of current operation which is being executing.        |
1893 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1894 |progress          |M        |1          |String |Current operation progress.                                             |
1895 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1896 |operateAt         |M        |1          |String |Time that it starts to execute operation.                               |
1897 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1898 |finishedAt        |M        |1          |String |Time that it finished executing operation.                              |
1899 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1900
1901 Inventory APIs
1902 ----------------
1903
1904 create or update an existing service-instance
1905 +++++++++++++++++++++++++++++++++++++++++++++
1906
1907 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1908 |Interface Definition|Description                                                                                                                                                         |
1909 +====================+====================================================================================================================================================================+
1910 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1911 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1912 |Operation Type      |PUT                                                                                                                                                                 |
1913 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1914
1915 Request Parameters:
1916
1917 +-------------------+---------+-----------+-------+-----------------------+
1918 |Attribute          |Qualifier|Cardinality|Content|Description            |
1919 +===================+=========+===========+=======+=======================+
1920 |global-customer-id |M        |1          |String |Global Customer ID     |
1921 +-------------------+---------+-----------+-------+-----------------------+
1922 |service-type       |M        |1          |String |Service Type           |
1923 +-------------------+---------+-----------+-------+-----------------------+
1924 |service-instance-id|M        |1          |String |Service Instance ID    |
1925 +-------------------+---------+-----------+-------+-----------------------+
1926
1927 Response:
1928
1929 +---------+---------+-----------+-------+-------------------+
1930 |Attribute|Qualifier|Cardinality|Content|Description        |
1931 +---------+---------+-----------+-------+-------------------+
1932 |HTTP code|M        |1          |Integer|HTTP response code |
1933 +---------+---------+-----------+-------+-------------------+
1934
1935 delete an existing service-instance
1936 +++++++++++++++++++++++++++++++++++
1937
1938 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1939 |Interface Definition|Description                                                                                                                                                         |
1940 +====================+====================================================================================================================================================================+
1941 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1942 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1943 |Operation Type      |DELETE                                                                                                                                                              |
1944 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1945
1946 Request Parameters:
1947
1948 +-------------------+---------+-----------+-------+-----------------------+
1949 |Attribute          |Qualifier|Cardinality|Content|Description            |
1950 +===================+=========+===========+=======+=======================+
1951 |global-customer-id |M        |1          |String |Global Customer ID     |
1952 +-------------------+---------+-----------+-------+-----------------------+
1953 |service-type       |M        |1          |String |Service Type           |
1954 +-------------------+---------+-----------+-------+-----------------------+
1955 |service-instance-id|M        |1          |String |Service Instance ID    |
1956 +-------------------+---------+-----------+-------+-----------------------+
1957
1958 Response:
1959
1960 +---------+---------+-----------+-------+-------------------+
1961 |Attribute|Qualifier|Cardinality|Content|Description        |
1962 +---------+---------+-----------+-------+-------------------+
1963 |HTTP code|M        |1          |Integer|HTTP response code |
1964 +---------+---------+-----------+-------+-------------------+
1965
1966 get service-instances
1967 +++++++++++++++++++++
1968
1969 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1970 |Interface Definition|Description                                                                                                                  |
1971 +====================+=============================================================================================================================+
1972 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
1973 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1974 |Operation Type      |GET                                                                                                                          |
1975 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1976
1977 Request Parameters:
1978
1979 +-------------------+---------+-----------+-------+-----------------------+
1980 |Attribute          |Qualifier|Cardinality|Content|Description            |
1981 +===================+=========+===========+=======+=======================+
1982 |global-customer-id |M        |1          |String |Global Customer ID     |
1983 +-------------------+---------+-----------+-------+-----------------------+
1984 |service-type       |M        |1          |String |Service Type           |
1985 +-------------------+---------+-----------+-------+-----------------------+
1986
1987 Response:
1988
1989 +-----------------+---------+-----------+----------------+-------------------+
1990 |Attribute        |Qualifier|Cardinality|Content         |Description        |
1991 +-----------------+---------+-----------+----------------+-------------------+
1992 |service-instances|M        |1          |ServiceInstances|Service Instances  |
1993 +-----------------+---------+-----------+----------------+-------------------+
1994
1995 get service-instance
1996 ++++++++++++++++++++
1997
1998 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1999 |Interface Definition|Description                                                                                                                                                         |
2000 +====================+====================================================================================================================================================================+
2001 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
2002 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2003 |Operation Type      |GET                                                                                                                                                                 |
2004 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2005
2006 Request Parameters:
2007
2008 +-------------------+---------+-----------+-------+-----------------------+
2009 |Attribute          |Qualifier|Cardinality|Content|Description            |
2010 +===================+=========+===========+=======+=======================+
2011 |global-customer-id |M        |1          |String |Global Customer ID     |
2012 +-------------------+---------+-----------+-------+-----------------------+
2013 |service-type       |M        |1          |String |Service Type           |
2014 +-------------------+---------+-----------+-------+-----------------------+
2015 |service-instance-id|M        |1          |String |Service instance ID    |
2016 +-------------------+---------+-----------+-------+-----------------------+
2017
2018 Response:
2019
2020 +-----------------+---------+-----------+----------------+-------------------+
2021 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2022 +-----------------+---------+-----------+----------------+-------------------+
2023 |service-instance |M        |1          |ServiceInstance |Service Instance   |
2024 +-----------------+---------+-----------+----------------+-------------------+
2025
2026 see node definition for valid relationships
2027 +++++++++++++++++++++++++++++++++++++++++++
2028
2029 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2030 |Interface Definition|Description                                                                                                                                                                                        |
2031 +====================+===================================================================================================================================================================================================+
2032 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2033 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2034 |Operation Type      |PUT                                                                                                                                                                                                |
2035 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2036
2037 Request Parameters:
2038
2039 +-------------------+---------+-----------+-------+-----------------------+
2040 |Attribute          |Qualifier|Cardinality|Content|Description            |
2041 +===================+=========+===========+=======+=======================+
2042 |global-customer-id |M        |1          |String |Global Customer ID     |
2043 +-------------------+---------+-----------+-------+-----------------------+
2044 |service-type       |M        |1          |String |Service Type           |
2045 +-------------------+---------+-----------+-------+-----------------------+
2046 |service-instance-id|M        |1          |String |Service instance ID    |
2047 +-------------------+---------+-----------+-------+-----------------------+
2048
2049 Response:
2050
2051 +---------+---------+-----------+-------+-------------------+
2052 |Attribute|Qualifier|Cardinality|Content|Description        |
2053 +---------+---------+-----------+-------+-------------------+
2054 |HTTP code|M        |1          |Integer|HTTP response code |
2055 +---------+---------+-----------+-------+-------------------+
2056
2057 delete an existing relationship
2058 +++++++++++++++++++++++++++++++
2059
2060 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2061 |Interface Definition|Description                                                                                                                                                                                        |
2062 +====================+===================================================================================================================================================================================================+
2063 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2064 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2065 |Operation Type      |DELETE                                                                                                                                                                                             |
2066 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2067
2068 Request Parameters:
2069
2070 +-------------------+---------+-----------+-------+-----------------------+
2071 |Attribute          |Qualifier|Cardinality|Content|Description            |
2072 +===================+=========+===========+=======+=======================+
2073 |global-customer-id |M        |1          |String |Global Customer ID     |
2074 +-------------------+---------+-----------+-------+-----------------------+
2075 |service-type       |M        |1          |String |Service Type           |
2076 +-------------------+---------+-----------+-------+-----------------------+
2077 |service-instance-id|M        |1          |String |Service instance ID    |
2078 +-------------------+---------+-----------+-------+-----------------------+
2079
2080 Response:
2081
2082 +---------+---------+-----------+-------+-------------------+
2083 |Attribute|Qualifier|Cardinality|Content|Description        |
2084 +---------+---------+-----------+-------+-------------------+
2085 |HTTP code|M        |1          |Integer|HTTP response code |
2086 +---------+---------+-----------+-------+-------------------+
2087
2088
2089 VFC APIs
2090 ---------
2091
2092 Create NS
2093 +++++++++++
2094
2095 +--------------------+-------------------+
2096 |Interface Definition|Description        |
2097 +====================+===================+
2098 |URI                 |/ns                |
2099 +--------------------+-------------------+
2100 |Operation Type      |POST               |
2101 +--------------------+-------------------+
2102 |Content-Type        |application/json   |
2103 +--------------------+-------------------+
2104
2105 Request Parameters:
2106
2107 +-------------------+---------+-----------+-------+-----------------------+
2108 |Attribute          |Qualifier|Cardinality|Content|Description            |
2109 +===================+=========+===========+=======+=======================+
2110 |context            |M        |1          |Object |Context                |
2111 +-------------------+---------+-----------+-------+-----------------------+
2112 |csarId             |M        |1          |String |csarId                 |
2113 +-------------------+---------+-----------+-------+-----------------------+
2114 |nsName             |M        |1          |String |Name of the NS         |
2115 +-------------------+---------+-----------+-------+-----------------------+
2116 |description        |M        |1          |String |description            |
2117 +-------------------+---------+-----------+-------+-----------------------+
2118
2119 Response:
2120
2121 +-----------------+---------+-----------+----------------+-------------------+
2122 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2123 +-----------------+---------+-----------+----------------+-------------------+
2124 |nsInstanceId     |M        |1          |String          |nsInstanceId       |
2125 +-----------------+---------+-----------+----------------+-------------------+
2126
2127 Get NS
2128 +++++++
2129
2130 +--------------------+-------------------+
2131 |Interface Definition|Description        |
2132 +====================+===================+
2133 |URI                 |/ns                |
2134 +--------------------+-------------------+
2135 |Operation Type      |GET                |
2136 +--------------------+-------------------+
2137 |Content-Type        |application/json   |
2138 +--------------------+-------------------+
2139
2140 Response:
2141
2142 +-----------------+---------+-----------+----------------+-------------------+
2143 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2144 +-----------------+---------+-----------+----------------+-------------------+
2145 |nsInstanceId     |M        |1          |String          |nsInstanceId       |
2146 +-----------------+---------+-----------+----------------+-------------------+
2147 |nsName           |M        |1          |String          |The name of ns     |
2148 +-----------------+---------+-----------+----------------+-------------------+
2149 |description      |M        |1          |String          |description        |
2150 +-----------------+---------+-----------+----------------+-------------------+
2151 |nsdId            |M        |1          |String          |ID of ns           |
2152 +-----------------+---------+-----------+----------------+-------------------+
2153 |vnfInfo          |M        |1          |Array           |Vnf information    |
2154 +-----------------+---------+-----------+----------------+-------------------+
2155 |vlInfo           |M        |1          |Array           |vl information     |
2156 +-----------------+---------+-----------+----------------+-------------------+
2157 |vnffgInfo        |M        |1          |Array           |vnffg information  |
2158 +-----------------+---------+-----------+----------------+-------------------+
2159 |nsState          |M        |1          |String          |state of ns        |
2160 +-----------------+---------+-----------+----------------+-------------------+
2161
2162 vnfInfo Object:
2163
2164 +-----------------+---------+-----------+----------------+-------------------+
2165 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2166 +-----------------+---------+-----------+----------------+-------------------+
2167 |vnfInstanceId    |M        |1          |String          |vnfInstanceId      |
2168 +-----------------+---------+-----------+----------------+-------------------+
2169 |vnfInstanceName  |M        |1          |String          |vnfInstanceName    |
2170 +-----------------+---------+-----------+----------------+-------------------+
2171 |vnfdId           |M        |1          |String          |vnfdId             |
2172 +-----------------+---------+-----------+----------------+-------------------+
2173
2174 vlInfo Object:
2175
2176 +----------------------+---------+-----------+----------------+-------------------+
2177 |Attribute             |Qualifier|Cardinality|Content         |Description        |
2178 +----------------------+---------+-----------+----------------+-------------------+
2179 |vlInstanceId          |M        |1          |String          |vlInstanceId       |
2180 +----------------------+---------+-----------+----------------+-------------------+
2181 |vlInstanceName        |M        |1          |String          |vlInstanceName     |
2182 +----------------------+---------+-----------+----------------+-------------------+
2183 |vldId                 |M        |1          |String          |vldId              |
2184 +----------------------+---------+-----------+----------------+-------------------+
2185 |relatedCpInstanceId   |M        |1          |Array           |relatedCpInstanceId|
2186 +----------------------+---------+-----------+----------------+-------------------+
2187
2188 relatedCpInstanceId Array:
2189
2190 +----------------------+---------+-----------+----------------+-------------------+
2191 |Attribute             |Qualifier|Cardinality|Content         |Description        |
2192 +----------------------+---------+-----------+----------------+-------------------+
2193 |cpInstanceId          |M        |1          |String          |cpInstanceId       |
2194 +----------------------+---------+-----------+----------------+-------------------+
2195 |cpInstanceName        |M        |1          |String          |cpInstanceName     |
2196 +----------------------+---------+-----------+----------------+-------------------+
2197 |cpdId                 |M        |1          |String          |cpdId              |
2198 +----------------------+---------+-----------+----------------+-------------------+
2199
2200 vnffgInfo Array:
2201
2202 +----------------------+---------+-----------+----------------+-------------------+
2203 |Attribute             |Qualifier|Cardinality|Content         |Description        |
2204 +----------------------+---------+-----------+----------------+-------------------+
2205 |vnffgInstanceId       |M        |1          |String          |vnffgInstanceId    |
2206 +----------------------+---------+-----------+----------------+-------------------+
2207 |vnfId                 |M        |1          |String          |vnfId              |
2208 +----------------------+---------+-----------+----------------+-------------------+
2209 |pnfId                 |M        |1          |String          |pnfId              |
2210 +----------------------+---------+-----------+----------------+-------------------+
2211 |virtualLinkId         |M        |1          |Array           |virtualLinkId      |
2212 +----------------------+---------+-----------+----------------+-------------------+
2213 |cpId                  |M        |1          |Array           |cpId               |
2214 +----------------------+---------+-----------+----------------+-------------------+
2215 |nfp                   |M        |1          |Array           |nfp                |
2216 +----------------------+---------+-----------+----------------+-------------------+
2217
2218 Instantiate NS
2219 +++++++++++++++
2220
2221 +--------------------+-------------------------------------+
2222 |Interface Definition|Description                          |
2223 +====================+=====================================+
2224 |URI                 |/ns/{nsInstanceId}/Instantiate       |
2225 +--------------------+-------------------------------------+
2226 |Operation Type      |POST                                 |
2227 +--------------------+-------------------------------------+
2228 |Content-Type        |application/json                     |
2229 +--------------------+-------------------------------------+
2230
2231 Request Parameters:
2232
2233 +----------------------+---------+-----------+-------+-----------------------+
2234 |Attribute             |Qualifier|Cardinality|Content|Description            |
2235 +======================+=========+===========+=======+=======================+
2236 |LocationConstraints   |M        |1          |Array  |LocationConstraints    |
2237 +----------------------+---------+-----------+-------+-----------------------+
2238 |additionalParamForNs  |M        |1          |String |additionalParamForNs   |
2239 +----------------------+---------+-----------+-------+-----------------------+
2240 |nsInstanceId          |M        |1          |String |nsInstanceId           |
2241 +----------------------+---------+-----------+-------+-----------------------+
2242
2243 LocationConstraints Array:
2244
2245 +----------------------+---------+-----------+-------+-----------------------+
2246 |Attribute             |Qualifier|Cardinality|Content|Description            |
2247 +======================+=========+===========+=======+=======================+
2248 |vnfProfileId          |M        |1          |String  |vnfProfileId          |
2249 +----------------------+---------+-----------+-------+-----------------------+
2250 |vimid                 |M        |1          |String |vimid                  |
2251 +----------------------+---------+-----------+-------+-----------------------+
2252
2253 Response:
2254
2255 +--------------+---------+-----------+-------+-----------------------+
2256 |Attribute     |Qualifier|Cardinality|Content|Description            |
2257 +==============+=========+===========+=======+=======================+
2258 |jobId         |M        |1          |String |jobId                  |
2259 +--------------+---------+-----------+-------+-----------------------+
2260
2261 Terminate NS
2262 +++++++++++++++
2263
2264 +--------------------+-------------------------------------+
2265 |Interface Definition|Description                          |
2266 +====================+=====================================+
2267 |URI                 |/ns/{ns_instance_id}/terminate       |
2268 +--------------------+-------------------------------------+
2269 |Operation Type      |POST                                 |
2270 +--------------------+-------------------------------------+
2271 |Content-Type        |application/json                     |
2272 +--------------------+-------------------------------------+
2273
2274 Request Parameters:
2275
2276 +----------------------------+---------+-----------+-------+-----------------------------+
2277 |Attribute                   |Qualifier|Cardinality|Content|Description                  |
2278 +============================+=========+===========+=======+=============================+
2279 |terminationType             |M        |1          |String |terminationType              |
2280 +----------------------------+---------+-----------+-------+-----------------------------+
2281 |gracefulTerminationTimeout  |M        |1          |String |gracefulTerminationTimeout   |
2282 +----------------------------+---------+-----------+-------+-----------------------------+
2283 |nsInstanceId                |M        |1          |String |nsInstanceId                 |
2284 +----------------------------+---------+-----------+-------+-----------------------------+
2285
2286 Response:
2287
2288 +--------------+---------+-----------+-------+-----------------------+
2289 |Attribute     |Qualifier|Cardinality|Content|Description            |
2290 +==============+=========+===========+=======+=======================+
2291 |jobId         |M        |1          |String |jobId                  |
2292 +--------------+---------+-----------+-------+-----------------------+
2293
2294 Delete NS
2295 +++++++++++++++
2296
2297 +--------------------+-------------------------------------+
2298 |Interface Definition|Description                          |
2299 +====================+=====================================+
2300 |URI                 |/ns/{ns_instance_id}                 |
2301 +--------------------+-------------------------------------+
2302 |Operation Type      |DELETE                               |
2303 +--------------------+-------------------------------------+
2304
2305 Request Parameters:
2306
2307 +----------------------------+---------+-----------+-------+-----------------------------+
2308 |Attribute                   |Qualifier|Cardinality|Content|Description                  |
2309 +============================+=========+===========+=======+=============================+
2310 |nsInstanceId                |M        |1          |String |nsInstanceId                 |
2311 +----------------------------+---------+-----------+-------+-----------------------------+
2312
2313 MultiVIM API
2314 ----------------
2315 Get token
2316 ++++++++++
2317
2318 https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
2319
2320 +--------------------+-----------------------------------------------------------------------------------------------+
2321 |Interface Definition|Description                                                                                    |
2322 +====================+===============================================================================================+
2323 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens     |
2324 +--------------------+-----------------------------------------------------------------------------------------------+
2325 |Operation Type      |POST                                                                                           |
2326 +--------------------+-----------------------------------------------------------------------------------------------+
2327 |Content-Type        |application/json                                                                               |
2328 +--------------------+-----------------------------------------------------------------------------------------------+
2329
2330 Request Body:
2331
2332 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2333 |Attribute       |Qualifier|Cardinality|Content                   |Description                                                                                                                                     |
2334 +================+=========+===========+==========================+================================================================================================================================================+
2335 |nocatalog       |O        |1          |string                    |The authentication response excludes the service catalog. By default, the response includes the service catalog.                                |
2336 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2337 |name            |O        |1          |string                    |The user name. Required if you do not specify the ID of the user. If you specify the user name, you must also specify the domain, by ID or name.|
2338 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2339 |auth            |M        |1          |object                    |An auth object.                                                                                                                                 |
2340 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2341 |user            |M        |1          |object                    |A user object.                                                                                                                                  |
2342 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2343 |scope           |O        |1          |string                    |The authorization scope, including either a project or a domain                                                                                 |
2344 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2345 |password        |M        |1          |object                    |The password object, contains the authentication information.                                                                                   |
2346 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2347 |id              |O        |1          |string                    |The ID of the user. Required if you do not specify the user name.                                                                               |
2348 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2349 |identity        |M        |1          |object                    |An identity object.                                                                                                                             |
2350 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2351 |methods         |M        |1          |array                     |The authentication method. For password authentication, specify password.                                                                       |
2352 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2353
2354 Response:
2355
2356 +-------------------------+------------------+--------------------------------------------------------------------------+
2357 |Attribute                |Content           |Description                                                               |
2358 +=========================+==================+==========================================================================+
2359 |X-Subject-Token          |String            |The authentication token.                                                 |
2360 +-------------------------+------------------+--------------------------------------------------------------------------+
2361 |domain                   |object            |A domain object, containing:                                              |
2362 +-------------------------+------------------+--------------------------------------------------------------------------+
2363 |region_id                |String            |The ID of the region that contains the service endpoint.                  |
2364 +-------------------------+------------------+--------------------------------------------------------------------------+
2365 |methods                  |array             |The authentication method. For password authentication, specify password. |
2366 +-------------------------+------------------+--------------------------------------------------------------------------+
2367 |roles                    |array             |A list of role objects, each containing:                                  |
2368 +-------------------------+------------------+--------------------------------------------------------------------------+
2369 |url                      |String            |The endpoint URL.                                                         |
2370 +-------------------------+------------------+--------------------------------------------------------------------------+
2371 |region                   |String            |The geographic location of the service endpoint.                          |
2372 +-------------------------+------------------+--------------------------------------------------------------------------+
2373 |token                    |object            |A token object.                                                           |
2374 +-------------------------+------------------+--------------------------------------------------------------------------+
2375 |expires_at               |String            |The date and time when the token expires.                                 |
2376 +-------------------------+------------------+--------------------------------------------------------------------------+
2377 |project                  |object            |A project object, containing:                                             |
2378 +-------------------------+------------------+--------------------------------------------------------------------------+
2379 |issued_at                |String            |The date and time when the token was issued.                              |
2380 +-------------------------+------------------+--------------------------------------------------------------------------+
2381 |catalog                  |array             |A catalog object.                                                         |
2382 +-------------------------+------------------+--------------------------------------------------------------------------+
2383 |extras                   |object            |A set of metadata key and value pairs, if any.                            |
2384 +-------------------------+------------------+--------------------------------------------------------------------------+
2385 |user                     |object            |A user object.                                                            |
2386 +-------------------------+------------------+--------------------------------------------------------------------------+
2387 |audit_ids                |array             |A list of one or two audit IDs.                                           |
2388 +-------------------------+------------------+--------------------------------------------------------------------------+
2389 |interface                |String            |The interface type, which describes the visibility of the endpoint.       |
2390 +-------------------------+------------------+--------------------------------------------------------------------------+
2391 |endpoints                |array             |A list of endpoint objects.                                               |
2392 +-------------------------+------------------+--------------------------------------------------------------------------+
2393 |type                     |String            |The endpoint type.                                                        |
2394 +-------------------------+------------------+--------------------------------------------------------------------------+
2395 |id                       |String            |The ID of the user. Required if you do not specify the user name.         |
2396 +-------------------------+------------------+--------------------------------------------------------------------------+
2397 |name                     |String            |The user name.                                                            |
2398 +-------------------------+------------------+--------------------------------------------------------------------------+
2399
2400 Create stack
2401 +++++++++++++
2402
2403 https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
2404
2405 +--------------------+-----------------------------------------------------------------------------------------------+
2406 |Interface Definition|Description                                                                                    |
2407 +====================+===============================================================================================+
2408 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks  |
2409 +--------------------+-----------------------------------------------------------------------------------------------+
2410 |Operation Type      |POST                                                                                           |
2411 +--------------------+-----------------------------------------------------------------------------------------------+
2412 |Content-Type        |application/json                                                                               |
2413 +--------------------+-----------------------------------------------------------------------------------------------+
2414
2415 Request Body:
2416
2417 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2418 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2419 +==================+=========+===========+==========================+=================================================================================================+
2420 |tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
2421 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2422 |disable_rollback  |O        |1          |boolean                   |Enables or disables deletion of all stack resources when stack creation fails.                   |
2423 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2424 |environment       |O        |1          |object                    |A JSON environment for the stack.                                                                |
2425 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2426 |files             |O        |1          |object                    |Supplies the contents of files referenced in the template or the environment.                    |
2427 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2428 |parameters        |O        |1          |object                    |Supplies arguments for parameters defined in the stack template.                                 |
2429 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2430 |stack_name        |M        |1          |string                    |A name for the stack.                                                                            |
2431 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2432 |tags              |O        |1          |string                    |One or more simple string tags to associate with the stack.                                      |
2433 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2434 |template          |O        |1          |object                    |The stack template on which to perform the operation.                                            |
2435 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2436 |template_url      |O        |1          |string                    |A URI to the location containing the stack template on which to perform the operation.           |
2437 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2438 |timeout_mins      |O        |1          |integer                   |The timeout for stack creation in minutes.                                                       |
2439 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2440
2441 Response:
2442
2443 +-------------------------+------------------+--------------------------------------------------------------------------+
2444 |Attribute                |Content           |Description                                                               |
2445 +=========================+==================+==========================================================================+
2446 |location                 |String            |For asynchronous resource operations.                                     |
2447 +-------------------------+------------------+--------------------------------------------------------------------------+
2448 |X-Openstack-Reqeuest-Id  |object            |A domain object, containing:                                              |
2449 +-------------------------+------------------+--------------------------------------------------------------------------+
2450 |stack                    |String            |The ID of the region that contains the service endpoint.                  |
2451 +-------------------------+------------------+--------------------------------------------------------------------------+
2452 |id                       |String            |The authentication method. For password authentication, specify password. |
2453 +-------------------------+------------------+--------------------------------------------------------------------------+
2454 |links                    |String            |The authentication method. For password authentication, specify password. |
2455 +-------------------------+------------------+--------------------------------------------------------------------------+
2456
2457 Get stack
2458 +++++++++++++
2459
2460 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2461
2462 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2463 |Interface Definition|Description                                                                                                            |
2464 +====================+=======================================================================================================================+
2465 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id}  |
2466 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2467 |Operation Type      |GET                                                                                                                    |
2468 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2469 |Content-Type        |application/json                                                                                                       |
2470 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2471
2472 Request Body:
2473
2474 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2475 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2476 +==================+=========+===========+==========================+=================================================================================================+
2477 |tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
2478 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2479 |stack_name        |M        |1          |string                    |The name of a stack.                                                                             |
2480 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2481 |stack_id          |M        |1          |string                    |The UUID of the stack.                                                                           |
2482 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2483 |resolve_outputs   |O        |1          |boolean                   |A boolean indicating whether the outputs section of a stack should be resolved.                  |
2484 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2485
2486 Response:
2487
2488 +-------------------------+------------------+------------------------------------------------------------------------------+
2489 |Attribute                |Content           |Description                                                                   |
2490 +=========================+==================+==============================================================================+
2491 |X-Openstack-Reqeuest-Id  |String            |A unique ID for tracking service request.                                     |
2492 +-------------------------+------------------+------------------------------------------------------------------------------+
2493 |stack                    |Object            |The stack object.                                                             |
2494 +-------------------------+------------------+------------------------------------------------------------------------------+
2495 |capabilities             |array             |List of stack capabilities for stack.                                         |
2496 +-------------------------+------------------+------------------------------------------------------------------------------+
2497 |creation_time            |String            |The date and time when the resource was created.                              |
2498 +-------------------------+------------------+------------------------------------------------------------------------------+
2499 |deletion_time            |String            |The date and time when the resource was (soft-) deleted.                      |
2500 +-------------------------+------------------+------------------------------------------------------------------------------+
2501 |description              |String            |The description of the stack resource.                                        |
2502 +-------------------------+------------------+------------------------------------------------------------------------------+
2503 |disable_rollback         |boolean           |Whether deletion of all stack resources when stack creation fails is enabled. |
2504 +-------------------------+------------------+------------------------------------------------------------------------------+
2505 |id                       |String            |The UUID of the stack.                                                        |
2506 +-------------------------+------------------+------------------------------------------------------------------------------+
2507 |links                    |array             |A list of URLs for the stack.                                                 |
2508 +-------------------------+------------------+------------------------------------------------------------------------------+
2509 |notification_topics      |array             |List of notification topics for stack.                                        |
2510 +-------------------------+------------------+------------------------------------------------------------------------------+
2511 |outputs                  |array             |A list of stack outputs.                                                      |
2512 +-------------------------+------------------+------------------------------------------------------------------------------+
2513 |parameters               |object            |  A group of key-value pairs                                                  |
2514 +-------------------------+------------------+------------------------------------------------------------------------------+
2515 |parent                   |String            |The stack ID of the parent stack, if this is a nested stack.                  |
2516 +-------------------------+------------------+------------------------------------------------------------------------------+
2517 |stack_name               |String            |A name for the stack.                                                         |
2518 +-------------------------+------------------+------------------------------------------------------------------------------+
2519 |stack_owner              |String            |The owner of the stack.                                                       |
2520 +-------------------------+------------------+------------------------------------------------------------------------------+
2521 |stack_status             |String            |The status of the stack.                                                      |
2522 +-------------------------+------------------+------------------------------------------------------------------------------+
2523 |stack_status_reason      |String            |The reason for the current status of the stack.                               |
2524 +-------------------------+------------------+------------------------------------------------------------------------------+
2525 |stack_user_project_id    |String            |The project UUID of the stack user.                                           |
2526 +-------------------------+------------------+------------------------------------------------------------------------------+
2527 |tags                     |array             |The stack tags.                                                               |
2528 +-------------------------+------------------+------------------------------------------------------------------------------+
2529 |template_description     |String            |The description of the stack template.                                        |
2530 +-------------------------+------------------+------------------------------------------------------------------------------+
2531 |timeout_mins             |integer           |The timeout for stack creation in minutes.                                    |
2532 +-------------------------+------------------+------------------------------------------------------------------------------+
2533 |updated_time             |String            |The date and time when the object was updated.                                |
2534 +-------------------------+------------------+------------------------------------------------------------------------------+
2535
2536 Delete stack
2537 +++++++++++++
2538
2539 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2540
2541 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2542 |Interface Definition|Description                                                                                                            |
2543 +====================+=======================================================================================================================+
2544 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id}  |
2545 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2546 |Operation Type      |DELETE                                                                                                                 |
2547 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2548 |Content-Type        |application/json                                                                                                       |
2549 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2550
2551 Request Body:
2552
2553 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2554 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2555 +==================+=========+===========+==========================+=================================================================================================+
2556 |tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
2557 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2558 |stack_name        |M        |1          |string                    |The name of a stack.                                                                             |
2559 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2560 |stack_id          |M        |1          |string                    |The UUID of the stack.                                                                           |
2561 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2562
2563 Create server
2564 +++++++++++++
2565
2566 https://developer.openstack.org/api-ref/compute/#create-server
2567
2568 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2569 |Interface Definition|Description                                                                                                            |
2570 +====================+=======================================================================================================================+
2571 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers                       |
2572 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2573 |Operation Type      |POST                                                                                                                   |
2574 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2575 |Content-Type        |application/json                                                                                                       |
2576 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2577
2578 Request Body:
2579
2580 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2581 |Attribute                                       |Qualifier|Cardinality|Content                   |Description                                                                                      |
2582 +================================================+=========+===========+==========================+=================================================================================================+
2583 |server                                          |M        |1          |object                    |A server object.                                                                                 |
2584 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2585 |name                                            |M        |1          |string                    |The server name.                                                                                 |
2586 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2587 |flavorRef                                       |M        |1          |string                    |The flavor reference, as an ID (including a UUID) or full URL                                    |
2588 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2589 |imageRef                                        |M        |1          |string                    |The UUID of the image to use for your server instance                                            |
2590 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2591 |security_groups                                 |O        |1          |array                     |One or more security groups.                                                                     |
2592 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2593 |metadata                                        |O        |1          |object                    |Metadata key and value pairs.                                                                    |
2594 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2595 |accessIPv4                                      |O        |1          |string                    |IPv4 address that should be used to access this server.                                          |
2596 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2597 |accessIPv6                                      |O        |1          |string                    |IPv6 address that should be used to access this server.                                          |
2598 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2599 |adminPass                                       |O        |1          |string                    |The administrative password of the server.                                                       |
2600 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2601 |user_data                                       |O        |1          |string                    |Configuration information or scripts to use upon launch.                                         |
2602 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2603 |availability_zone                               |O        |1          |string                    |The availability zone from which to launch the server.                                           |
2604 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2605 |networks                                        |M        |1          |object                    |A networks object.                                                                               |
2606 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2607 |networks.uuid                                   |O        |1          |string                    |To provision the server instance with a NIC for a network                                        |
2608 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2609 |networks.port                                   |O        |1          |string                    |To provision the server instance with a NIC for an already existing port                         |
2610 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2611 |networks.fixed_ip                               |O        |1          |string                    |A fixed IPv4 address for the NIC                                                                 |
2612 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2613 |networks.tag                                    |O        |1          |string                    |A device role tag that can be applied to a network interface.                                    |
2614 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2615 |personality                                     |O        |1          |array                     |The file path and contents, text only, to inject into the server at launch.                      |
2616 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2617 |block_device_mapping_v2                         |O        |1          |array                     |Enables fine grained control of the block device mapping for an instance.                        |
2618 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2619 |block_device_mapping_v2.device_name             |M        |1          |string                    |A path to the device for the volume that you want to use to boot the server.                     |
2620 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2621 |block_device_mapping_v2.source_type             |M        |1          |string                    |The source type of the volume.                                                                   |
2622 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2623 |block_device_mapping_v2.destination_type        |O        |1          |string                    |Defines where the volume comes from.                                                             |
2624 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2625 |block_device_mapping_v2.delete_on_termination   |O        |1          |string                    |To delete the boot volume when the server is destroyed, specify true.                            |
2626 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2627 |block_device_mapping_v2.guest_format            |M        |1          |string                    |Specifies the guest server disk file system format, such as ephemeral or swap.                   |
2628 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2629 |block_device_mapping_v2.boot_index              |M        |1          |string                    |Defines the order in which a hypervisor tries devices                                            |
2630 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2631 |block_device_mapping_v2.uuid                    |O        |1          |string                    |This is the uuid of source resource.                                                             |
2632 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2633 |block_device_mapping_v2.tag                     |O        |1          |string                    |A device role tag that can be applied to a block device.                                         |
2634 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2635 |block_device_mapping_v2.disk_bus                |O        |1          |string                    |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter          |
2636 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2637 |config_drive                                    |O        |1          |boolean                   |Indicates whether a configuration drive enables metadata injection.                              |
2638 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2639 |key_name                                        |O        |1          |string                    |Key pair name.                                                                                   |
2640 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2641 |os:scheduler_hints                              |O        |1          |object                    |The dictionary of data to send to the scheduler.                                                 |
2642 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2643 |OS-DCF:diskConfig                               |O        |1          |string                    |Controls how the API partitions the disk when you create, rebuild, or resize servers.            |
2644 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2645 |description                                     |O        |1          |string                    |A free form description of the server.                                                           |
2646 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2647 |tags                                            |O        |1          |array                     |A list of tags.                                                                                  |
2648 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2649
2650 Response:
2651
2652 +-------------------------+------------------+------------------------------------------------------------------------------+
2653 |Attribute                |Content           |Description                                                                   |
2654 +=========================+==================+==============================================================================+
2655 |server                   |object            |A server object.                                                              |
2656 +-------------------------+------------------+------------------------------------------------------------------------------+
2657 |id                       |String            |The UUID of the server.                                                       |
2658 +-------------------------+------------------+------------------------------------------------------------------------------+
2659 |links                    |array             |Links to the resources in question.                                           |
2660 +-------------------------+------------------+------------------------------------------------------------------------------+
2661 |OS-DCF:diskConfig        |String            |Disk configuration.                                                           |
2662 +-------------------------+------------------+------------------------------------------------------------------------------+
2663 |security_groups          |array             |One or more security groups objects.                                          |
2664 +-------------------------+------------------+------------------------------------------------------------------------------+
2665 |security_groups.name     |String            |The security group name.                                                      |
2666 +-------------------------+------------------+------------------------------------------------------------------------------+
2667 |adminPass                |String            |The administrative password for the server.                                   |
2668 +-------------------------+------------------+------------------------------------------------------------------------------+
2669
2670 Delete server
2671 +++++++++++++
2672
2673 https://developer.openstack.org/api-ref/compute/#delete-server
2674
2675 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2676 |Interface Definition|Description                                                                                                            |
2677 +====================+=======================================================================================================================+
2678 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id}           |
2679 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2680 |Operation Type      |DELETE                                                                                                                 |
2681 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2682 |Content-Type        |application/json                                                                                                       |
2683 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2684
2685 Request Body:
2686
2687 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2688 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2689 +==================+=========+===========+==========================+=================================================================================================+
2690 |server_id         |M        |1          |string                    |The UUID of the server.                                                                          |
2691 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2692
2693 Create Keypair
2694 +++++++++++++++
2695
2696 https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
2697
2698 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2699 |Interface Definition|Description                                                                                                            |
2700 +====================+=======================================================================================================================+
2701 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs                   |
2702 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2703 |Operation Type      |POST                                                                                                                   |
2704 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2705 |Content-Type        |application/json                                                                                                       |
2706 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2707
2708 Request Body:
2709
2710 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2711 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2712 +==================+=========+===========+==========================+=================================================================================================+
2713 |keypair           |M        |1          |Object                    |Keypair object                                                                                   |
2714 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2715 |name              |M        |1          |string                    |A name for the keypair which will be used to reference it later.                                 |
2716 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2717 |public_key        |O        |1          |string                    |The public ssh key to import. If you omit this value, a keypair is generated for you.            |
2718 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2719 |type              |O        |1          |string                    |The type of the keypair.                                                                         |
2720 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2721 |user_id           |O        |1          |string                    |The user_id for a keypair.                                                                       |
2722 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2723
2724 Response:
2725
2726 +-----------------+------------------+------------------------------------------------------------------------------+
2727 |Attribute        |Content           |Description                                                                   |
2728 +=================+==================+==============================================================================+
2729 |keypair          |object            |Keypair object                                                                |
2730 +-----------------+------------------+------------------------------------------------------------------------------+
2731 |name             |String            |A name for the keypair which will be used to reference it later.              |
2732 +-----------------+------------------+------------------------------------------------------------------------------+
2733 |public_key       |String            |The keypair public key.                                                       |
2734 +-----------------+------------------+------------------------------------------------------------------------------+
2735 |fingerprint      |String            |The fingerprint for the keypair.                                              |
2736 +-----------------+------------------+------------------------------------------------------------------------------+
2737 |user_id          |String            |The user_id for a keypair.                                                    |
2738 +-----------------+------------------+------------------------------------------------------------------------------+
2739 |private_key      |String            |If you do not provide a public key on create                                  |
2740 +-----------------+------------------+------------------------------------------------------------------------------+
2741 |type             |String            |The type of the keypair.                                                      |
2742 +-----------------+------------------+------------------------------------------------------------------------------+
2743
2744 Delete Keypair
2745 +++++++++++++++
2746
2747 https://developer.openstack.org/api-ref/compute/#delete-keypair
2748
2749 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2750 |Interface Definition|Description                                                                                                            |
2751 +====================+=======================================================================================================================+
2752 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id}      |
2753 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2754 |Operation Type      |DELETE                                                                                                                 |
2755 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2756 |Content-Type        |application/json                                                                                                       |
2757 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2758
2759 Request Body:
2760
2761 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2762 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2763 +==================+=========+===========+==========================+=================================================================================================+
2764 |keypair_name      |M        |1          |String                    |The keypair name.                                                                                |
2765 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2766 |user_id           |O        |1          |String                    |This allows administrative users to operate key-pairs of specified user ID.                      |
2767 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2768
2769 Create Network
2770 +++++++++++++++
2771
2772 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
2773
2774 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2775 |Interface Definition|Description                                                                                                            |
2776 +====================+=======================================================================================================================+
2777 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks                               |
2778 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2779 |Operation Type      |POST                                                                                                                   |
2780 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2781 |Content-Type        |application/json                                                                                                       |
2782 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2783
2784 Request Body:
2785
2786 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2787 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
2788 +============================+=========+===========+==========================+=================================================================================================+
2789 |network                     |M        |1          |Object                    |A network object.                                                                                |
2790 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2791 |admin_state_up              |O        |1          |boolean                   |The administrative state of the network, which is up (true) or down (false).                     |
2792 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2793 |dns_domain                  |O        |1          |string                    |A valid DNS domain.                                                                              |
2794 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2795 |mtu                         |O        |1          |integer                   |The maximum transmission unit (MTU) value to address fragmentation.                              |
2796 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2797 |name                        |O        |1          |string                    |Human-readable name of the network.                                                              |
2798 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2799 |port_security_enabled       |O        |1          |boolean                   |The port security status of the network.                                                         |
2800 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2801 |project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2802 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2803 |provider:network_type       |O        |1          |string                    |The type of physical network that this network should be mapped to.                              |
2804 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2805 |provider:physical_network   |O        |1          |string                    |The physical network where this network should be implemented.                                   |
2806 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2807 |provider:segmentation_id    |O        |1          |integer                   |The ID of the isolated segment on the physical network.                                          |
2808 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2809 |qos_policy_id               |O        |1          |string                    |The ID of the QoS policy.                                                                        |
2810 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2811 |router:external             |O        |1          |boolean                   |Indicates whether this network can provide floating IPs via a router.                            |
2812 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2813 |segments                    |O        |1          |array                     |A list of provider segment objects.                                                              |
2814 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2815 |shared                      |O        |1          |boolean                   |Indicates whether this network is shared across all tenants.                                     |
2816 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2817 |tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2818 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2819 |vlan_transparent            |O        |1          |boolean                   |Indicates the VLAN transparency mode of the network,                                             |
2820 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2821 |description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
2822 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2823
2824 Response:
2825
2826 +-----------------------------+------------------+------------------------------------------------------------------------------+
2827 |Attribute                    |Content           |Description                                                                   |
2828 +=============================+==================+==============================================================================+
2829 |network                      |object            |A network object.                                                             |
2830 +-----------------------------+------------------+------------------------------------------------------------------------------+
2831 |admin_state_up               |boolean           |The administrative state of the network, which is up (true) or down (false).  |
2832 +-----------------------------+------------------+------------------------------------------------------------------------------+
2833 |availability_zone_hints      |array             |The availability zone candidate for the network.                              |
2834 +-----------------------------+------------------+------------------------------------------------------------------------------+
2835 |availability_zones           |array             |The availability zone for the network.                                        |
2836 +-----------------------------+------------------+------------------------------------------------------------------------------+
2837 |dns_domain                   |String            |A valid DNS domain.                                                           |
2838 +-----------------------------+------------------+------------------------------------------------------------------------------+
2839 |id                           |String            |The ID of the network.                                                        |
2840 +-----------------------------+------------------+------------------------------------------------------------------------------+
2841 |mtu                          |integer           |The maximum transmission unit (MTU) value to address fragmentation.           |
2842 +-----------------------------+------------------+------------------------------------------------------------------------------+
2843 |name                         |String            |Human-readable name of the network.                                           |
2844 +-----------------------------+------------------+------------------------------------------------------------------------------+
2845 |port_security_enabled        |boolean           |The port security status of the network.                                      |
2846 +-----------------------------+------------------+------------------------------------------------------------------------------+
2847 |project_id                   |String            |The ID of the project.                                                        |
2848 +-----------------------------+------------------+------------------------------------------------------------------------------+
2849 |provider:network_type        |String            |The type of physical network that this network is mapped to.                  |
2850 +-----------------------------+------------------+------------------------------------------------------------------------------+
2851 |provider:physical_network    |String            |The physical network where this network is implemented.                       |
2852 +-----------------------------+------------------+------------------------------------------------------------------------------+
2853 |provider:segmentation_id     |integer           |The ID of the isolated segment on the physical network.                       |
2854 +-----------------------------+------------------+------------------------------------------------------------------------------+
2855 |qos_policy_id                |String            |The ID of the QoS policy.                                                     |
2856 +-----------------------------+------------------+------------------------------------------------------------------------------+
2857 |revision_number              |integer           |The revision number of the resource.                                          |
2858 +-----------------------------+------------------+------------------------------------------------------------------------------+
2859 |router:external              |boolean           |Indicates whether this network can provide floating IPs via a router.         |
2860 +-----------------------------+------------------+------------------------------------------------------------------------------+
2861 |segments                     |array             |A list of provider segment objects.                                           |
2862 +-----------------------------+------------------+------------------------------------------------------------------------------+
2863 |shared                       |boolean           |Indicates whether this network is shared across all tenants.                  |
2864 +-----------------------------+------------------+------------------------------------------------------------------------------+
2865 |status                       |String            |The network status. Values are ACTIVE, DOWN, BUILD or ERROR.                  |
2866 +-----------------------------+------------------+------------------------------------------------------------------------------+
2867 |subnets                      |array             |The associated subnets.                                                       |
2868 +-----------------------------+------------------+------------------------------------------------------------------------------+
2869 |tenant_id                    |String            |The ID of the project.                                                        |
2870 +-----------------------------+------------------+------------------------------------------------------------------------------+
2871 |vlan_transparent             |boolean           |Indicates the VLAN transparency mode of the network.                          |
2872 +-----------------------------+------------------+------------------------------------------------------------------------------+
2873 |description                  |String            |A human-readable description for the resource.                                |
2874 +-----------------------------+------------------+------------------------------------------------------------------------------+
2875
2876 Delete Network
2877 +++++++++++++++
2878
2879 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
2880
2881 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2882 |Interface Definition|Description                                                                                                            |
2883 +====================+=======================================================================================================================+
2884 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id}                  |
2885 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2886 |Operation Type      |DELETE                                                                                                                 |
2887 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2888 |Content-Type        |application/json                                                                                                       |
2889 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2890
2891 Request Body:
2892
2893 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2894 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
2895 +============================+=========+===========+==========================+==============================================================+
2896 |network_id                  |M        |1          |Object                    |The ID of the network.                                        |
2897 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2898
2899 Create Subnet
2900 +++++++++++++++
2901
2902 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
2903
2904 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2905 |Interface Definition|Description                                                                                                            |
2906 +====================+=======================================================================================================================+
2907 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets                                |
2908 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2909 |Operation Type      |POST                                                                                                                   |
2910 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2911 |Content-Type        |application/json                                                                                                       |
2912 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2913
2914 Request Body:
2915
2916 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2917 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
2918 +============================+=========+===========+==========================+=================================================================================================+
2919 |subnet                      |M        |1          |string                    |A subnet object.                                                                                 |
2920 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2921 |tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2922 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2923 |project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2924 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2925 |name                        |O        |1          |string                    |Human-readable name of the resource.                                                             |
2926 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2927 |enable_dhcp                 |O        |1          |boolean                   |Indicates whether dhcp is enabled or disabled for the subnet.                                    |
2928 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2929 |network_id                  |M        |1          |string                    |The ID of the network to which the subnet belongs.                                               |
2930 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2931 |dns_nameservers             |O        |1          |array                     |List of dns name servers associated with the subnet.                                             |
2932 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2933 |allocation_pools            |O        |1          |array                     |Allocation pools with start and end IP addresses for this subnet.                                |
2934 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2935 |host_routes                 |O        |1          |array                     |Additional routes for the subnet.                                                                |
2936 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2937 |ip_version                  |M        |1          |integer                   |The IP protocol version. Value is 4 or 6.                                                        |
2938 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2939 |gateway_ip                  |O        |1          |string                    |Gateway IP of this subnet.                                                                       |
2940 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2941 |cidr                        |M        |1          |string                    |The CIDR of the subnet.                                                                          |
2942 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2943 |description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
2944 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2945 |ipv6_address_mode           |O        |1          |string                    |The IPv6 address modes specifies mechanisms for assigning IP addresses.                          |
2946 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2947 |ipv6_ra_mode                |O        |1          |string                    |The IPv6 router advertisement specifies whether the networking service                           |
2948 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2949 |segment_id                  |O        |1          |string                    |The ID of a network segment the subnet is associated with.                                       |
2950 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2951 |subnetpool_id               |O        |1          |string                    |The ID of the subnet pool associated with the subnet.                                            |
2952 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2953 |use_default_subnetpool      |O        |1          |boolean                   |Whether to allocate this subnet from the default subnet pool.                                    |
2954 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2955
2956 Response:
2957
2958 +-----------------------------+------------------+------------------------------------------------------------------------------+
2959 |Attribute                    |Content           |Description                                                                   |
2960 +=============================+==================+==============================================================================+
2961 |subnet                       |string            |A subnet object.                                                              |
2962 +-----------------------------+------------------+------------------------------------------------------------------------------+
2963 |id                           |string            |The ID of the subnet.                                                         |
2964 +-----------------------------+------------------+------------------------------------------------------------------------------+
2965 |tenant_id                    |string            |The ID of the project.                                                        |
2966 +-----------------------------+------------------+------------------------------------------------------------------------------+
2967 |project_id                   |string            |The ID of the project.                                                        |
2968 +-----------------------------+------------------+------------------------------------------------------------------------------+
2969 |name                         |String            |Human-readable name of the resource.                                          |
2970 +-----------------------------+------------------+------------------------------------------------------------------------------+
2971 |enable_dhcp                  |boolean           |Indicates whether dhcp is enabled or disabled for the subnet.                 |
2972 +-----------------------------+------------------+------------------------------------------------------------------------------+
2973 |network_id                   |String            |The ID of the network to which the subnet belongs.                            |
2974 +-----------------------------+------------------+------------------------------------------------------------------------------+
2975 |dns_nameservers              |array             |List of dns name servers associated with the subnet.                          |
2976 +-----------------------------+------------------+------------------------------------------------------------------------------+
2977 |allocation_pools             |array             |Allocation pools with start and end IP addresses for this subnet.             |
2978 +-----------------------------+------------------+------------------------------------------------------------------------------+
2979 |host_routes                  |array             |Additional routes for the subnet.                                             |
2980 +-----------------------------+------------------+------------------------------------------------------------------------------+
2981 |ip_version                   |integer           |The IP protocol version. Value is 4 or 6.                                     |
2982 +-----------------------------+------------------+------------------------------------------------------------------------------+
2983 |gateway_ip                   |string            |Gateway IP of this subnet.                                                    |
2984 +-----------------------------+------------------+------------------------------------------------------------------------------+
2985 |cidr                         |string            |The CIDR of the subnet.                                                       |
2986 +-----------------------------+------------------+------------------------------------------------------------------------------+
2987 |created_at                   |string            |Time at which the subnet has been created.                                    |
2988 +-----------------------------+------------------+------------------------------------------------------------------------------+
2989 |description                  |string            |A human-readable description for the resource.                                |
2990 +-----------------------------+------------------+------------------------------------------------------------------------------+
2991 |ipv6_address_mode            |string            |The IPv6 address modes specifies mechanisms for assigning IP addresses.       |
2992 +-----------------------------+------------------+------------------------------------------------------------------------------+
2993 |ipv6_ra_mode                 |string            |The IPv6 router advertisement specifies whether the networking service        |
2994 +-----------------------------+------------------+------------------------------------------------------------------------------+
2995 |revision_number              |integer           |The revision number of the resource.                                          |
2996 +-----------------------------+------------------+------------------------------------------------------------------------------+
2997 |service_types                |string            |The service types associated with the subnet.                                 |
2998 +-----------------------------+------------------+------------------------------------------------------------------------------+
2999 |subnetpool_id                |string            |The ID of the subnet pool associated with the subnet.                         |
3000 +-----------------------------+------------------+------------------------------------------------------------------------------+
3001 |segment_id                   |string            |The ID of a network segment the subnet is associated with.                    |
3002 +-----------------------------+------------------+------------------------------------------------------------------------------+
3003 |updated_at                   |string            |Time at which the subnet has been updated.                                    |
3004 +-----------------------------+------------------+------------------------------------------------------------------------------+
3005
3006 Delete Subnet
3007 +++++++++++++++
3008
3009 https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
3010
3011 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3012 |Interface Definition|Description                                                                                                            |
3013 +====================+=======================================================================================================================+
3014 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id}                    |
3015 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3016 |Operation Type      |DELETE                                                                                                                 |
3017 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3018 |Content-Type        |application/json                                                                                                       |
3019 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3020
3021 Request Body:
3022
3023 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3024 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3025 +============================+=========+===========+==========================+==============================================================+
3026 |subnet_id                   |M        |1          |String                    |The ID of the subnet.                                         |
3027 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3028
3029 Create Port
3030 +++++++++++++++
3031
3032 https://developer.openstack.org/api-ref/networking/v2/#create-port
3033
3034 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3035 |Interface Definition|Description                                                                                                            |
3036 +====================+=======================================================================================================================+
3037 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports                                  |
3038 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3039 |Operation Type      |POST                                                                                                                   |
3040 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3041 |Content-Type        |application/json                                                                                                       |
3042 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3043
3044 Request Body:
3045
3046 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3047 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
3048 +============================+=========+===========+==========================+=================================================================================================+
3049 |port                        |M        |1          |object                    |A port object.                                                                                   |
3050 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3051 |admin_state_up              |O        |1          |boolean                   |The administrative state of the resource.                                                        |
3052 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3053 |allowed_address_pairs       |O        |1          |array                     |A set of zero or more allowed address pairs.                                                     |
3054 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3055 |binding:host_id             |O        |1          |string                    |The ID of the host where the port resides.                                                       |
3056 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3057 |binding:profile             |O        |1          |string                    |A dictionary that enables the application running on the specific host                           |
3058 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3059 |binding:vnic_type           |O        |1          |string                    |The type of vNIC which this port should be attached to.                                          |
3060 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3061 |description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
3062 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3063 |device_id                   |O        |1          |string                    |The ID of the device that uses this port.                                                        |
3064 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3065 |device_owner                |O        |1          |string                    |The entity type that uses this port.                                                             |
3066 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3067 |dns_domain                  |O        |1          |string                    |A valid DNS domain.                                                                              |
3068 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3069 |dns_name                    |O        |1          |string                    |A valid DNS name.                                                                                |
3070 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3071 |extra_dhcp_opts             |O        |1          |array                     |A set of zero or more extra DHCP option pairs.                                                   |
3072 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3073 |fixed_ips                   |O        |1          |array                     |The IP addresses for the port.                                                                   |
3074 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3075 |mac_address                 |O        |1          |string                    |The MAC address of the port.                                                                     |
3076 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3077 |name                        |O        |1          |string                    |Human-readable name of the resource.                                                             |
3078 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3079 |network_id                  |M        |1          |string                    |The ID of the attached network.                                                                  |
3080 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3081 |port_security_enabled       |O        |1          |boolean                   |The port security status.                                                                        |
3082 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3083 |project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
3084 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3085 |security_groups             |O        |1          |array                     |The IDs of security groups applied to the port.                                                  |
3086 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3087 |tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
3088 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3089
3090 Response:
3091
3092 +-----------------------------+------------------+------------------------------------------------------------------------------+
3093 |Attribute                    |Content           |Description                                                                   |
3094 +=============================+==================+==============================================================================+
3095 |port                         |object            |A port object.                                                                |
3096 +-----------------------------+------------------+------------------------------------------------------------------------------+
3097 |admin_state_up               |boolean           |The administrative state of the resource.                                     |
3098 +-----------------------------+------------------+------------------------------------------------------------------------------+
3099 |allowed_address_pairs        |array             |A set of zero or more allowed address pairs.                                  |
3100 +-----------------------------+------------------+------------------------------------------------------------------------------+
3101 |binding:host_id              |string            |The ID of the host where the port resides.                                    |
3102 +-----------------------------+------------------+------------------------------------------------------------------------------+
3103 |binding:profile              |String            |A dictionary that enables the application running on the specific host        |
3104 +-----------------------------+------------------+------------------------------------------------------------------------------+
3105 |binding:vif_details          |object            |A dictionary which contains additional information on the port.               |
3106 +-----------------------------+------------------+------------------------------------------------------------------------------+
3107 |binding:vif_type             |String            |The type of which mechanism is used for the port.                             |
3108 +-----------------------------+------------------+------------------------------------------------------------------------------+
3109 |binding:vnic_type            |string            |The type of vNIC which this port should be attached to.                       |
3110 +-----------------------------+------------------+------------------------------------------------------------------------------+
3111 |created_at                   |string            |Time at which port has been created.                                          |
3112 +-----------------------------+------------------+------------------------------------------------------------------------------+
3113 |data_plane_status            |string            |Status of the underlying data plane of a port.                                |
3114 +-----------------------------+------------------+------------------------------------------------------------------------------+
3115 |description                  |string            |A human-readable description for the resource.                                |
3116 +-----------------------------+------------------+------------------------------------------------------------------------------+
3117 |device_id                    |string            |The ID of the device that uses this port.                                     |
3118 +-----------------------------+------------------+------------------------------------------------------------------------------+
3119 |device_owner                 |string            |The entity type that uses this port.                                          |
3120 +-----------------------------+------------------+------------------------------------------------------------------------------+
3121 |dns_assignment               |object            |Data assigned to a port by the Networking internal DNS                        |
3122 +-----------------------------+------------------+------------------------------------------------------------------------------+
3123 |dns_domain                   |string            |A valid DNS domain.                                                           |
3124 +-----------------------------+------------------+------------------------------------------------------------------------------+
3125 |dns_name                     |string            |A valid DNS name.                                                             |
3126 +-----------------------------+------------------+------------------------------------------------------------------------------+
3127 |extra_dhcp_opts              |array             |A set of zero or more extra DHCP option pairs.                                |
3128 +-----------------------------+------------------+------------------------------------------------------------------------------+
3129 |fixed_ips                    |array             |The IP addresses for the port.                                                |
3130 +-----------------------------+------------------+------------------------------------------------------------------------------+
3131 |id                           |string            |The ID of the resource.                                                       |
3132 +-----------------------------+------------------+------------------------------------------------------------------------------+
3133 |mac_address                  |string            |The MAC address of the port.                                                  |
3134 +-----------------------------+------------------+------------------------------------------------------------------------------+
3135 |name                         |string            |Human-readable name of the resource.                                          |
3136 +-----------------------------+------------------+------------------------------------------------------------------------------+
3137 |network_id                   |string            |The ID of the attached network.                                               |
3138 +-----------------------------+------------------+------------------------------------------------------------------------------+
3139 |port_security_enabled        |boolean           |The port security status.                                                     |
3140 +-----------------------------+------------------+------------------------------------------------------------------------------+
3141 |project_id                   |string            |The ID of the project.                                                        |
3142 +-----------------------------+------------------+------------------------------------------------------------------------------+
3143 |revision_number              |integer           |The revision number of the resource.                                          |
3144 +-----------------------------+------------------+------------------------------------------------------------------------------+
3145 |security_groups              |array             |The IDs of security groups applied to the port.                               |
3146 +-----------------------------+------------------+------------------------------------------------------------------------------+
3147 |status                       |string            |The port status. Values are ACTIVE, DOWN, BUILD and ERROR.                    |
3148 +-----------------------------+------------------+------------------------------------------------------------------------------+
3149 |tenant_id                    |string            |The ID of the project.                                                        |
3150 +-----------------------------+------------------+------------------------------------------------------------------------------+
3151 |updated_at                   |string            |Time at which port has been updated.                                          |
3152 +-----------------------------+------------------+------------------------------------------------------------------------------+
3153
3154 Delete Port
3155 +++++++++++++++
3156
3157 https://developer.openstack.org/api-ref/network/v2/#delete-port
3158
3159 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3160 |Interface Definition|Description                                                                                                            |
3161 +====================+=======================================================================================================================+
3162 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id}                        |
3163 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3164 |Operation Type      |DELETE                                                                                                                 |
3165 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3166 |Content-Type        |application/json                                                                                                       |
3167 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3168
3169 Request Body:
3170
3171 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3172 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3173 +============================+=========+===========+==========================+==============================================================+
3174 |port_id                     |M        |1          |String                    |The ID of the port.                                           |
3175 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3176
3177 Create Security Group
3178 ++++++++++++++++++++++
3179
3180 https://developer.openstack.org/api-ref/network/v2/#create-security-group
3181
3182 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3183 |Interface Definition|Description                                                                                                            |
3184 +====================+=======================================================================================================================+
3185 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups                        |
3186 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3187 |Operation Type      |POST                                                                                                                   |
3188 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3189 |Content-Type        |application/json                                                                                                       |
3190 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3191
3192 Request Body:
3193
3194 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3195 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3196 +============================+=========+===========+==========================+==============================================================+
3197 |security_group              |M        |1          |object                    |A security_group object.                                      |
3198 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3199 |tenant_id                   |M        |1          |string                    |The ID of the project.                                        |
3200 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3201 |project_id                  |M        |1          |string                    |The ID of the project.                                        |
3202 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3203 |description                 |O        |1          |string                    |A human-readable description for the resource.                |
3204 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3205 |name                        |M        |1          |string                    |Human-readable name of the resource.                          |
3206 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3207
3208 Response:
3209
3210 +-----------------------------+------------------+------------------------------------------------------------------------------+
3211 |Attribute                    |Content           |Description                                                                   |
3212 +=============================+==================+==============================================================================+
3213 |security_group               |object            |A security_group object.                                                      |
3214 +-----------------------------+------------------+------------------------------------------------------------------------------+
3215 |id                           |string            |The ID of the security group.                                                 |
3216 +-----------------------------+------------------+------------------------------------------------------------------------------+
3217 |tenant_id                    |string            |The ID of the project.                                                        |
3218 +-----------------------------+------------------+------------------------------------------------------------------------------+
3219 |project_id                   |string            |The ID of the project.                                                        |
3220 +-----------------------------+------------------+------------------------------------------------------------------------------+
3221 |revision_number              |integer           |The revision number of the resource.                                          |
3222 +-----------------------------+------------------+------------------------------------------------------------------------------+
3223 |name                         |string            |Human-readable name of the resource.                                          |
3224 +-----------------------------+------------------+------------------------------------------------------------------------------+
3225 |description                  |string            |A human-readable description for the resource.                                |
3226 +-----------------------------+------------------+------------------------------------------------------------------------------+
3227 |security_group_rules         |array             |A list of security_group_rule objects.                                        |
3228 +-----------------------------+------------------+------------------------------------------------------------------------------+
3229
3230 Delete security group
3231 ++++++++++++++++++++++
3232
3233 https://developer.openstack.org/api-ref/network/v2/#delete-security-group
3234
3235 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3236 |Interface Definition|Description                                                                                                            |
3237 +====================+=======================================================================================================================+
3238 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id}    |
3239 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3240 |Operation Type      |DELETE                                                                                                                 |
3241 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3242 |Content-Type        |application/json                                                                                                       |
3243 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3244
3245 Request Body:
3246
3247 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3248 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3249 +============================+=========+===========+==========================+==============================================================+
3250 |security_group_id           |M        |1          |String                    |The ID of the security group.                                 |
3251 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3252
3253 Create Security Group Rule
3254 ++++++++++++++++++++++++++
3255
3256 https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
3257
3258 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3259 |Interface Definition|Description                                                                                                            |
3260 +====================+=======================================================================================================================+
3261 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules                   |
3262 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3263 |Operation Type      |POST                                                                                                                   |
3264 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3265 |Content-Type        |application/json                                                                                                       |
3266 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3267
3268 Request Body:
3269
3270 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3271 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                     |
3272 +============================+=========+===========+==========================+================================================================================================+
3273 |security_group_rule         |M        |1          |object                    |A security_group_rule object.                                                                   |
3274 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3275 |remote_group_id             |O        |1          |string                    |The remote group UUID to associate with this security group rule.                               |
3276 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3277 |direction                   |M        |1          |string                    |Ingress or egress, which is the direction in which the metering rule is applied.                |
3278 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3279 |protocol                    |M        |1          |string                    |The IP protocol can be represented by a string, an integer, or null.                            |
3280 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3281 |ethertype                   |O        |1          |string                    |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3282 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3283 |port_range_max              |O        |1          |integer                   |The maximum port number in the range that is matched by the security group rule.                |
3284 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3285 |security_group_id           |M        |1          |string                    |The security group ID to associate with this security group rule.                               |
3286 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3287 |port_range_min              |O        |1          |integer                   |The minimum port number in the range that is matched by the security group rule.                |
3288 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3289 |remote_ip_prefix            |M        |1          |string                    |The remote IP prefix to associate with this metering rule packet.                               |
3290 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3291 |description                 |O        |1          |string                    |A human-readable description for the resource. Default is an empty string.                      |
3292 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3293
3294 Response:
3295
3296 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3297 |Attribute                    |Content           |Description                                                                                      |
3298 +=============================+==================+=================================================================================================+
3299 |security_group_rule          |object            |A security_group_rule object.                                                                    |
3300 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3301 |remote_group_id              |string            |The remote group UUID to associate with this security group rule.                                |
3302 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3303 |direction                    |string            |Ingress or egress, which is the direction in which the metering rule is applied.                 |
3304 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3305 |protocol                     |string            |The IP protocol can be represented by a string, an integer, or null.                             |
3306 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3307 |ethertype                    |string            |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.  |
3308 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3309 |port_range_max               |integer           |The maximum port number in the range that is matched by the security group rule.                 |
3310 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3311 |security_group_id            |string            |The security group ID to associate with this security group rule.                                |
3312 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3313 |tenant_id                    |string            |The ID of the project.                                                                           |
3314 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3315 |project_id                   |string            |The ID of the project.                                                                           |
3316 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3317 |port_range_min               |integer           |The minimum port number in the range that is matched by the security group rule.                 |
3318 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3319 |remote_ip_prefix             |string            |The remote IP prefix to associate with this metering rule packet.                                |
3320 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3321 |revision_number              |integer           |The revision number of the resource.                                                             |
3322 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3323 |id                           |string            |The ID of the security group rule.                                                               |
3324 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3325 |description                  |string            |A human-readable description for the resource.                                                   |
3326 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3327
3328 Delete security group
3329 ++++++++++++++++++++++
3330
3331 https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
3332
3333 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3334 |Interface Definition|Description                                                                                                                      |
3335 +====================+=================================================================================================================================+
3336 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id}    |
3337 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3338 |Operation Type      |DELETE                                                                                                                           |
3339 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3340 |Content-Type        |application/json                                                                                                                 |
3341 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3342
3343 Request Body:
3344
3345 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3346 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3347 +============================+=========+===========+==========================+==============================================================+
3348 |security_group_rule_id      |M        |1          |String                    |The ID of the security group rule.                            |
3349 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3350
3351 Policy API
3352 ----------
3353
3354 Create a dictionary item
3355 ++++++++++++++++++++++++
3356
3357 +--------------------+--------------------------+
3358 |Interface Definition|Description               |
3359 +====================+==========================+
3360 |URI                 |/createDictionaryItem     |
3361 +--------------------+--------------------------+
3362 |Operation Type      |PUT                       |
3363 +--------------------+--------------------------+
3364
3365 Request Parameters:
3366
3367 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3368 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3369 +===================+=========+===========+=======+=============================================================+
3370 |dictionory         |M        |1          |String |                                                             |
3371 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3372 |dictionaryJson     |M        |1          |String |                                                             |
3373 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3374 |dictionaryType     |M        |1          |String |                                                             |
3375 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3376 |requestId          |M        |1          |String |                                                             |
3377 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3378
3379 Request Headers:
3380
3381 +-------------------+---------+-----------------------------------------------------------------------------------------+
3382 |Header Name        |Qualifier|Description                                                                              |
3383 +===================+=========+=========================================================================================+
3384 |ClientAuth         |Y        |encoded client authentication details                                                    |
3385 +-------------------+---------+-----------------------------------------------------------------------------------------+
3386 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3387 +-------------------+---------+-----------------------------------------------------------------------------------------+
3388 |Environment        |Y        |execution environments                                                                   |
3389 +-------------------+---------+-----------------------------------------------------------------------------------------+
3390 |Authorization      |Y        |Base64 encoded username:password                                                         |
3391 +-------------------+---------+-----------------------------------------------------------------------------------------+
3392
3393 HTTP Response Code:
3394
3395 +------------------+---------------------+
3396 |HTTP CODE         |Description          |
3397 +==================+=====================+
3398 |200               |successful           |
3399 +------------------+---------------------+
3400 |400               |Invalid Request      |
3401 +------------------+---------------------+
3402 |401               |Unauthorized         |
3403 +------------------+---------------------+
3404 |500               |Error                |
3405 +------------------+---------------------+
3406
3407 Create Policy
3408 +++++++++++++
3409
3410 +--------------------+--------------------------+
3411 |Interface Definition|Description               |
3412 +====================+==========================+
3413 |URI                 |/createPolicy             |
3414 +--------------------+--------------------------+
3415 |Operation Type      |PUT                       |
3416 +--------------------+--------------------------+
3417
3418 Request Parameters:
3419
3420 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3421 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3422 +===================+=========+===========+=======+=============================================================+
3423 |attributes         |M        |1          |Object |set of attributes in key value pair                          |
3424 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3425 |configBody         |M        |1          |String |                                                             |
3426 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3427 |configBodyType     |M        |1          |String |                                                             |
3428 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3429 |configName         |M        |1          |String |                                                             |
3430 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3431 |ecompName          |M        |1          |String |                                                             |
3432 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3433 |policyClass        |M        |1          |String |                                                             |
3434 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3435 |policyConfigType   |M        |1          |String |                                                             |
3436 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3437 |policyDescription  |M        |1          |String |                                                             |
3438 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3439 |policyName         |M        |1          |String |                                                             |
3440 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3441 |requestID          |M        |1          |String |request ID                                                   |
3442 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3443
3444 Request Headers:
3445
3446 +-------------------+---------+-----------------------------------------------------------------------------------------+
3447 |Header Name        |Qualifier|Description                                                                              |
3448 +===================+=========+=========================================================================================+
3449 |ClientAuth         |Y        |encoded client authentication details                                                    |
3450 +-------------------+---------+-----------------------------------------------------------------------------------------+
3451 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3452 +-------------------+---------+-----------------------------------------------------------------------------------------+
3453 |Environment        |Y        |execution environments                                                                   |
3454 +-------------------+---------+-----------------------------------------------------------------------------------------+
3455 |Authorization      |Y        |Base64 encoded username:password                                                         |
3456 +-------------------+---------+-----------------------------------------------------------------------------------------+
3457
3458 HTTP Response Code:
3459
3460 +------------------+---------------------+
3461 |HTTP CODE         |Description          |
3462 +==================+=====================+
3463 |200               |successful           |
3464 +------------------+---------------------+
3465 |400               |Invalid Request      |
3466 +------------------+---------------------+
3467 |401               |Unauthorized         |
3468 +------------------+---------------------+
3469 |500               |Error                |
3470 +------------------+---------------------+
3471
3472 Delete Policy
3473 +++++++++++++
3474
3475 +--------------------+--------------------------+
3476 |Interface Definition|Description               |
3477 +====================+==========================+
3478 |URI                 |/deletePolicy             |
3479 +--------------------+--------------------------+
3480 |Operation Type      |DELETE                    |
3481 +--------------------+--------------------------+
3482
3483 Request Parameters:
3484
3485 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3486 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3487 +===================+=========+===========+=======+=============================================================+
3488 |deleteCondition    |M        |1          |String |                                                             |
3489 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3490 |pdpGroup           |M        |1          |String |                                                             |
3491 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3492 |policyComponent    |M        |1          |String |                                                             |
3493 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3494 |policyName         |M        |1          |String |                                                             |
3495 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3496 |policyType         |M        |1          |String |                                                             |
3497 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3498 |requestID          |M        |1          |String |request ID                                                   |
3499 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3500
3501 Request Headers:
3502
3503 +-------------------+---------+-----------------------------------------------------------------------------------------+
3504 |Header Name        |Qualifier|Description                                                                              |
3505 +===================+=========+=========================================================================================+
3506 |ClientAuth         |Y        |encoded client authentication details                                                    |
3507 +-------------------+---------+-----------------------------------------------------------------------------------------+
3508 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3509 +-------------------+---------+-----------------------------------------------------------------------------------------+
3510 |Environment        |Y        |execution environments                                                                   |
3511 +-------------------+---------+-----------------------------------------------------------------------------------------+
3512 |Authorization      |Y        |Base64 encoded username:password                                                         |
3513 +-------------------+---------+-----------------------------------------------------------------------------------------+
3514
3515 HTTP Response Code:
3516
3517 +------------------+---------------------+
3518 |HTTP CODE         |Description          |
3519 +==================+=====================+
3520 |200               |successful           |
3521 +------------------+---------------------+
3522 |400               |Invalid Request      |
3523 +------------------+---------------------+
3524 |401               |Unauthorized         |
3525 +------------------+---------------------+
3526 |500               |Error                |
3527 +------------------+---------------------+
3528
3529 Get Configuration
3530 +++++++++++++++++
3531
3532 +--------------------+--------------------------+
3533 |Interface Definition|Description               |
3534 +====================+==========================+
3535 |URI                 |/getConfig                |
3536 +--------------------+--------------------------+
3537 |Operation Type      |POST                      |
3538 +--------------------+--------------------------+
3539
3540 Request Parameters:
3541
3542 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3543 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3544 +===================+=========+===========+=======+=============================================================+
3545 |configAttributes   |M        |1          |String |                                                             |
3546 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3547 |configName         |M        |1          |String |                                                             |
3548 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3549 |ecompName          |M        |1          |String |                                                             |
3550 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3551 |policyName         |M        |1          |String |                                                             |
3552 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3553 |unique             |M        |1          |Boolean|                                                             |
3554 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3555 |requestID          |M        |1          |String |request ID                                                   |
3556 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3557
3558 Request Headers:
3559
3560 +-------------------+---------+-----------------------------------------------------------------------------------------+
3561 |Header Name        |Qualifier|Description                                                                              |
3562 +===================+=========+=========================================================================================+
3563 |ClientAuth         |Y        |encoded client authentication details                                                    |
3564 +-------------------+---------+-----------------------------------------------------------------------------------------+
3565 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3566 +-------------------+---------+-----------------------------------------------------------------------------------------+
3567 |Environment        |Y        |execution environments                                                                   |
3568 +-------------------+---------+-----------------------------------------------------------------------------------------+
3569 |Authorization      |Y        |Base64 encoded username:password                                                         |
3570 +-------------------+---------+-----------------------------------------------------------------------------------------+
3571
3572 HTTP Response Code:
3573
3574 +------------------+---------------------+
3575 |HTTP CODE         |Description          |
3576 +==================+=====================+
3577 |200               |successful           |
3578 +------------------+---------------------+
3579 |400               |Invalid Request      |
3580 +------------------+---------------------+
3581 |401               |Unauthorized         |
3582 +------------------+---------------------+
3583 |500               |Error                |
3584 +------------------+---------------------+
3585
3586 Get Decision
3587 ++++++++++++
3588
3589 +--------------------+--------------------------+
3590 |Interface Definition|Description               |
3591 +====================+==========================+
3592 |URI                 |/getDecision              |
3593 +--------------------+--------------------------+
3594 |Operation Type      |POST                      |
3595 +--------------------+--------------------------+
3596
3597 Request Parameters:
3598
3599 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3600 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3601 +===================+=========+===========+=======+=============================================================+
3602 |decisionAttributes |M        |1          |Object |                                                             |
3603 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3604 |ecompComponentName |M        |1          |String |                                                             |
3605 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3606 |requestID          |M        |1          |String |request ID                                                   |
3607 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3608
3609 Request Headers:
3610
3611 +-------------------+---------+-----------------------------------------------------------------------------------------+
3612 |Header Name        |Qualifier|Description                                                                              |
3613 +===================+=========+=========================================================================================+
3614 |ClientAuth         |Y        |encoded client authentication details                                                    |
3615 +-------------------+---------+-----------------------------------------------------------------------------------------+
3616 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3617 +-------------------+---------+-----------------------------------------------------------------------------------------+
3618 |Environment        |Y        |execution environments                                                                   |
3619 +-------------------+---------+-----------------------------------------------------------------------------------------+
3620 |Authorization      |Y        |Base64 encoded username:password                                                         |
3621 +-------------------+---------+-----------------------------------------------------------------------------------------+
3622
3623 HTTP Response Code:
3624
3625 +------------------+---------------------+
3626 |HTTP CODE         |Description          |
3627 +==================+=====================+
3628 |200               |successful           |
3629 +------------------+---------------------+
3630 |400               |Invalid Request      |
3631 +------------------+---------------------+
3632 |401               |Unauthorized         |
3633 +------------------+---------------------+
3634 |500               |Error                |
3635 +------------------+---------------------+
3636
3637 Response Parameters:
3638
3639 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3640 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3641 +===================+=========+===========+=======+=============================================================+
3642 |decision           |N        |1          |String |                                                             |
3643 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3644 |details            |N        |1          |String |                                                             |
3645 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3646
3647 Get Dictionary Items
3648 ++++++++++++++++++++
3649
3650 +--------------------+--------------------------+
3651 |Interface Definition|Description               |
3652 +====================+==========================+
3653 |URI                 |/getDictionaryItems       |
3654 +--------------------+--------------------------+
3655 |Operation Type      |POST                      |
3656 +--------------------+--------------------------+
3657
3658 Request Parameters:
3659
3660 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3661 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3662 +===================+=========+===========+=======+=============================================================+
3663 |dictionary         |N        |1          |String |                                                             |
3664 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3665 |dictionaryJson     |N        |1          |String |                                                             |
3666 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3667 |dictionaryType     |N        |1          |String |                                                             |
3668 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3669 |requestID          |M        |1          |String |request ID                                                   |
3670 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3671
3672 Request Headers:
3673
3674 +-------------------+---------+-----------------------------------------------------------------------------------------+
3675 |Header Name        |Qualifier|Description                                                                              |
3676 +===================+=========+=========================================================================================+
3677 |ClientAuth         |Y        |encoded client authentication details                                                    |
3678 +-------------------+---------+-----------------------------------------------------------------------------------------+
3679 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3680 +-------------------+---------+-----------------------------------------------------------------------------------------+
3681 |Environment        |Y        |execution environments                                                                   |
3682 +-------------------+---------+-----------------------------------------------------------------------------------------+
3683 |Authorization      |Y        |Base64 encoded username:password                                                         |
3684 +-------------------+---------+-----------------------------------------------------------------------------------------+
3685
3686 HTTP Response Code:
3687
3688 +------------------+---------------------+
3689 |HTTP CODE         |Description          |
3690 +==================+=====================+
3691 |200               |successful           |
3692 +------------------+---------------------+
3693 |400               |Invalid Request      |
3694 +------------------+---------------------+
3695 |401               |Unauthorized         |
3696 +------------------+---------------------+
3697 |500               |Error                |
3698 +------------------+---------------------+
3699
3700 Response Parameters:
3701
3702 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3703 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3704 +===================+=========+===========+=======+=============================================================+
3705 |dictionaryData     |N        |1          |Object |                                                             |
3706 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3707 |dictionaryJson     |N        |1          |Object |                                                             |
3708 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3709 |responseCode       |N        |1          |Integer|                                                             |
3710 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3711 |responseMessage    |N        |1          |Object |                                                             |
3712 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3713
3714 Get Metrics
3715 +++++++++++
3716
3717 +--------------------+--------------------------+
3718 |Interface Definition|Description               |
3719 +====================+==========================+
3720 |URI                 |/getMetrics               |
3721 +--------------------+--------------------------+
3722 |Operation Type      |GET                       |
3723 +--------------------+--------------------------+
3724
3725 Request Headers:
3726
3727 +-------------------+---------+-----------------------------------------------------------------------------------------+
3728 |Header Name        |Qualifier|Description                                                                              |
3729 +===================+=========+=========================================================================================+
3730 |ClientAuth         |Y        |encoded client authentication details                                                    |
3731 +-------------------+---------+-----------------------------------------------------------------------------------------+
3732 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3733 +-------------------+---------+-----------------------------------------------------------------------------------------+
3734 |Environment        |Y        |execution environments                                                                   |
3735 +-------------------+---------+-----------------------------------------------------------------------------------------+
3736 |Authorization      |Y        |Base64 encoded username:password                                                         |
3737 +-------------------+---------+-----------------------------------------------------------------------------------------+
3738
3739 HTTP Response Code:
3740
3741 +------------------+---------------------+
3742 |HTTP CODE         |Description          |
3743 +==================+=====================+
3744 |200               |successful           |
3745 +------------------+---------------------+
3746 |400               |Invalid Request      |
3747 +------------------+---------------------+
3748 |401               |Unauthorized         |
3749 +------------------+---------------------+
3750 |500               |Error                |
3751 +------------------+---------------------+
3752
3753 Response Parameters:
3754
3755 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3756 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3757 +===================+=========+===========+=======+=============================================================+
3758 |metricsTotal       |N        |1          |Integer|                                                             |
3759 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3760 |papMetrics         |N        |1          |Integer|                                                             |
3761 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3762 |pdpMetrics         |N        |1          |Integer|                                                             |
3763 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3764 |responseCode       |N        |1          |Object |                                                             |
3765 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3766 |responseMessage    |N        |1          |String |                                                             |
3767 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3768
3769 Get Notification
3770 ++++++++++++++++
3771
3772 +--------------------+--------------------------+
3773 |Interface Definition|Description               |
3774 +====================+==========================+
3775 |URI                 |/getNotification          |
3776 +--------------------+--------------------------+
3777 |Operation Type      |POST                      |
3778 +--------------------+--------------------------+
3779
3780 Request Headers:
3781
3782 +-------------------+---------+-----------------------------------------------------------------------------------------+
3783 |Header Name        |Qualifier|Description                                                                              |
3784 +===================+=========+=========================================================================================+
3785 |ClientAuth         |Y        |encoded client authentication details                                                    |
3786 +-------------------+---------+-----------------------------------------------------------------------------------------+
3787 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3788 +-------------------+---------+-----------------------------------------------------------------------------------------+
3789 |Environment        |Y        |execution environments                                                                   |
3790 +-------------------+---------+-----------------------------------------------------------------------------------------+
3791 |Authorization      |Y        |Base64 encoded username:password                                                         |
3792 +-------------------+---------+-----------------------------------------------------------------------------------------+
3793
3794 HTTP Response Code:
3795
3796 +------------------+---------------------+
3797 |HTTP CODE         |Description          |
3798 +==================+=====================+
3799 |200               |successful           |
3800 +------------------+---------------------+
3801 |400               |Invalid Request      |
3802 +------------------+---------------------+
3803 |401               |Unauthorized         |
3804 +------------------+---------------------+
3805 |500               |Error                |
3806 +------------------+---------------------+
3807
3808 Response Parameters:
3809
3810 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3811 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3812 +===================+=========+===========+=======+=============================================================+
3813 |metricsTotal       |N        |1          |Integer|                                                             |
3814 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3815 |papMetrics         |N        |1          |Integer|                                                             |
3816 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3817 |pdpMetrics         |N        |1          |Integer|                                                             |
3818 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3819 |responseCode       |N        |1          |Object |                                                             |
3820 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3821 |responseMessage    |N        |1          |String |                                                             |
3822 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3823
3824 List Configuration
3825 ++++++++++++++++++
3826
3827 +--------------------+--------------------------+
3828 |Interface Definition|Description               |
3829 +====================+==========================+
3830 |URI                 |/listConfiguration        |
3831 +--------------------+--------------------------+
3832 |Operation Type      |POST                      |
3833 +--------------------+--------------------------+
3834
3835 Request Headers:
3836
3837 +-------------------+---------+-----------------------------------------------------------------------------------------+
3838 |Header Name        |Qualifier|Description                                                                              |
3839 +===================+=========+=========================================================================================+
3840 |ClientAuth         |Y        |encoded client authentication details                                                    |
3841 +-------------------+---------+-----------------------------------------------------------------------------------------+
3842 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3843 +-------------------+---------+-----------------------------------------------------------------------------------------+
3844 |Environment        |Y        |execution environments                                                                   |
3845 +-------------------+---------+-----------------------------------------------------------------------------------------+
3846 |Authorization      |Y        |Base64 encoded username:password                                                         |
3847 +-------------------+---------+-----------------------------------------------------------------------------------------+
3848
3849 Request Parameters:
3850
3851 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3852 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3853 +===================+=========+===========+=======+=============================================================+
3854 |configAttributes   |N        |1          |Object |                                                             |
3855 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3856 |configName         |N        |1          |String |                                                             |
3857 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3858 |ecompName          |N        |1          |String |                                                             |
3859 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3860 |policyName         |N        |1          |String |                                                             |
3861 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3862 |requestID          |N        |1          |String |                                                             |
3863 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3864 |unique             |N        |1          |Boolean|                                                             |
3865 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3866
3867 HTTP Response Code:
3868
3869 +------------------+---------------------+
3870 |HTTP CODE         |Description          |
3871 +==================+=====================+
3872 |200               |successful           |
3873 +------------------+---------------------+
3874 |400               |Invalid Request      |
3875 +------------------+---------------------+
3876 |401               |Unauthorized         |
3877 +------------------+---------------------+
3878 |500               |Error                |
3879 +------------------+---------------------+
3880
3881 Import policy
3882 +++++++++++++
3883
3884 +--------------------+--------------------------+
3885 |Interface Definition|Description               |
3886 +====================+==========================+
3887 |URI                 |/policyEngineImport       |
3888 +--------------------+--------------------------+
3889 |Operation Type      |POST                      |
3890 +--------------------+--------------------------+
3891
3892 Request Headers:
3893
3894 +-------------------+---------+-----------------------------------------------------------------------------------------+
3895 |Header Name        |Qualifier|Description                                                                              |
3896 +===================+=========+=========================================================================================+
3897 |ClientAuth         |Y        |encoded client authentication details                                                    |
3898 +-------------------+---------+-----------------------------------------------------------------------------------------+
3899 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3900 +-------------------+---------+-----------------------------------------------------------------------------------------+
3901 |Environment        |Y        |execution environments                                                                   |
3902 +-------------------+---------+-----------------------------------------------------------------------------------------+
3903 |Authorization      |Y        |Base64 encoded username:password                                                         |
3904 +-------------------+---------+-----------------------------------------------------------------------------------------+
3905
3906 Request Parameters:
3907
3908 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3909 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3910 +===================+=========+===========+=======+=============================================================+
3911 |importParameterJson|Y        |1          |String |                                                             |
3912 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3913 |file               |Y        |1          |File   |                                                             |
3914 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3915
3916 HTTP Response Code:
3917
3918 +------------------+---------------------+
3919 |HTTP CODE         |Description          |
3920 +==================+=====================+
3921 |200               |successful           |
3922 +------------------+---------------------+
3923 |400               |Invalid Request      |
3924 +------------------+---------------------+
3925 |401               |Unauthorized         |
3926 +------------------+---------------------+
3927 |500               |Error                |
3928 +------------------+---------------------+
3929
3930 Push Policy
3931 +++++++++++
3932
3933 +--------------------+--------------------------+
3934 |Interface Definition|Description               |
3935 +====================+==========================+
3936 |URI                 |/pushPolicy               |
3937 +--------------------+--------------------------+
3938 |Operation Type      |PUT                       |
3939 +--------------------+--------------------------+
3940
3941 Request Headers:
3942
3943 +-------------------+---------+-----------------------------------------------------------------------------------------+
3944 |Header Name        |Qualifier|Description                                                                              |
3945 +===================+=========+=========================================================================================+
3946 |ClientAuth         |Y        |encoded client authentication details                                                    |
3947 +-------------------+---------+-----------------------------------------------------------------------------------------+
3948 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3949 +-------------------+---------+-----------------------------------------------------------------------------------------+
3950 |Environment        |Y        |execution environments                                                                   |
3951 +-------------------+---------+-----------------------------------------------------------------------------------------+
3952 |Authorization      |Y        |Base64 encoded username:password                                                         |
3953 +-------------------+---------+-----------------------------------------------------------------------------------------+
3954
3955 Request Parameters:
3956
3957 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3958 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3959 +===================+=========+===========+=======+=============================================================+
3960 |pdpGroup           |N        |1          |String |                                                             |
3961 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3962 |policyName         |N        |1          |String |                                                             |
3963 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3964 |policyType         |N        |1          |String |                                                             |
3965 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3966
3967 HTTP Response Code:
3968
3969 +------------------+---------------------+
3970 |HTTP CODE         |Description          |
3971 +==================+=====================+
3972 |200               |successful           |
3973 +------------------+---------------------+
3974 |400               |Invalid Request      |
3975 +------------------+---------------------+
3976 |401               |Unauthorized         |
3977 +------------------+---------------------+
3978 |500               |Error                |
3979 +------------------+---------------------+
3980
3981 Send Event
3982 ++++++++++
3983
3984 +--------------------+--------------------------+
3985 |Interface Definition|Description               |
3986 +====================+==========================+
3987 |URI                 |/sendEvent                |
3988 +--------------------+--------------------------+
3989 |Operation Type      |POST                      |
3990 +--------------------+--------------------------+
3991
3992 Request Headers:
3993
3994 +-------------------+---------+-----------------------------------------------------------------------------------------+
3995 |Header Name        |Qualifier|Description                                                                              |
3996 +===================+=========+=========================================================================================+
3997 |ClientAuth         |Y        |encoded client authentication details                                                    |
3998 +-------------------+---------+-----------------------------------------------------------------------------------------+
3999 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4000 +-------------------+---------+-----------------------------------------------------------------------------------------+
4001 |Environment        |Y        |execution environments                                                                   |
4002 +-------------------+---------+-----------------------------------------------------------------------------------------+
4003 |Authorization      |Y        |Base64 encoded username:password                                                         |
4004 +-------------------+---------+-----------------------------------------------------------------------------------------+
4005
4006 Request Parameters:
4007
4008 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4009 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4010 +===================+=========+===========+=======+=============================================================+
4011 |eventAttributes    |N        |1          |Object |                                                             |
4012 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4013 |requestID          |N        |1          |String |                                                             |
4014 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4015
4016 HTTP Response Code:
4017
4018 +------------------+---------------------+
4019 |HTTP CODE         |Description          |
4020 +==================+=====================+
4021 |200               |successful           |
4022 +------------------+---------------------+
4023 |400               |Invalid Request      |
4024 +------------------+---------------------+
4025 |401               |Unauthorized         |
4026 +------------------+---------------------+
4027 |500               |Error                |
4028 +------------------+---------------------+
4029
4030 Send Heartbeat
4031 ++++++++++++++
4032
4033 +--------------------+--------------------------+
4034 |Interface Definition|Description               |
4035 +====================+==========================+
4036 |URI                 |/sendEvent                |
4037 +--------------------+--------------------------+
4038 |Operation Type      |POST                      |
4039 +--------------------+--------------------------+
4040
4041 Request Headers:
4042
4043 +-------------------+---------+-----------------------------------------------------------------------------------------+
4044 |Header Name        |Qualifier|Description                                                                              |
4045 +===================+=========+=========================================================================================+
4046 |ClientAuth         |Y        |encoded client authentication details                                                    |
4047 +-------------------+---------+-----------------------------------------------------------------------------------------+
4048 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4049 +-------------------+---------+-----------------------------------------------------------------------------------------+
4050 |Environment        |Y        |execution environments                                                                   |
4051 +-------------------+---------+-----------------------------------------------------------------------------------------+
4052 |Authorization      |Y        |Base64 encoded username:password                                                         |
4053 +-------------------+---------+-----------------------------------------------------------------------------------------+
4054
4055 Request Parameters:
4056
4057 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4058 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4059 +===================+=========+===========+=======+=============================================================+
4060 |notificationTopic  |Y        |1          |String |                                                             |
4061 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4062
4063 HTTP Response Code:
4064
4065 +------------------+---------------------+
4066 |HTTP CODE         |Description          |
4067 +==================+=====================+
4068 |200               |successful           |
4069 +------------------+---------------------+
4070 |400               |Invalid Request      |
4071 +------------------+---------------------+
4072 |401               |Unauthorized         |
4073 +------------------+---------------------+
4074 |500               |Error                |
4075 +------------------+---------------------+
4076
4077 Stop Notification
4078 +++++++++++++++++
4079
4080 +--------------------+--------------------------+
4081 |Interface Definition|Description               |
4082 +====================+==========================+
4083 |URI                 |/stopNotification         |
4084 +--------------------+--------------------------+
4085 |Operation Type      |POST                      |
4086 +--------------------+--------------------------+
4087
4088 Request Headers:
4089
4090 +-------------------+---------+-----------------------------------------------------------------------------------------+
4091 |Header Name        |Qualifier|Description                                                                              |
4092 +===================+=========+=========================================================================================+
4093 |ClientAuth         |Y        |encoded client authentication details                                                    |
4094 +-------------------+---------+-----------------------------------------------------------------------------------------+
4095 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4096 +-------------------+---------+-----------------------------------------------------------------------------------------+
4097 |Environment        |Y        |execution environments                                                                   |
4098 +-------------------+---------+-----------------------------------------------------------------------------------------+
4099 |Authorization      |Y        |Base64 encoded username:password                                                         |
4100 +-------------------+---------+-----------------------------------------------------------------------------------------+
4101
4102 Request Parameters:
4103
4104 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4105 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4106 +===================+=========+===========+=======+=============================================================+
4107 |notificationTopic  |Y        |1          |String |                                                             |
4108 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4109
4110 HTTP Response Code:
4111
4112 +------------------+---------------------+
4113 |HTTP CODE         |Description          |
4114 +==================+=====================+
4115 |200               |successful           |
4116 +------------------+---------------------+
4117 |400               |Invalid Request      |
4118 +------------------+---------------------+
4119 |401               |Unauthorized         |
4120 +------------------+---------------------+
4121 |500               |Error                |
4122 +------------------+---------------------+
4123
4124 Update Dictionary
4125 +++++++++++++++++
4126
4127 +--------------------+--------------------------+
4128 |Interface Definition|Description               |
4129 +====================+==========================+
4130 |URI                 |/updateDictionaryItem     |
4131 +--------------------+--------------------------+
4132 |Operation Type      |PUT                       |
4133 +--------------------+--------------------------+
4134
4135 Request Headers:
4136
4137 +-------------------+---------+-----------------------------------------------------------------------------------------+
4138 |Header Name        |Qualifier|Description                                                                              |
4139 +===================+=========+=========================================================================================+
4140 |ClientAuth         |Y        |encoded client authentication details                                                    |
4141 +-------------------+---------+-----------------------------------------------------------------------------------------+
4142 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4143 +-------------------+---------+-----------------------------------------------------------------------------------------+
4144 |Environment        |Y        |execution environments                                                                   |
4145 +-------------------+---------+-----------------------------------------------------------------------------------------+
4146 |Authorization      |Y        |Base64 encoded username:password                                                         |
4147 +-------------------+---------+-----------------------------------------------------------------------------------------+
4148
4149 Request Parameters:
4150
4151 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4152 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4153 +===================+=========+===========+=======+=============================================================+
4154 |dictionary         |N        |1          |String |                                                             |
4155 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4156 |dictionaryJson     |N        |1          |String |                                                             |
4157 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4158 |dictionaryType     |N        |1          |String |                                                             |
4159 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4160 |requestID          |N        |1          |String |                                                             |
4161 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4162
4163 HTTP Response Code:
4164
4165 +------------------+---------------------+
4166 |HTTP CODE         |Description          |
4167 +==================+=====================+
4168 |200               |successful           |
4169 +------------------+---------------------+
4170 |400               |Invalid Request      |
4171 +------------------+---------------------+
4172 |401               |Unauthorized         |
4173 +------------------+---------------------+
4174 |500               |Error                |
4175 +------------------+---------------------+
4176
4177 Update Policy
4178 +++++++++++++
4179
4180 +--------------------+--------------------------+
4181 |Interface Definition|Description               |
4182 +====================+==========================+
4183 |URI                 |/updatePolicy             |
4184 +--------------------+--------------------------+
4185 |Operation Type      |PUT                       |
4186 +--------------------+--------------------------+
4187
4188 Request Headers:
4189
4190 +-------------------+---------+-----------------------------------------------------------------------------------------+
4191 |Header Name        |Qualifier|Description                                                                              |
4192 +===================+=========+=========================================================================================+
4193 |ClientAuth         |Y        |encoded client authentication details                                                    |
4194 +-------------------+---------+-----------------------------------------------------------------------------------------+
4195 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4196 +-------------------+---------+-----------------------------------------------------------------------------------------+
4197 |Environment        |Y        |execution environments                                                                   |
4198 +-------------------+---------+-----------------------------------------------------------------------------------------+
4199 |Authorization      |Y        |Base64 encoded username:password                                                         |
4200 +-------------------+---------+-----------------------------------------------------------------------------------------+
4201
4202 Request Parameters:
4203
4204 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4205 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4206 +===================+=========+===========+=======+=============================================================+
4207 |attributes         |N        |1          |Object |                                                             |
4208 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4209 |configBody         |N        |1          |String |                                                             |
4210 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4211 |configBodyType     |N        |1          |String |                                                             |
4212 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4213 |configName         |N        |1          |String |                                                             |
4214 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4215 |ecompName          |N        |1          |String |                                                             |
4216 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4217 |policyClass        |N        |1          |String |                                                             |
4218 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4219 |policyConfigType   |N        |1          |String |                                                             |
4220 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4221 |policyDescription  |N        |1          |String |                                                             |
4222 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4223 |policyName         |N        |1          |String |                                                             |
4224 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4225 |requestID          |N        |1          |String |                                                             |
4226 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4227
4228 HTTP Response Code:
4229
4230 +------------------+---------------------+
4231 |HTTP CODE         |Description          |
4232 +==================+=====================+
4233 |200               |successful           |
4234 +------------------+---------------------+
4235 |400               |Invalid Request      |
4236 +------------------+---------------------+
4237 |401               |Unauthorized         |
4238 +------------------+---------------------+
4239 |500               |Error                |
4240 +------------------+---------------------+