docs/MultiCloud-API-Specification-V1.rst

   1 ..
   2  This work is licensed under a Creative Commons Attribution 4.0
   3  International License.
   4
   5 ================================
   6 MultiCloud API Specification V1
   7 ================================
   8
   9 API Catalog
  10 ===========
  11
  12 `1. Scope`_
  13
  14 `2. Terms, Definitions and Abbreviations`_
  15
  16 `3. Image Management`_
  17
  18 `3.1. Create Image`_
  19
  20 `3.1.1. Request`_
  21
  22 `3.1.2. Response`_
  23
  24 `3.2. Delete Image`_
  25
  26 `3.2.1. Request`_
  27
  28 `3.2.2. Response`_
  29
  30 `3.3. List Images`_
  31
  32 `3.3.1. Request`_
  33
  34 `3.3.2. Response`_
  35
  36 `3.4. Get Image`_
  37
  38 `3.4.1. Request`_
  39
  40 `3.4.2. Response`_
  41
  42 `4. Network Management`_
  43
  44 `4.1. Create Network`_
  45
  46 `4.1.1. Request`_
  47
  48 `4.1.2. Response`_
  49
  50 `4.2. Delete Network`_
  51
  52 `4.2.1. Request`_
  53
  54 `4.2.2. Response`_
  55
  56 `4.3. List Network`_
  57
  58 `4.3.1. Query`_
  59
  60 `4.3.2. Response`_
  61
  62 `4.4. Get Network`_
  63
  64 `4.4.1. Request`_
  65
  66 `4.4.2. Response`_
  67
  68 `5. Subnetwork Management`_
  69
  70 `5.1. Create Subnets`_
  71
  72 `5.1.1. Request`_
  73
  74 `5.1.2. Response`_
  75
  76 `5.2. Delete Subnets`_
  77
  78 `5.2.1. Request`_
  79
  80 `5.2.2. Response`_
  81
  82 `5.3. List Subnets`_
  83
  84 `5.3.1. Query`_
  85
  86 `5.3.2. Response`_
  87
  88 `5.4. Get Subnets`_
  89
  90 `5.4.1. Request`_
  91
  92 `5.4.2. Response`_
  93
  94 `6. Virtual Port`_
  95
  96 `6.1. Create Virtual Port`_
  97
  98 `6.1.1. Request`_
  99
 100 `6.1.2. Response`_
 101
 102 `6.2. Delete Virtual Port`_
 103
 104 `6.2.1. Request`_
 105
 106 `6.2.2. Response`_
 107
 108 `6.3. List Virtual Port`_
 109
 110 `6.3.1. Query`_
 111
 112 `6.3.2. Response`_
 113
 114 `6.4. Get Virtual Port`_
 115
 116 `6.4.1. Request`_
 117
 118 `6.4.2. Response`_
 119
 120 `7. Server Management`_
 121
 122 `7.1. Create Server`_
 123
 124 `7.1.1. Request`_
 125
 126 `7.1.2. Response`_
 127
 128 `7.2. Delete Server`_
 129
 130 `7.2.1. Request`_
 131
 132 `7.2.2. Response`_
 133
 134 `7.3. List Server`_
 135
 136 `7.3.1. Request`_
 137
 138 `7.3.2. Response`_
 139
 140 `7.4. Get Server`_
 141
 142 `7.4.1. Request`_
 143
 144 `7.4.2. Response`_
 145
 146 `8. Flavor Management`_
 147
 148 `8.1. Create Flavor`_
 149
 150 `8.1.1. Request`_
 151
 152 `8.1.2. Response`_
 153
 154 `8.2. Delete Flavor`_
 155
 156 `8.2.1. Request`_
 157
 158 `8.2.2. Response`_
 159
 160 `8.3. List Flavor`_
 161
 162 `8.3.1. Query`_
 163
 164 `8.3.2. Response`_
 165
 166 `8.4. Get Flavor`_
 167
 168 `8.4.1. Request`_
 169
 170 `8.4.2. Response`_
 171
 172 `9. Volume Management`_
 173
 174 `9.1. Create Volume`_
 175
 176 `9.1.1. Request`_
 177
 178 `9.1.2. Response`_
 179
 180 `9.2. Delete Volume`_
 181
 182 `9.2.1. Request`_
 183
 184 `9.2.2. Response`_
 185
 186 `9.3. List Volumes`_
 187
 188 `9.3.1. Request`_
 189
 190 `9.3.2. Response`_
 191
 192 `9.4. Get Volumes`_
 193
 194 `9.4.1. Request`_
 195
 196 `9.4.2. Response`_
 197
 198 `10. Tenant Management`_
 199
 200 `10.1. List tenants`_
 201
 202 `10.1.1. Query`_
 203
 204 `10.1.2. Response`_
 205
 206 `11. Limits`_
 207
 208 `11.1. List Limits of resouces`_
 209
 210 `11.1.1. Request`_
 211
 212 `11.1.2. Response`_
 213
 214 `12. Host Management`_
 215
 216 `12.1. List hosts`_
 217
 218 `12.1.1. Request`_
 219
 220 `12.1.2. Response`_
 221
 222 `12.2. Get host`_
 223
 224 `12.2.1. Request`_
 225
 226 `12.2.2. Response`_
 227
 228 `13. VIM Management`_
 229
 230 `13.1. Update VIM Info`_
 231
 232 `13.1.1. Request`_
 233
 234 `13.1.2. Response`_
 235
 236 `13.2. Unregistry VIM`_
 237
 238 `13.2.1. Request`_
 239
 240 `13.2.2. Response`_
 241
 242
 243 1. **Scope**
 244 ^^^^^^^^^^^^
 245
 246 The scope of the present document is to describe the VIM Driver API
 247 specification.
 248
 249 2. **Terms, Definitions and Abbreviations**
 250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 251
 252 For the purposes of the present document, the following abbreviations
 253 apply:
 254
 255 +--------------------+-------------------------------------------------------------+
 256 | **Abbreviation**   |                                                             |
 257 +====================+=============================================================+
 258 | NFVO               | Network Functions Virtualization Orchestrator               |
 259 +--------------------+-------------------------------------------------------------+
 260 | VNFM               | Virtual Network Function Management                         |
 261 +--------------------+-------------------------------------------------------------+
 262 | VIM                | Virtualized Infrastructure Manager                          |
 263 +--------------------+-------------------------------------------------------------+
 264 | MultiVIM           | MultVIM driver services for OPEN-O to drive VIM instances   |
 265 +--------------------+-------------------------------------------------------------+
 266
 267 3. **Image Management**
 268 ^^^^^^^^^^^^^^^^^^^^^^^
 269
 270 3.1. **Create Image**
 271 ---------------------
 272
 273 +---------------------+-------------------------------------------------------------------------------+
 274 | **IF Definition**   | **Description**                                                               |
 275 +=====================+===============================================================================+
 276 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images    |
 277 +---------------------+-------------------------------------------------------------------------------+
 278 | Operation           | POST                                                                          |
 279 +---------------------+-------------------------------------------------------------------------------+
 280 | Direction           | NSLCM->MULTIVIM                                                               |
 281 +---------------------+-------------------------------------------------------------------------------+
 282 | Description         | Create Image and Upload the image file to the VIM                             |
 283 +---------------------+-------------------------------------------------------------------------------+
 284
 285 3.1.1. **Request**
 286 >>>>>>>>>>>>>>>>>>
 287
 288 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 289 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                  |
 290 +===================+=================+===================+===========================+==================================================================================================+
 291 | name              | M               | 1                 | String                    | Image Name                                                                                       |
 292 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 293 | imagePath         | M               | 1                 | String                    | Image Local Path from catalog                                                                    |
 294 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 295 | imageType         | M               | 1                 | String                    | Image Type                                                                                       |
 296 |                   |                 |                   |                           |                                                                                                  |
 297 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso                                             |
 298 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 299 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                                                           |
 300 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 301 | visibility        | O               | 1                 | string                    | Visibility for this image.                                                                       |
 302 |                   |                 |                   |                           |                                                                                                  |
 303 |                   |                 |                   |                           | public, private, shared, or community                                                            |
 304 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 305 | properties        | O               | 0..N              | List of key-value pairs   | Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic"     |
 306 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 307
 308 ::
 309
 310     {
 311
 312     "imageName": "cirros",
 313
 314     "imagePath": "/home/cirros.qcow2",
 315
 316     "imageType": "qcow2"
 317
 318     "containerFormat":"bare"
 319
 320     }
 321
 322 3.1.2. **Response**
 323 >>>>>>>>>>>>>>>>>>>
 324
 325 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 326 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                        |
 327 +===================+=================+===================+===========================+========================================================+
 328 | id                | M               | 1                 | String                    | Image UUID in the VIM                                  |
 329 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 330 | name              | M               | 1                 | String                    | Image Name                                             |
 331 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 332 | returnCode        | M               | 1                 | Int                       | 0: Already exist 1: Newly created                      |
 333 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 334 | imageType         | M               | 1                 | String                    | Image Type                                             |
 335 |                   |                 |                   |                           |                                                        |
 336 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 337 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 338 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                 |
 339 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 340 | visibility        | O               | 1                 | string                    | Visibility for this image.                             |
 341 |                   |                 |                   |                           |                                                        |
 342 |                   |                 |                   |                           | public, private, shared, or community                  |
 343 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 344 | properties        | O               | 0..N              | List of key-value pairs   |                                                        |
 345 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 346 | vimid             | M               | 1                 | String                    | vim id                                                 |
 347 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 348 | vimName           | O               | 1                 | string                    | vim name                                               |
 349 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 350 | tenantId          | M               | 1                 | String                    | Tenant UUID                                            |
 351 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 352
 353 *202*: accepted
 354
 355 500: failed
 356
 357 ::
 358
 359     {
 360         "id": "3c9eebdbbfd345658269340b9ea6fb73",
 361         "name": "cirros",
 362         "returnCode": 1
 363     }
 364
 365 3.2. **Delete Image**
 366 ---------------------
 367
 368 +---------------------+-----------------------------------------------------------------------------------------+
 369 | **IF Definition**   | **Description**                                                                         |
 370 +=====================+=========================================================================================+
 371 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images/{imageId}    |
 372 +---------------------+-----------------------------------------------------------------------------------------+
 373 | Operation           | Delete                                                                                  |
 374 +---------------------+-----------------------------------------------------------------------------------------+
 375 | Direction           | NSLCM->MULTIVIM                                                                         |
 376 +---------------------+-----------------------------------------------------------------------------------------+
 377 | Description         | Delete Image                                                                            |
 378 +---------------------+-----------------------------------------------------------------------------------------+
 379
 380 3.2.1. **Request**
 381 >>>>>>>>>>>>>>>>>>
 382
 383 N/A
 384
 385 3.2.2. **Response**
 386 >>>>>>>>>>>>>>>>>>>
 387
 388 204: no content
 389
 390 3.3. **List Images**
 391 --------------------
 392
 393 +---------------------+-------------------------------------------------------------------------------+
 394 | **IF Definition**   | **Description**                                                               |
 395 +=====================+===============================================================================+
 396 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud_owner}\_{region}/{tenantid}/images   |
 397 +---------------------+-------------------------------------------------------------------------------+
 398 | Operation           | GET                                                                           |
 399 +---------------------+-------------------------------------------------------------------------------+
 400 | Direction           | NSLCM->MULTIVIM                                                               |
 401 +---------------------+-------------------------------------------------------------------------------+
 402 | Description         | Query Image list                                                              |
 403 +---------------------+-------------------------------------------------------------------------------+
 404
 405 3.3.1. **Request**
 406 >>>>>>>>>>>>>>>>>>
 407
 408 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 409 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                  |
 410 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
 411 | limit           | O               | 1                 | integer       | Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.   |
 412 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 413 | marker          | O               | 1                 | string        | The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.                                                   |
 414 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 415 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of an image                                                                                                                                                                               |
 416 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 417
 418 3.3.2. **Response**
 419 >>>>>>>>>>>>>>>>>>>
 420
 421 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 422 | \ **Parameter**                                 | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 423 +=================================================+=================+===================+===============+========================================================+
 424 | images                                          | M               | 0..N              | List          | Image List                                             |
 425 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 426 | id                                              | M               | 1                 | String        | Image ID                                               |
 427 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 428 | size                                            | M               | 1                 | int           | Image Size                                             |
 429 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 430 | name                                            | M               | 1                 | String        | Image Name                                             |
 431 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 432 | status                                          | M               | 1                 | String        | Image Status                                           |
 433 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 434 | imageType                                       | M               | 1                 | String        | Image Type                                             |
 435 |                                                 |                 |                   |               |                                                        |
 436 |                                                 |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 437 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 438 | containerFormat                                 | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 439 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 440 | visibility                                      | O               | 1                 | string        | Visibility for this image.                             |
 441 |                                                 |                 |                   |               |                                                        |
 442 |                                                 |                 |                   |               | public, private, shared, or community                  |
 443 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 444 | vimId                                           | M               | 1                 | String        | vim id                                                 |
 445 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 446 | vimName                                         | O               | 1                 | string        | vim name                                               |
 447 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 448 | tenantId                                        | M               | 1                 | String        | Tenant UUID                                            |
 449 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 450
 451 200: ok
 452
 453 500: failed
 454
 455 ::
 456
 457     {
 458         "vimid": "",
 459         "vimname": "",
 460         "imageList": [{
 461             "status": "active",
 462             "id": "5e2757c1-f846-4727-915c-9a872553ed75",
 463             "size": 862016,
 464             "name": "vim-plus-cgsl40g-z.qcow2"
 465         }]
 466     }
 467
 468
 469 3.4. **Get Image**
 470 ------------------
 471
 472 +---------------------+-----------------------------------------------------------------------------------------+
 473 | **IF Definition**   | **Description**                                                                         |
 474 +=====================+=========================================================================================+
 475 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid}   |
 476 +---------------------+-----------------------------------------------------------------------------------------+
 477 | Operation           | GET                                                                                     |
 478 +---------------------+-----------------------------------------------------------------------------------------+
 479 | Direction           | NSLCM->MULTIVIM                                                                         |
 480 +---------------------+-----------------------------------------------------------------------------------------+
 481 | Description         | Query Image Information                                                                 |
 482 +---------------------+-----------------------------------------------------------------------------------------+
 483
 484 3.4.1. **Request**
 485 >>>>>>>>>>>>>>>>>>
 486
 487 N/A
 488
 489 3.4.2. **Response**
 490 >>>>>>>>>>>>>>>>>>>
 491
 492 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 493 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 494 +===================+=================+===================+===============+========================================================+
 495 | id                | M               | 1                 | String        | Image ID                                               |
 496 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 497 | size              | M               | 1                 | int           | Image Size                                             |
 498 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 499 | name              | M               | 1                 | String        | Image Name                                             |
 500 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 501 | status            | M               | 1                 | String        | Image Status                                           |
 502 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 503 | imageType         | M               | 1                 | String        | Image Type                                             |
 504 |                   |                 |                   |               |                                                        |
 505 |                   |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 506 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 507 | containerFormat   | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 508 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 509 | visibility        | O               | 1                 | string        | Visibility for this image.                             |
 510 |                   |                 |                   |               |                                                        |
 511 |                   |                 |                   |               | public, private, shared, or community                  |
 512 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 513 | vimId             | M               | 1                 | String        | vim id                                                 |
 514 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 515 | vimName           | M               | 1                 | string        | vim name                                               |
 516 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 517 | tenantId          | M               | 1                 | String        | Tenant UUID                                            |
 518 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 519
 520 200: ok
 521
 522 500: failed
 523
 524 ::
 525
 526     {
 527         "vimid": "",
 528         "vimname": "",
 529         "status": "active",
 530         "id": "5e2757c1-f846-4727-915c-9a872553ed75",
 531         "size": 862016,
 532         "name": "vim-plus-cgsl40g-z.qcow2"
 533     }
 534
 535 4. **Network Management**
 536 ^^^^^^^^^^^^^^^^^^^^^^^^^
 537
 538 4.1. **Create Network**
 539 -----------------------
 540
 541 +---------------------+---------------------------------------------------------------------------------+
 542 | **IF Definition**   | **Description**                                                                 |
 543 +=====================+=================================================================================+
 544 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 545 +---------------------+---------------------------------------------------------------------------------+
 546 | Operation           | POST                                                                            |
 547 +---------------------+---------------------------------------------------------------------------------+
 548 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                          |
 549 +---------------------+---------------------------------------------------------------------------------+
 550 | Description         | Create network and subnetwork on the VIM                                        |
 551 +---------------------+---------------------------------------------------------------------------------+
 552
 553 4.1.1. **Request**
 554 >>>>>>>>>>>>>>>>>>
 555
 556 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 557 | **Parameter**               | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 558 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 559 | name                        | M               | 1                 | String        | Logical network name                                                                                                                                                                                                                                                                      |
 560 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 561 | shared                      | M               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 562 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 563 | vlanTransparent             | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 564 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 565 | networkType                 | O               | 1                 | String        | Network type                                                                                                                                                                                                                                                                              |
 566 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 567 |                             |                 |                   |               | flat, vlan, vxlan, gre,                                                                                                                                                                                                                                                                   |
 568 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 569 |                             |                 |                   |               | portgroup                                                                                                                                                                                                                                                                                 |
 570 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 571 | segmentationId              | O               | 1                 | Int           | id of paragraph                                                                                                                                                                                                                                                                           |
 572 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 573 | physicalNetwork             | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
 574 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 575 | routerExternal              | O               | 1                 | boolean       |Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                      |
 576 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 577
 578 ::
 579
 580     {
 581         "tenant": "tenant1",
 582         "networkName": "ommnet",
 583         "shared": 1,
 584         "vlanTransparent": 1,
 585         "networkType": "vlan",
 586         "segmentationId": 202,
 587         "physicalNetwork": "ctrl",
 588         "routerExternal": 0
 589     }
 590
 591 4.1.2. **Response**
 592 >>>>>>>>>>>>>>>>>>>
 593
 594 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 595 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 596 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 597 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 598 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 599 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 600 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 601 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 602 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 603 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 604 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 605 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 606 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 607 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 608 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 609 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 610 | physicalNetwork   | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
 611 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 612 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 613 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 614 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 615 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 616 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 617 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 618 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 619 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 620 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 621 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 622 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 623 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 624
 625 202: accepted
 626
 627 500: failed
 628
 629 ::
 630
 631     {
 632         "returnCode": 0,
 633         "vimId": "11111",
 634         "vimName": "11111",
 635         "status": "ACTIVE",
 636         "id": "3c9eebdbbfd345658269340b9ea6fb73",
 637         "name": "net1",
 638         "tenant": "tenant1",
 639         "networkName": "ommnet",
 640         "shared": 1,
 641         "vlanTransparent": 1,
 642         "networkType": "vlan",
 643         "segmentationId": 202,
 644         "physicalNetwork": "ctrl",
 645         "routerExternal": 0
 646     }
 647
 648 4.2. **Delete Network**
 649 -----------------------
 650
 651 +---------------------+---------------------------------------------------------------------------------------------+
 652 | **IF Definition**   | **Description**                                                                             |
 653 +=====================+=============================================================================================+
 654 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 655 +---------------------+---------------------------------------------------------------------------------------------+
 656 | Operation           | Delete                                                                                      |
 657 +---------------------+---------------------------------------------------------------------------------------------+
 658 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 659 +---------------------+---------------------------------------------------------------------------------------------+
 660
 661 4.2.1. **Request**
 662 >>>>>>>>>>>>>>>>>>
 663
 664 N/A
 665
 666 4.2.2. **Response**
 667 >>>>>>>>>>>>>>>>>>>
 668
 669 204: no content
 670
 671 4.3. **List Network**
 672 ---------------------
 673
 674 +---------------------+---------------------------------------------------------------------------------+
 675 | **IF Definition**   | **Description**                                                                 |
 676 +=====================+=================================================================================+
 677 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 678 +---------------------+---------------------------------------------------------------------------------+
 679 | Operation           | get                                                                             |
 680 +---------------------+---------------------------------------------------------------------------------+
 681 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
 682 +---------------------+---------------------------------------------------------------------------------+
 683
 684 4.3.1. **Query**
 685 >>>>>>>>>>>>>>>>
 686
 687 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 688 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                       |
 689 +=================+=================+===================+===============+=======================================================================================+
 690 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of a network   |
 691 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 692
 693 4.3.2. **Response**
 694 >>>>>>>>>>>>>>>>>>>
 695
 696 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 697 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 698 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 699 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 700 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 701 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 702 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 703 | networks          |                 | 0..N              | List          | Network list                                                                                                                                                                                                                                                                              |
 704 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 705 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 706 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 707 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 708 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 709 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 710 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 711 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 712 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 713 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 714 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 715 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 716 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 717 | physicalNetwork   | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
 718 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 719 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 720 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 721 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 722 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 723 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 724 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 725
 726 200: ok
 727
 728 500: failed
 729
 730 ::
 731
 732     {
 733
 734         "vimId": "11111",
 735
 736         "vimName": "111",
 737
 738         "networks":
 739
 740             [{
 741
 742                 "status": "ACTIVE",
 743
 744                 "id": "3c9eebdbbfd345658269340b9ea6fb73",
 745
 746                 "name": "net1",
 747
 748                 "tenant": "tenant1",
 749
 750                 "networkName": "ommnet",
 751
 752                 "shared": 1,
 753
 754                 "vlanTransparent": 1,
 755
 756                 "networkType": "vlan",
 757
 758                 "segmentationId": 202,
 759
 760                 "physicalNetwork ": "ctrl",
 761
 762                 "routerExternal ": 0
 763
 764             }]
 765
 766     }
 767
 768 4.4. **Get Network**
 769 --------------------
 770
 771 +---------------------+---------------------------------------------------------------------------------------------+
 772 | **IF Definition**   | **Description**                                                                             |
 773 +=====================+=============================================================================================+
 774 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 775 +---------------------+---------------------------------------------------------------------------------------------+
 776 | Operation           | get                                                                                         |
 777 +---------------------+---------------------------------------------------------------------------------------------+
 778 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 779 +---------------------+---------------------------------------------------------------------------------------------+
 780
 781 4.4.1. **Request**
 782 >>>>>>>>>>>>>>>>>>
 783
 784 N/A
 785
 786 4.4.2. **Response**
 787 >>>>>>>>>>>>>>>>>>>
 788
 789 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 790 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 791 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 792 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 793 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 794 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 795 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 796 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 797 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 798 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 799 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 800 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 801 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 802 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 803 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 804 | physicalNetwork   | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
 805 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 806 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 807 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 808 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 809 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 810 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 811 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 812 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 813 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 814 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 815 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 816 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 817 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 818
 819 200: ok
 820
 821 500: failed
 822
 823 ::
 824
 825     {
 826
 827         "vimId":"11111",
 828
 829         "vimName":"11111",
 830
 831         "status": "ACTIVE",
 832
 833         "id": "3c9eebdbbfd345658269340b9ea6fb73",
 834
 835         "name": "net1",
 836
 837         "tenant": "tenant1",
 838
 839         "networkName": "ommnet",
 840
 841         "shared": 1,
 842
 843         "vlanTransparent": 1,
 844
 845         "networkType":"vlan",
 846
 847         "segmentationId":202,
 848
 849         "physicalNetwork ":"ctrl",
 850
 851         "routerExternal ":0
 852
 853     }
 854
 855 5. **Subnetwork Management**
 856 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 857
 858 5.1. **Create Subnets**
 859 -----------------------
 860
 861 +---------------------+--------------------------------------------------------------------------------+
 862 | **IF Definition**   | **Description**                                                                |
 863 +=====================+================================================================================+
 864 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
 865 +---------------------+--------------------------------------------------------------------------------+
 866 | Operation           | POST                                                                           |
 867 +---------------------+--------------------------------------------------------------------------------+
 868 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                         |
 869 +---------------------+--------------------------------------------------------------------------------+
 870 | Description         | Create network and subnetwork on the VIM                                       |
 871 +---------------------+--------------------------------------------------------------------------------+
 872
 873 5.1.1. **Request**
 874 >>>>>>>>>>>>>>>>>>
 875
 876 +-------------------+-----------------+-------------------+------------------------+----------------------+
 877 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
 878 +===================+=================+===================+========================+======================+
 879 | networkId         | M               | 1                 | String                 | Network Id           |
 880 +-------------------+-----------------+-------------------+------------------------+----------------------+
 881 | name              | M               | 1                 | String                 | SubnetName           |
 882 +-------------------+-----------------+-------------------+------------------------+----------------------+
 883 | cidr              | M               | 1                 | String                 | Subnet cidr          |
 884 +-------------------+-----------------+-------------------+------------------------+----------------------+
 885 | ipVersion         | M               | 1                 | Int                    | Ip type              |
 886 |                   |                 |                   |                        |                      |
 887 |                   |                 |                   |                        | 4,6                  |
 888 +-------------------+-----------------+-------------------+------------------------+----------------------+
 889 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
 890 |                   |                 |                   |                        |                      |
 891 |                   |                 |                   |                        | 1: yes;0: no         |
 892 +-------------------+-----------------+-------------------+------------------------+----------------------+
 893 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
 894 +-------------------+-----------------+-------------------+------------------------+----------------------+
 895 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
 896 +-------------------+-----------------+-------------------+------------------------+----------------------+
 897 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
 898 +-------------------+-----------------+-------------------+------------------------+----------------------+
 899 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
 900 +-------------------+-----------------+-------------------+------------------------+----------------------+
 901 | -->allocation     |                 |                   |                        |                      |
 902 +-------------------+-----------------+-------------------+------------------------+----------------------+
 903 | -->start          | O               | 1                 | String                 | Start ip             |
 904 +-------------------+-----------------+-------------------+------------------------+----------------------+
 905 | -->end            | O               | 1                 | String                 | End ip               |
 906 +-------------------+-----------------+-------------------+------------------------+----------------------+
 907
 908 ::
 909
 910     {
 911
 912         "tenant": "tenant1",
 913
 914         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
 915
 916         "subnetName": "subnet1",
 917
 918         "cidr": "10.43.35.0/24",
 919
 920         "ipVersion": 4,
 921
 922         "enableDhcp": 1,
 923
 924         "gatewayIp": "10.43.35.1",
 925
 926         "dnsNameservers": [],
 927
 928         "allocationPools": [{
 929
 930             "start": "192.168.199.2",
 931
 932             "end": "192.168.199.254"
 933
 934         }],
 935
 936         "hostRoutes": []
 937
 938     }
 939
 940 5.1.2. **Response**
 941 >>>>>>>>>>>>>>>>>>>
 942
 943 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 944 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**                     |
 945 +===================+=================+===================+========================+=====================================+
 946 | returnCode        | M               | 1                 | int                    | 0: Already exist 1: Newly created   |
 947 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 948 | vimId             | M               | 1                 | String                 | vim id                              |
 949 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 950 | vimName           | O               | 1                 | string                 | vim name                            |
 951 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 952 | status            | M               | 1                 | string                 | subnetwork status                   |
 953 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 954 | id                | M               | 1                 | string                 | subNetwork id                       |
 955 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 956 | tenantId          | M               | 1                 | String                 | Tenant UUID                         |
 957 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 958 | networkId         | O               | 1                 | String                 | Network Id                          |
 959 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 960 | networkName       | O               | 1                 | String                 | Network Name                        |
 961 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 962 | name              | M               | 1                 | String                 | SubnetName                          |
 963 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 964 | cidr              | M               | 1                 | String                 | Subnet cidr                         |
 965 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 966 | ipVersion         | M               | 1                 | Int                    | Ip type                             |
 967 |                   |                 |                   |                        |                                     |
 968 |                   |                 |                   |                        | 4,6                                 |
 969 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 970 | enableDhcp        | O               | 1                 | boolean                | Whether to allow                    |
 971 |                   |                 |                   |                        |                                     |
 972 |                   |                 |                   |                        | 1: yes;0: no                        |
 973 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 974 | gatewayIp         | O               | 1                 | String                 | Gateway ip                          |
 975 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 976 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers                     |
 977 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 978 | hostRoutes        | O               | 1..n              | List of routes         | List of routes                      |
 979 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 980 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation                  |
 981 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 982 | -->allocation     |                 |                   |                        |                                     |
 983 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 984 | -->start          | O               | 1                 | String                 | Start ip                            |
 985 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 986 | -->end            | O               | 1                 | String                 | End ip                              |
 987 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 988
 989 202: accepted
 990
 991 500: failed
 992
 993 ::
 994
 995     {
 996
 997         "returnCode": 0,
 998
 999         "vimId": "11111",
1000
1001         "vimName": "11111",
1002
1003         "status": " ACTIVE",
1004
1005         "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
1006
1007         "tenant": "tenant1",
1008
1009         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
1010
1011         "name": "subnet1",
1012
1013         "cidr": "10.43.35.0/24",
1014
1015         "ipVersion": 4,
1016
1017         "enableDhcp": 1,
1018
1019         "gatewayIp": "10.43.35.1",
1020
1021         "dnsNameservers": [],
1022
1023         "allocationPools": [{
1024
1025             "start": "192.168.199.2",
1026
1027             "end": "192.168.199.254"
1028
1029         }],
1030
1031         "hostRoutes": []
1032
1033     }
1034
1035 5.2. **Delete Subnets**
1036 -----------------------
1037
1038 +---------------------+-------------------------------------------------------------------------------------------+
1039 | **IF Definition**   | **Description**                                                                           |
1040 +=====================+===========================================================================================+
1041 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId}   |
1042 +---------------------+-------------------------------------------------------------------------------------------+
1043 | Operation           | Delete                                                                                    |
1044 +---------------------+-------------------------------------------------------------------------------------------+
1045 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1046 +---------------------+-------------------------------------------------------------------------------------------+
1047
1048 5.2.1. **Request**
1049 >>>>>>>>>>>>>>>>>>
1050
1051 N/A
1052
1053 5.2.2. **Response**
1054 >>>>>>>>>>>>>>>>>>>
1055
1056 204: no content
1057
1058 5.3. **List Subnets**
1059 ---------------------
1060
1061 +---------------------+--------------------------------------------------------------------------------+
1062 | **IF Definition**   | **Description**                                                                |
1063 +=====================+================================================================================+
1064 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
1065 +---------------------+--------------------------------------------------------------------------------+
1066 | Operation           | get                                                                            |
1067 +---------------------+--------------------------------------------------------------------------------+
1068 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1069 +---------------------+--------------------------------------------------------------------------------+
1070
1071 5.3.1. **Query**
1072 >>>>>>>>>>>>>>>>
1073
1074 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
1075
1076 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1077 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                |
1078 +=================+=================+===================+===============+================================================================================================+
1079 | name            | O               | 1                 | String        | Filters fields of the response by a name, as a string. A valid value is the name of a subnet   |
1080 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1081
1082 5.3.2. **Response**
1083 >>>>>>>>>>>>>>>>>>>
1084
1085 +-------------------+-----------------+-------------------+------------------------+----------------------+
1086 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1087 +===================+=================+===================+========================+======================+
1088 | vimId             | M               | 1                 | String                 | vim id               |
1089 +-------------------+-----------------+-------------------+------------------------+----------------------+
1090 | vimName           | O               | 1                 | string                 | vim name             |
1091 +-------------------+-----------------+-------------------+------------------------+----------------------+
1092 | subnets           | M               | 0..N              | List                   | Network list         |
1093 +-------------------+-----------------+-------------------+------------------------+----------------------+
1094 | status            |                 | 1                 | string                 | subnetwork status    |
1095 +-------------------+-----------------+-------------------+------------------------+----------------------+
1096 | id                |                 | 1                 | string                 | subNetwork id        |
1097 +-------------------+-----------------+-------------------+------------------------+----------------------+
1098 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1099 +-------------------+-----------------+-------------------+------------------------+----------------------+
1100 | networkId         | O               | 1                 | String                 | Network Id           |
1101 +-------------------+-----------------+-------------------+------------------------+----------------------+
1102 | networkName       | O               | 1                 | String                 | Network Name         |
1103 +-------------------+-----------------+-------------------+------------------------+----------------------+
1104 | name              | M               | 1                 | String                 | SubnetName           |
1105 +-------------------+-----------------+-------------------+------------------------+----------------------+
1106 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1107 +-------------------+-----------------+-------------------+------------------------+----------------------+
1108 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1109 |                   |                 |                   |                        |                      |
1110 |                   |                 |                   |                        | 4,6                  |
1111 +-------------------+-----------------+-------------------+------------------------+----------------------+
1112 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1113 |                   |                 |                   |                        |                      |
1114 |                   |                 |                   |                        | 1: yes;0: no         |
1115 +-------------------+-----------------+-------------------+------------------------+----------------------+
1116 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1117 +-------------------+-----------------+-------------------+------------------------+----------------------+
1118 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1119 +-------------------+-----------------+-------------------+------------------------+----------------------+
1120 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1121 +-------------------+-----------------+-------------------+------------------------+----------------------+
1122 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
1123 +-------------------+-----------------+-------------------+------------------------+----------------------+
1124 | -->allocation     |                 |                   |                        |                      |
1125 +-------------------+-----------------+-------------------+------------------------+----------------------+
1126 | -->start          | O               | 1                 | String                 | Start ip             |
1127 +-------------------+-----------------+-------------------+------------------------+----------------------+
1128 | -->end            | O               | 1                 | String                 | End ip               |
1129 +-------------------+-----------------+-------------------+------------------------+----------------------+
1130
1131 **200: ok**
1132
1133 **500: failed**
1134
1135 ::
1136
1137     {
1138
1139         "vimId": "11111",
1140
1141         "vimName": "11111",
1142
1143         "subnets": [
1144
1145             {
1146
1147                 "status": " ACTIVE",
1148
1149                 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
1150
1151                 "tenant": "tenant1",
1152
1153                 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
1154
1155                 "name": "subnet1",
1156
1157                 "cidr": "10.43.35.0/24",
1158
1159                 "ipVersion": 4,
1160
1161                 "enableDhcp": 1,
1162
1163                 "gatewayIp": "10.43.35.1",
1164
1165                 "dnsNameservers": [],
1166
1167                 "allocationPools": [{
1168
1169                     "start": "192.168.199.2",
1170
1171                     "end": "192.168.199.254"
1172
1173                 }],
1174
1175                 "hostRoutes": []
1176
1177             }
1178
1179         ]
1180
1181     }
1182
1183 5.4. **Get Subnets**
1184 --------------------
1185
1186 +---------------------+-------------------------------------------------------------------------------------------+
1187 | **IF Definition**   | **Description**                                                                           |
1188 +=====================+===========================================================================================+
1189 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid}   |
1190 +---------------------+-------------------------------------------------------------------------------------------+
1191 | Operation           | get                                                                                       |
1192 +---------------------+-------------------------------------------------------------------------------------------+
1193 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1194 +---------------------+-------------------------------------------------------------------------------------------+
1195
1196 5.4.1. **Request**
1197 >>>>>>>>>>>>>>>>>>
1198
1199 N/A
1200
1201 5.4.2. **Response**
1202 >>>>>>>>>>>>>>>>>>>
1203
1204 +-------------------+-----------------+-------------------+------------------------+----------------------+
1205 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1206 +===================+=================+===================+========================+======================+
1207 | vimId             | M               | 1                 | String                 | vim id               |
1208 +-------------------+-----------------+-------------------+------------------------+----------------------+
1209 | vimName           | O               | 1                 | string                 | vim name             |
1210 +-------------------+-----------------+-------------------+------------------------+----------------------+
1211 | status            |                 | 1                 | string                 | subnetwork status    |
1212 +-------------------+-----------------+-------------------+------------------------+----------------------+
1213 | id                |                 | 1                 | string                 | subNetwork id        |
1214 +-------------------+-----------------+-------------------+------------------------+----------------------+
1215 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1216 +-------------------+-----------------+-------------------+------------------------+----------------------+
1217 | networkId         | O               | 1                 | String                 | Network Id           |
1218 +-------------------+-----------------+-------------------+------------------------+----------------------+
1219 | networkName       | O               | 1                 | String                 | Network Name         |
1220 +-------------------+-----------------+-------------------+------------------------+----------------------+
1221 | name              | M               | 1                 | String                 | SubnetName           |
1222 +-------------------+-----------------+-------------------+------------------------+----------------------+
1223 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1224 +-------------------+-----------------+-------------------+------------------------+----------------------+
1225 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1226 |                   |                 |                   |                        |                      |
1227 |                   |                 |                   |                        | 4,6                  |
1228 +-------------------+-----------------+-------------------+------------------------+----------------------+
1229 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1230 |                   |                 |                   |                        |                      |
1231 |                   |                 |                   |                        | 1: yes;0: no         |
1232 +-------------------+-----------------+-------------------+------------------------+----------------------+
1233 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1234 +-------------------+-----------------+-------------------+------------------------+----------------------+
1235 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1236 +-------------------+-----------------+-------------------+------------------------+----------------------+
1237 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1238 +-------------------+-----------------+-------------------+------------------------+----------------------+
1239 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
1240 +-------------------+-----------------+-------------------+------------------------+----------------------+
1241 | -->allocation     |                 |                   |                        |                      |
1242 +-------------------+-----------------+-------------------+------------------------+----------------------+
1243 | -->start          | O               | 1                 | String                 | Start ip             |
1244 +-------------------+-----------------+-------------------+------------------------+----------------------+
1245 | -->end            | O               | 1                 | String                 | End ip               |
1246 +-------------------+-----------------+-------------------+------------------------+----------------------+
1247
1248 202: accepted
1249
1250 500: failed
1251
1252 ::
1253
1254     {
1255
1256         "status": " ACTIVE",
1257
1258         "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
1259
1260         "tenant": "tenant1",
1261
1262         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
1263
1264         "name": "subnet1",
1265
1266         "cidr": "10.43.35.0/24",
1267
1268         "ipVersion": 4,
1269
1270         "enableDhcp": 1,
1271
1272         "gatewayIp": "10.43.35.1",
1273
1274         "dnsNameservers": [],
1275
1276         "allocationPools": [{
1277
1278             "start": "192.168.199.2",
1279
1280             "end": "192.168.199.254"
1281
1282         }],
1283
1284         "hostRoutes": []
1285
1286     }
1287
1288 6. **Virtual Port**
1289 ^^^^^^^^^^^^^^^^^^^
1290
1291 6.1. **Create Virtual Port**
1292 ----------------------------
1293
1294 +---------------------+------------------------------------------------------------------------------+
1295 | **IF Definition**   | **Description**                                                              |
1296 +=====================+==============================================================================+
1297 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports   |
1298 +---------------------+------------------------------------------------------------------------------+
1299 | Operation           | POST                                                                         |
1300 +---------------------+------------------------------------------------------------------------------+
1301 | Direction           | VNFLCM->MULTIVIM                                                             |
1302 +---------------------+------------------------------------------------------------------------------+
1303
1304 6.1.1. **Request**
1305 >>>>>>>>>>>>>>>>>>
1306
1307 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1308 | **Parameter**          | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                       |
1309 +========================+=================+===================+===============+=======================================================+
1310 | networkId              | M               | 1                 | string        | Network UUID                                          |
1311 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1312 | subnetId               | O               | 1                 | string        | Subnet UUID                                           |
1313 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1314 | name                   | M               | 1                 | string        | Port name                                             |
1315 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1316 | macAddress             | O               | 1                 | string        | Mac address                                           |
1317 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1318 | ip                     | O               | 1                 | string        | Ip address                                            |
1319 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1320 | vnicType               | O               | 1                 | string        | Virtual network card type,                            |
1321 |                        |                 |                   |               |                                                       |
1322 |                        |                 |                   |               | the value of three kinds of normal/direct/macvtap     |
1323 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1324 | \ **securityGroups**   | **O**           | **1**             | **string**    | **The IDs of security groups applied to the port.**   |
1325 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1326
1327 6.1.2. **Response**
1328 >>>>>>>>>>>>>>>>>>>
1329
1330 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1331 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1332 +======================+=================+===================+===============+=====================================================+
1333 | returnCode           | M               | 1                 | int           | 0: Already exist 1: Newly created                   |
1334 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1335 | vimId                | M               | 1                 | String        | vim id                                              |
1336 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1337 | vimName              | O               | 1                 | string        | vim name                                            |
1338 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1339 | status               | M               | 1                 | string        | status                                              |
1340 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1341 | id                   | M               | 1                 | string        | Port Id                                             |
1342 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1343 | name                 | M               | 1                 | string        | Port name                                           |
1344 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1345 | tenantId             | M               | 1                 | String        | Tenant UUID                                         |
1346 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1347 | networkName          | M               | 1                 | string        | Network name                                        |
1348 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1349 | networkId            | M               | 1                 | string        | Network Id                                          |
1350 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1351 | subnetName           | M               | 1                 | string        | Subnet name                                         |
1352 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1353 | subnetId             | M               | 1                 | string        | SubnetId                                            |
1354 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1355 | macAddress           | O               | 1                 | string        | Mac address                                         |
1356 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1357 | ip                   | O               | 1                 | string        | Ip address                                          |
1358 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1359 | vnicType             | O               | 1                 | string        | Virtual network card type,                          |
1360 |                      |                 |                   |               |                                                     |
1361 |                      |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1362 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1363 | **securityGroups**   | **O**           | **1**             | **string**    | **List of security group names.**                   |
1364 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1365
1366 6.2. **Delete Virtual Port**
1367 ----------------------------
1368
1369 +---------------------+---------------------------------------------------------------------------------------+
1370 | **IF Definition**   | **Description**                                                                       |
1371 +=====================+=======================================================================================+
1372 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1373 +---------------------+---------------------------------------------------------------------------------------+
1374 | Operation           | DELETTE                                                                               |
1375 +---------------------+---------------------------------------------------------------------------------------+
1376 | Direction           | VNFLCM->MULTIVIM                                                                      |
1377 +---------------------+---------------------------------------------------------------------------------------+
1378
1379 6.2.1. **Request**
1380 >>>>>>>>>>>>>>>>>>
1381
1382 N/A
1383
1384 6.2.2. **Response**
1385 >>>>>>>>>>>>>>>>>>>
1386
1387 204: no content
1388
1389 6.3. **List Virtual Port**
1390 --------------------------
1391
1392 +---------------------+-----------------------------------------------------------------------------+
1393 | **IF Definition**   | **Description**                                                             |
1394 +=====================+=============================================================================+
1395 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports   |
1396 +---------------------+-----------------------------------------------------------------------------+
1397 | Operation           | GET                                                                         |
1398 +---------------------+-----------------------------------------------------------------------------+
1399 | Direction           | VNFLCM->MULTIVIM                                                            |
1400 +---------------------+-----------------------------------------------------------------------------+
1401
1402 6.3.1. **Query**
1403 >>>>>>>>>>>>>>>>
1404
1405 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1406 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                 |
1407 +=================+=================+===================+===============+=================================================+
1408 | name            | M               | 1                 | string        | Port name to filter out list of virtual ports   |
1409 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1410
1411 6.3.2. **Response**
1412 >>>>>>>>>>>>>>>>>>>
1413
1414 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1415 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1416 +===================+=================+===================+===============+=====================================================+
1417 | vimId             | M               | 1                 | String        | vim id                                              |
1418 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1419 | vimName           | O               | 1                 | string        | vim name                                            |
1420 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1421 | tenantId          | M               | 1                 | String        | Tenant UUID                                         |
1422 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1423 | Ports             | M               | 0..N              | List          | ports                                               |
1424 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1425 | id                | M               | 1                 | string        | Port Id                                             |
1426 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1427 | name              | M               | 1                 | string        | Port name                                           |
1428 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1429 | status            | M               | 1                 | string        | status                                              |
1430 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1431 | **networkName**   | O               | 1                 | string        | Network name                                        |
1432 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1433 | networkId         | M               | 1                 | string        | Network Id                                          |
1434 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1435 | subnetName        | O               | 1                 | string        | Subnet name                                         |
1436 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1437 | subnetId          | M               | 1                 | string        | SubnetId                                            |
1438 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1439 | macAddress        | O               | 1                 | string        | Mac address                                         |
1440 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1441 | ip                | O               | 1                 | string        | Ip address                                          |
1442 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1443 | vnicType          | O               | 1                 | string        | Virtual network card type,                          |
1444 |                   |                 |                   |               |                                                     |
1445 |                   |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1446 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1447 | securityGroups    | O               | 1                 | string        | List of security group names.                       |
1448 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1449
1450 **200: ok**
1451
1452 **500: failed**
1453
1454
1455 6.4. **Get Virtual Port**
1456 -------------------------
1457
1458 +---------------------+---------------------------------------------------------------------------------------+
1459 | **IF Definition**   | **Description**                                                                       |
1460 +=====================+=======================================================================================+
1461 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1462 +---------------------+---------------------------------------------------------------------------------------+
1463 | Operation           | GET                                                                                   |
1464 +---------------------+---------------------------------------------------------------------------------------+
1465 | Direction           | VNFLCM->MULTIVIM                                                                      |
1466 +---------------------+---------------------------------------------------------------------------------------+
1467
1468 6.4.1. **Request**
1469 >>>>>>>>>>>>>>>>>>
1470
1471 N/A
1472
1473 6.4.2. **Response**
1474 >>>>>>>>>>>>>>>>>>>
1475
1476 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1477 | **Parameter**    | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1478 +==================+=================+===================+===============+=====================================================+
1479 | vimId            | M               | 1                 | String        | vim id                                              |
1480 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1481 | vimName          | O               | 1                 | string        | vim name                                            |
1482 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1483 | status           | M               | 1                 | string        | status                                              |
1484 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1485 | id               | M               | 1                 | string        | Port Id                                             |
1486 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1487 | name             | M               | 1                 | string        | Port name                                           |
1488 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1489 | tenantId         | M               | 1                 | String        | Tenant UUID                                         |
1490 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1491 | networkName      | M               | 1                 | string        | Network name                                        |
1492 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1493 | networkId        | M               | 1                 | string        | Network Id                                          |
1494 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1495 | subnetName       | M               | 1                 | string        | Subnet name                                         |
1496 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1497 | subnetId         | M               | 1                 | string        | SubnetId                                            |
1498 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1499 | macAddress       | O               | 1                 | string        | Mac address                                         |
1500 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1501 | ip               | O               | 1                 | string        | Ip address                                          |
1502 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1503 | vnicType         | O               | 1                 | string        | Virtual network card type,                          |
1504 |                  |                 |                   |               |                                                     |
1505 |                  |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1506 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1507 | securityGroups   | O               | 1                 | string        | **List of security group names.**                   |
1508 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1509
1510 **200: ok**
1511
1512 **500: failed**
1513
1514
1515 7. **Server Management**
1516 ^^^^^^^^^^^^^^^^^^^^^^^^
1517
1518 7.1. **Create Server**
1519 ----------------------
1520
1521 +---------------------+--------------------------------------------------------------------------------+
1522 | **IF Definition**   | **Description**                                                                |
1523 +=====================+================================================================================+
1524 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1525 +---------------------+--------------------------------------------------------------------------------+
1526 | Operation           | POST                                                                           |
1527 +---------------------+--------------------------------------------------------------------------------+
1528 | Direction           | VNFLCM->MULTIVIM                                                               |
1529 +---------------------+--------------------------------------------------------------------------------+
1530
1531 7.1.1. **Request**
1532 >>>>>>>>>>>>>>>>>>
1533
1534 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1535 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1536 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1537 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1538 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1539 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1540 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1541 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1542 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1543 | contextArray         | O               | 1..n              | list of context                       | list of context                                                                                                                                                                        |
1544 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1545 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1546 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1547 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1548 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1549 | flavorId             | M               | 1                 | String                                | server Flavor id                                                                                                                                                                       |
1550 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1551 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1552 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1553 | userdata             | O               | 1                 | string                                | Configuration information or scripts to use upon launch. Must be Base64 encoded.                                                                                                       |
1554 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1555 |                      |                 |                   |                                       | NOTE: The ‘null’ value allowed in Nova legacy v2 API, but due to the strict input validation, it isn’t allowed in Nova v2.1 API.                                                       |
1556 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1557 | securityGroups       | O               | 1                 | List of names of security group       | One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.       |
1558 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1559 | serverGroup          | O               | 1                 | string                                | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1560 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1561
1562 **boot**
1563
1564 +-----------------+-----------------+-------------------+---------------+---------------------------+
1565 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**           |
1566 +=================+=================+===================+===============+===========================+
1567 | type            | M               | 1                 | int           | Startup mode              |
1568 |                 |                 |                   |               |                           |
1569 |                 |                 |                   |               | 1. boot from the volume   |
1570 |                 |                 |                   |               |                           |
1571 |                 |                 |                   |               | 2. boot from image        |
1572 +-----------------+-----------------+-------------------+---------------+---------------------------+
1573 | volumeId        | O               | 1                 | string        | Volume Id(type=1)         |
1574 +-----------------+-----------------+-------------------+---------------+---------------------------+
1575 | imageId         | O               | 1                 | String        | ImageId（type=2）         |
1576 +-----------------+-----------------+-------------------+---------------+---------------------------+
1577
1578 **contextArray**
1579
1580 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1581 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                           |
1582 +=================+=================+===================+===============+===========================================================================================================================================================+
1583 | fileName        | M               | 1                 | String        | Injection file name                                                                                                                                       |
1584 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1585 | fileData        | M               | 1                 | string        | Injection file content (injection file content inside the <mac>$MAC\_1</mac> $MAC\_1 need to be replaced by the MAC address, of which 1 is NIC index. )   |
1586 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1587
1588 **volumeArray**
1589
1590 +-----------------+-----------------+-------------------+---------------+-------------------+
1591 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1592 +=================+=================+===================+===============+===================+
1593 | volumeId        | M               | 1                 | String        | Volume Id         |
1594 +-----------------+-----------------+-------------------+---------------+-------------------+
1595
1596 **nicArray**
1597
1598 +-----------------+-----------------+-------------------+---------------+-------------------+
1599 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1600 +=================+=================+===================+===============+===================+
1601 | portId          | M               | 1                 | String        | Port Id           |
1602 +-----------------+-----------------+-------------------+---------------+-------------------+
1603
1604 **metadata**
1605
1606 +-----------------+-----------------+-------------------+---------------+-------------------+
1607 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1608 +=================+=================+===================+===============+===================+
1609 | keyName         | M               | 1                 | String        | Key name          |
1610 +-----------------+-----------------+-------------------+---------------+-------------------+
1611 | value           | M               | 1                 | string        | value             |
1612 +-----------------+-----------------+-------------------+---------------+-------------------+
1613
1614 ::
1615
1616     {
1617
1618         "tenant": "tenant1",
1619
1620         "name": "vm1",
1621
1622         "availabilityZone": "az1",
1623
1624         "flavorName": "vm_large",
1625
1626         "boot": {
1627
1628             "type": 1,
1629
1630             " volumeName": "volume1"
1631
1632         },
1633
1634         "flavorId": "vm_large_134213",
1635
1636         "contextArray": [{
1637
1638             "fileName": "test.yaml",
1639
1640             "fileData": "…."
1641
1642         }],
1643
1644         "volumeArray": [{
1645
1646             "volumeName": "vol1",
1647
1648         }],
1649
1650         "nicArray": [{
1651
1652             "portId": "port_a"
1653
1654         }],
1655
1656         "metada": [{
1657
1658             "keyName": "foo",
1659
1660             "value": "foo value"
1661
1662         }],
1663
1664         "userdata": "abcdedf"
1665
1666     }
1667
1668 7.1.2. **Response**
1669 >>>>>>>>>>>>>>>>>>>
1670
1671 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1672 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                          | **Description**                                                                                                                                                                        |
1673 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1674 | vimId                | M               | 1                 | String                               | vim id                                                                                                                                                                                 |
1675 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1676 | vimName              | O               | 1                 | string                               | vim name                                                                                                                                                                               |
1677 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1678 | returnCode           |                 | 1                 | int                                  | 0: Already exist 1: Newly created                                                                                                                                                      |
1679 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1680 | id                   | M               | 1                 | string                               | server id                                                                                                                                                                              |
1681 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1682 | name                 |                 | 1                 | string                               | server name                                                                                                                                                                            |
1683 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1684 | tenantId             | M               | 1                 | String                               | Tenant UUID                                                                                                                                                                            |
1685 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1686 | boot                 | M               | 1                 | String                               | Start parameters                                                                                                                                                                       |
1687 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1688 | nicArray             | O               | 1..n              | List of nic                          | List of nic                                                                                                                                                                            |
1689 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1690 | volumeArray          | O               | 1..n              | list of volume                       | list of volume                                                                                                                                                                         |
1691 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1692 | availabilityZone     | O               | 1                 | string                               | Usable field                                                                                                                                                                           |
1693 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1694 | flavorId             | M               | 1                 | String                               | server Flavor                                                                                                                                                                          |
1695 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1696 | metadata             | O               | 1                 | List of metadata                     | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1697 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1698 | **securityGroups**   | **O**           | **1**             | **List of name of security group**   | **One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.**   |
1699 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1700 |                      |                 |                   |                                      | **[TBD]**                                                                                                                                                                              |
1701 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1702 | **serverGroup**      | **O**           | **1**             | **string**                           | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1703 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1704 |                      |                 |                   |                                      | [TBD]                                                                                                                                                                                  |
1705 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1706 | **status**           | **M**           | **1**             | **string**                           | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR                                                                                                                                             |
1707 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1708
1709 202: accepted
1710
1711 500: failed
1712
1713 ::
1714
1715     {
1716
1717     "id": "3c9eebdbbfd345658269340b9ea6fb73",
1718
1719     "name": "vm1",
1720
1721     "returnCode": 1,
1722
1723     }
1724
1725 7.2. **Delete Server**
1726 ----------------------
1727
1728 +---------------------+-------------------------------------------------------------------------------------------+
1729 | **IF Definition**   | **Description**                                                                           |
1730 +=====================+===========================================================================================+
1731 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1732 +---------------------+-------------------------------------------------------------------------------------------+
1733 | Operation           | DELETE                                                                                    |
1734 +---------------------+-------------------------------------------------------------------------------------------+
1735 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1736 +---------------------+-------------------------------------------------------------------------------------------+
1737
1738 7.2.1. **Request**
1739 >>>>>>>>>>>>>>>>>>
1740
1741 N/A
1742
1743 7.2.2. **Response**
1744 >>>>>>>>>>>>>>>>>>>
1745
1746 204: no content
1747
1748 7.3. **List Server**
1749 --------------------
1750
1751 +---------------------+--------------------------------------------------------------------------------+
1752 | **IF Definition**   | **Description**                                                                |
1753 +=====================+================================================================================+
1754 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1755 +---------------------+--------------------------------------------------------------------------------+
1756 | Operation           | get                                                                            |
1757 +---------------------+--------------------------------------------------------------------------------+
1758 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1759 +---------------------+--------------------------------------------------------------------------------+
1760
1761 7.3.1. **Request**
1762 >>>>>>>>>>>>>>>>>>
1763
1764 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1765
1766 +-----------------+-----------------+-------------------+---------------+-------------------+
1767 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1768 +=================+=================+===================+===============+===================+
1769 | name            | M               | 1                 | string        | server name       |
1770 +-----------------+-----------------+-------------------+---------------+-------------------+
1771
1772 7.3.2. **Response**
1773 >>>>>>>>>>>>>>>>>>>
1774
1775 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1776 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1777 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1778 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1779 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1780 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1781 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1782 | servers              | M               | 1                 | array                                 | server list                                                                                                                                                                            |
1783 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1784 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1785 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1786 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1787 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1788 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1789 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1790 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1791 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1792 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1793 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1794 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1795 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1796 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1797 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1798 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1799 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1800 | metada               | O               | 1                 | keypair                               | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1801 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1802 | **securityGroups**   | **O**           | **1**             | **List of names of security group**   | **One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.**   |
1803 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1804 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1805 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1806 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1807 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1808 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1809 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1810
1811 200: ok
1812
1813 500: failed
1814
1815 7.4. **Get Server**
1816 -------------------
1817
1818 +---------------------+-------------------------------------------------------------------------------------------+
1819 | **IF Definition**   | **Description**                                                                           |
1820 +=====================+===========================================================================================+
1821 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1822 +---------------------+-------------------------------------------------------------------------------------------+
1823 | Operation           | get                                                                                       |
1824 +---------------------+-------------------------------------------------------------------------------------------+
1825 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1826 +---------------------+-------------------------------------------------------------------------------------------+
1827
1828 7.4.1. **Request**
1829 >>>>>>>>>>>>>>>>>>
1830
1831 N/A
1832
1833 7.4.2. **Response**
1834 >>>>>>>>>>>>>>>>>>>
1835
1836 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1837 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1838 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1839 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1840 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1841 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1842 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1843 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1844 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1845 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1846 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1847 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1848 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1849 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1850 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1851 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1852 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1853 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1854 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1855 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1856 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1857 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1858 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1859 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1860 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1861 | **securityGroups**   | **O**           | **1**             | **List of names of security group**   | **One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.**   |
1862 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1863 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1864 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1865 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1866 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1867 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1868 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1869
1870 200: ok
1871
1872 500: failed
1873
1874 8. **Flavor Management**
1875 ^^^^^^^^^^^^^^^^^^^^^^^^
1876
1877 8.1. **Create Flavor**
1878 ----------------------
1879
1880 +---------------------+--------------------------------------------------------------------------------+
1881 | **IF Definition**   | **Description**                                                                |
1882 +=====================+================================================================================+
1883 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors   |
1884 +---------------------+--------------------------------------------------------------------------------+
1885 | Operation           | POST                                                                           |
1886 +---------------------+--------------------------------------------------------------------------------+
1887 | Direction           | VNFLCM->MULTIVIM                                                               |
1888 +---------------------+--------------------------------------------------------------------------------+
1889
1890 8.1.1. **Request**
1891 >>>>>>>>>>>>>>>>>>
1892
1893 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1894 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1895 +=================+=================+===================+===============================+==============================================================================================================================+
1896 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1897 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1898 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1899 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1900 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1901 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1902 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1903 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1904 | ephemeral       | O               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1905 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1906 | swap            | O               | 1                 | int                           | The size of the swap disk                                                                                                    |
1907 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1908 | isPublic        | O               | 1                 | boolean                       | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
1909 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1910 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1911 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1912
1913 8.1.2. **Response**
1914 >>>>>>>>>>>>>>>>>>>
1915
1916 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1917 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                                              |
1918 +=================+=================+===================+===========================+==============================================================================================================================+
1919 | id              | M               | 1                 | string                    | Flavor id                                                                                                                    |
1920 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1921 | name            | M               | 1                 | string                    | Flavor name                                                                                                                  |
1922 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1923 | returnCode      | M               | 1                 | int                       | 0: Already exist 1: Newly created                                                                                            |
1924 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1925 | tenantId        | M               | 1                 | String                    | Tenant UUID                                                                                                                  |
1926 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1927 | vcpu            | M               | 1                 | int                       | Virtual CPU number                                                                                                           |
1928 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1929 | memory          | M               | 1                 | int                       | Memory size                                                                                                                  |
1930 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1931 | disk            | M               | 1                 | int                       | The size of the root disk                                                                                                    |
1932 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1933 | ephemeral       | M               | 1                 | int                       | The size of the ephemeral disk                                                                                               |
1934 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1935 | swap            | M               | 1                 | int                       | The size of the swap disk                                                                                                    |
1936 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1937 | isPublic        | M               | 1                 | boolean                   | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
1938 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1939 | extraSpecs      | O               | 0..N              | List of Key-value pairs   | EPA parameter                                                                                                                |
1940 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1941 | vimId           | M               | 1                 | String                    | vim id                                                                                                                       |
1942 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1943 | vimName         | O               | 1                 | string                    | vim name                                                                                                                     |
1944 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1945
1946 8.2. **Delete Flavor**
1947 ----------------------
1948
1949 +---------------------+--------------------------------------------------------------------------------------------+
1950 | **IF Definition**   | **Description**                                                                            |
1951 +=====================+============================================================================================+
1952 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid}   |
1953 +---------------------+--------------------------------------------------------------------------------------------+
1954 | Operation           | DELETE                                                                                     |
1955 +---------------------+--------------------------------------------------------------------------------------------+
1956 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                      |
1957 +---------------------+--------------------------------------------------------------------------------------------+
1958
1959 8.2.1. **Request**
1960 >>>>>>>>>>>>>>>>>>
1961
1962 N/A
1963
1964 8.2.2. **Response**
1965 >>>>>>>>>>>>>>>>>>>
1966
1967 204: no content
1968
1969 8.3. **List Flavor**
1970 --------------------
1971
1972 +---------------------+---------------------------------------------------------------------------------+
1973 | **IF Definition**   | **Description**                                                                 |
1974 +=====================+=================================================================================+
1975 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors   |
1976 +---------------------+---------------------------------------------------------------------------------+
1977 | Operation           | get                                                                             |
1978 +---------------------+---------------------------------------------------------------------------------+
1979 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
1980 +---------------------+---------------------------------------------------------------------------------+
1981
1982 8.3.1. **Query**
1983 >>>>>>>>>>>>>>>>
1984
1985 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1986 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                  |
1987 +=================+=================+===================+===============+==================================+
1988 | name            | M               | 1                 | string        | Flavor name to filter out list   |
1989 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1990
1991 8.3.2. **Response**
1992 >>>>>>>>>>>>>>>>>>>
1993
1994 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1995 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1996 +=================+=================+===================+===============================+==============================================================================================================================+
1997 | flavors         | M               | 0..N              | list                          | Vm list                                                                                                                      |
1998 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1999 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
2000 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2001 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
2002 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2003 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
2004 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2005 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
2006 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2007 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
2008 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2009 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
2010 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2011 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
2012 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2013 | isPublic        | M               | 1                 | boolean                       | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
2014 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2015 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
2016 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2017 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
2018 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2019 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
2020 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2021 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
2022 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2023
2024 200: ok
2025
2026 500: failed
2027
2028 8.4. **Get Flavor**
2029 -------------------
2030
2031 +---------------------+----------------------------------------------------------------------------------------------+
2032 | **IF Definition**   | **Description**                                                                              |
2033 +=====================+==============================================================================================+
2034 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid }   |
2035 +---------------------+----------------------------------------------------------------------------------------------+
2036 | Operation           | get                                                                                          |
2037 +---------------------+----------------------------------------------------------------------------------------------+
2038 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                        |
2039 +---------------------+----------------------------------------------------------------------------------------------+
2040
2041 8.4.1. **Request**
2042 >>>>>>>>>>>>>>>>>>
2043
2044 N/A
2045
2046 8.4.2. **Response**
2047 >>>>>>>>>>>>>>>>>>>
2048
2049 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2050 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
2051 +=================+=================+===================+===============================+==============================================================================================================================+
2052 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
2053 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2054 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
2055 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2056 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
2057 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2058 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
2059 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2060 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
2061 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2062 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
2063 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2064 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
2065 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2066 | isPublic        | M               | 1                 | boolean                       | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified.   |
2067 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2068 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
2069 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2070 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
2071 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2072 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
2073 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2074 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
2075 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2076
2077 200: ok
2078
2079 500: failed
2080
2081 9. **Volume Management**
2082 ^^^^^^^^^^^^^^^^^^^^^^^^
2083
2084 9.1. **Create Volume**
2085 ----------------------
2086
2087 +---------------------+--------------------------------------------------------------------------------+
2088 | **IF Definition**   | **Description**                                                                |
2089 +=====================+================================================================================+
2090 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2091 +---------------------+--------------------------------------------------------------------------------+
2092 | Operation           | POST                                                                           |
2093 +---------------------+--------------------------------------------------------------------------------+
2094 | Direction           | NSLCM->MULTIVIM                                                                |
2095 +---------------------+--------------------------------------------------------------------------------+
2096
2097 9.1.1. **Request**
2098 >>>>>>>>>>>>>>>>>>
2099
2100 +--------------------+-----------------+-------------------+---------------+-------------------+
2101 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2102 +====================+=================+===================+===============+===================+
2103 | name               | M               | 1                 | string        | Volume name       |
2104 +--------------------+-----------------+-------------------+---------------+-------------------+
2105 | volumeSize         | M               | 1                 | int           | Volume size       |
2106 +--------------------+-----------------+-------------------+---------------+-------------------+
2107 | imageId            | O               | 1                 | string        | Image UUID        |
2108 +--------------------+-----------------+-------------------+---------------+-------------------+
2109 | volumeType         | O               | 1                 | string        | Volume type       |
2110 +--------------------+-----------------+-------------------+---------------+-------------------+
2111 | availabilityZone   | O               | 1                 | string        | Usable field      |
2112 +--------------------+-----------------+-------------------+---------------+-------------------+
2113
2114 ::
2115
2116     {
2117
2118     "tenant": "tenant1",
2119
2120     "volumeName": "volume1",
2121
2122     "volumeSize": 3,
2123
2124     "imageName": "cirros.qcow2",
2125
2126     "volumeType": "volumetype1",
2127
2128     "availabilityZone": "zone1"
2129
2130     }
2131
2132 9.1.2. **Response**
2133 >>>>>>>>>>>>>>>>>>>
2134
2135 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2136 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2137 +====================+=================+===================+===============+=====================================+
2138 | returnCode         | M               | 1                 | int           | 0: Already exist 1: Newly created   |
2139 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2140 | vimId              | M               | 1                 | String        | vim id                              |
2141 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2142 | vimName            | O               | 1                 | string        | vim name                            |
2143 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2144 | tenantId           | M               | 1                 | String        | Tenant UUID                         |
2145 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2146 | status             | M               | 1                 | string        | Volume status                       |
2147 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2148 | id                 | M               | 1                 | string        | Volume id                           |
2149 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2150 | name               | M               | 1                 | string        | Volume name                         |
2151 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2152 | volumeType         | O               | 1                 | string        | Volume type                         |
2153 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2154 | availabilityZone   | O               | 1                 | string        | Availability Zone                   |
2155 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2156
2157 202: accepted
2158
2159 500: failed
2160
2161 ::
2162
2163     {
2164
2165     "id": "bc9eebdbbfd356458269340b9ea6fb73",
2166
2167     "name": "volume1",
2168
2169     "returnCode": 1,
2170
2171     }
2172
2173 9.2. **Delete Volume**
2174 ----------------------
2175
2176 +---------------------+-------------------------------------------------------------------------------------------+
2177 | **IF Definition**   | **Description**                                                                           |
2178 +=====================+===========================================================================================+
2179 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId}   |
2180 +---------------------+-------------------------------------------------------------------------------------------+
2181 | Operation           | DELETE                                                                                    |
2182 +---------------------+-------------------------------------------------------------------------------------------+
2183 | Direction           | NSLCM->MULTIVIM                                                                           |
2184 +---------------------+-------------------------------------------------------------------------------------------+
2185
2186 9.2.1. **Request**
2187 >>>>>>>>>>>>>>>>>>
2188
2189     N/A
2190
2191 9.2.2. **Response**
2192 >>>>>>>>>>>>>>>>>>>
2193
2194     204: no content
2195
2196 9.3. **List Volumes**
2197 ---------------------
2198
2199 +---------------------+--------------------------------------------------------------------------------+
2200 | **IF Definition**   | **Description**                                                                |
2201 +=====================+================================================================================+
2202 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2203 +---------------------+--------------------------------------------------------------------------------+
2204 | Operation           | GET                                                                            |
2205 +---------------------+--------------------------------------------------------------------------------+
2206 | Direction           | NSLCM-> MULTIVIM                                                               |
2207 +---------------------+--------------------------------------------------------------------------------+
2208
2209 9.3.1. **Request**
2210 >>>>>>>>>>>>>>>>>>
2211
2212     msb.onap.org:80/api/multicloud/v0/{cloud
2213     owner}\_{region}/volumes?{……}
2214
2215 +-----------------+-----------------+-------------------+---------------+-------------------+
2216 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2217 +=================+=================+===================+===============+===================+
2218 | name            | M               | 1                 | string        | Volume name       |
2219 +-----------------+-----------------+-------------------+---------------+-------------------+
2220
2221 9.3.2. **Response**
2222 >>>>>>>>>>>>>>>>>>>
2223
2224 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2225 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2226 +====================+=================+===================+======================+====================================================+
2227 | vimId              | M               | 1                 | String               | vim id                                             |
2228 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2229 | vimName            | O               | 1                 | string               | vim name                                           |
2230 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2231 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2232 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2233 | volumes            | M               | 1                 | Array                |                                                    |
2234 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2235 | id                 | M               | 1                 | string               | Volume id                                          |
2236 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2237 | name               | M               | 1                 | string               | Volume name                                        |
2238 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2239 | createTime         | O               | 1                 | string               | Create time                                        |
2240 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2241 | status             | M               | 1                 | string               | Volume status                                      |
2242 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2243 | volumeSize         | M               | 1                 | int                  | Volume size                                        |
2244 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2245 | volumeType         | M               | 1                 | string               | Volume type                                        |
2246 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2247 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2248 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2249 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2250 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2251
2252 200: ok
2253
2254 500: failed
2255
2256 ::
2257
2258     {
2259
2260         "volumes": [
2261
2262             {
2263
2264                 "status": "available",
2265
2266                 "name": "test",
2267
2268                 "attachments": [],
2269
2270                 "createTime": "2015-12-02T07:57:23.000000",
2271
2272                 " volumeType ": "ws",
2273
2274                 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2275
2276                 "size": 20
2277
2278             },
2279
2280             {
2281
2282                 "status": "in-use",
2283
2284                 "name": "wangsong",
2285
2286                 "attachments": [
2287
2288                     {
2289
2290                         "device": "/dev/vdc",
2291
2292                         "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2293
2294                         "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2295
2296                         "hostName": null,
2297
2298                         "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2299
2300                     }
2301
2302                 ],
2303
2304                 "createTime": "2015-12-02T06:39:40.000000",
2305
2306                 " volumeType ": null,
2307
2308                 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2309
2310                 "size": 40
2311
2312             }
2313
2314         ]
2315
2316     }
2317
2318 9.4. **Get Volumes**
2319 --------------------
2320
2321 +---------------------+-------------------------------------------------------------------------------------------+
2322 | **IF Definition**   | **Description**                                                                           |
2323 +=====================+===========================================================================================+
2324 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid}   |
2325 +---------------------+-------------------------------------------------------------------------------------------+
2326 | Operation           | GET                                                                                       |
2327 +---------------------+-------------------------------------------------------------------------------------------+
2328 | Direction           | NSLCM-> MULTIVIM                                                                          |
2329 +---------------------+-------------------------------------------------------------------------------------------+
2330
2331 9.4.1. **Request**
2332 >>>>>>>>>>>>>>>>>>
2333
2334     N/A
2335
2336 9.4.2. **Response**
2337 >>>>>>>>>>>>>>>>>>>
2338
2339 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2340 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2341 +====================+=================+===================+======================+====================================================+
2342 | vimId              | M               | 1                 | String               | vim id                                             |
2343 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2344 | vimName            | O               | 1                 | string               | vim name                                           |
2345 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2346 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2347 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2348 | id                 |                 | 1                 | string               | Volume id                                          |
2349 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2350 | name               |                 | 1                 | string               | Volume name                                        |
2351 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2352 | createTime         |                 | 1                 | string               | Create time                                        |
2353 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2354 | status             |                 | 1                 | string               | Volume status                                      |
2355 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2356 | volumeType         |                 | 1                 | list of string       | Volume type                                        |
2357 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2358 | volumeSize         |                 | 1                 | int                  | Volume size                                        |
2359 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2360 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2361 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2362 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2363 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2364
2365 **attachment：**
2366
2367 +-----------------+-----------------+-------------------+---------------+-------------------+
2368 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2369 +=================+=================+===================+===============+===================+
2370 | device          |                 | 1                 | string        | Device name       |
2371 +-----------------+-----------------+-------------------+---------------+-------------------+
2372 | serverId        |                 | 1                 | string        | VM id             |
2373 +-----------------+-----------------+-------------------+---------------+-------------------+
2374 | volumeId        |                 | 1                 | string        | Volume id         |
2375 +-----------------+-----------------+-------------------+---------------+-------------------+
2376 | hostName        |                 | 1                 | string        | Host name         |
2377 +-----------------+-----------------+-------------------+---------------+-------------------+
2378 | id              |                 | 1                 | string        | Device id         |
2379 +-----------------+-----------------+-------------------+---------------+-------------------+
2380
2381 200: ok
2382
2383 500: failed
2384
2385 ::
2386
2387     {
2388
2389         "status": "in-use",
2390
2391         "name": "wangsong",
2392
2393         "attachments": [
2394
2395             {
2396
2397                 "device": "/dev/vdc",
2398
2399                 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2400
2401                 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2402
2403                 "hostName": null,
2404
2405                 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2406
2407             }
2408
2409         ],
2410
2411         "createTime": "2015-12-02T06:39:40.000000",
2412
2413         "volumeType ": null,
2414
2415         "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2416
2417         "volumeSize ": 40
2418
2419     }
2420
2421 10. **Tenant Management**
2422 ^^^^^^^^^^^^^^^^^^^^^^^^^
2423
2424 10.1. **List tenants**
2425 ----------------------
2426
2427 +---------------------+---------------------------------------------------------------------+
2428 | **IF Definition**   | **Description**                                                     |
2429 +=====================+=====================================================================+
2430 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants   |
2431 +---------------------+---------------------------------------------------------------------+
2432 | Operation           | GET                                                                 |
2433 +---------------------+---------------------------------------------------------------------+
2434 | Direction           | NSLCM-> MULTIVIM                                                    |
2435 +---------------------+---------------------------------------------------------------------+
2436
2437 10.1.1. **Query**
2438 >>>>>>>>>>>>>>>>>
2439
2440 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2441 | **Parameter**       | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2442 +=====================+=================+===================+===============+=====================================+
2443 | name={tenantname}   | O               | 1                 | string        | Tenant name to filter output list   |
2444 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2445
2446 10.1.2. **Response**
2447 >>>>>>>>>>>>>>>>>>>>
2448
2449 +-----------------+-----------------+-------------------+---------------+-------------------+
2450 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2451 +=================+=================+===================+===============+===================+
2452 | vimId           | M               | 1                 | String        | vim id            |
2453 +-----------------+-----------------+-------------------+---------------+-------------------+
2454 | vimName         | O               | 1                 | string        | vim name          |
2455 +-----------------+-----------------+-------------------+---------------+-------------------+
2456 | tenants         | M               | 1                 | Array         |                   |
2457 +-----------------+-----------------+-------------------+---------------+-------------------+
2458 | id              | M               | 1                 | string        | tenant UUID       |
2459 +-----------------+-----------------+-------------------+---------------+-------------------+
2460 | name            | M               | 1                 | string        | tenant name       |
2461 +-----------------+-----------------+-------------------+---------------+-------------------+
2462
2463 200: ok
2464
2465 500: failed
2466
2467 ::
2468
2469     {
2470
2471         " tenants ": [
2472
2473             {
2474
2475                 "id": "1",
2476
2477                 "name": "test\_a"
2478
2479             }
2480
2481         ]
2482
2483     }
2484
2485 11. **Limits**
2486 ^^^^^^^^^^^^^^
2487
2488 11.1. **List Limits of resouces**
2489 ---------------------------------
2490
2491 +---------------------+-------------------------------------------------------------------------------+
2492 | **IF Definition**   | **Description**                                                               |
2493 +=====================+===============================================================================+
2494 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits   |
2495 +---------------------+-------------------------------------------------------------------------------+
2496 | Operation           | GET                                                                           |
2497 +---------------------+-------------------------------------------------------------------------------+
2498 | Direction           | NSLCM-> MULTIVIM                                                              |
2499 +---------------------+-------------------------------------------------------------------------------+
2500
2501 11.1.1. **Request**
2502 >>>>>>>>>>>>>>>>>>>
2503
2504 N/A
2505
2506 11.1.2. **Response**
2507 >>>>>>>>>>>>>>>>>>>>
2508
2509 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2510 | **Parameter**             | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                  |
2511 +===========================+=================+===================+===============+==================================================================+
2512 | vimId                     | M               | 1                 | String        | vim id                                                           |
2513 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2514 | vimName                   | O               | 1                 | string        | vim name                                                         |
2515 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2516 | tenantId                  | M               | 1                 | string        | Tenant UUID                                                      |
2517 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2518 | maxPersonality            | O               | 1                 | int           | The number of allowed injected files for each tenant.            |
2519 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2520 | maxPersonalitySize        | O               | 1                 | int           | The number of allowed bytes of content for each injected file.   |
2521 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2522 | maxServerGroupMembers     | O               | 1                 | int           | The number of allowed members for each server group.             |
2523 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2524 | maxServerGroups           | O               | 1                 | int           | The number of allowed server groups for each tenant.             |
2525 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2526 | maxServerMeta             | O               | 1                 | int           | The number of allowed metadata items for each instance.          |
2527 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2528 | maxTotalCores             | O               | 1                 | int           | The number of allowed instance cores for each tenant.            |
2529 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2530 | maxTotalInstances         | O               | 1                 | int           | The number of allowed instances for each tenant.                 |
2531 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2532 | maxTotalKeypairs          | O               | 1                 | int           | The number of allowed key pairs for each user.                   |
2533 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2534 | maxTotalRAMSize           | O               | 1                 | int           | The amount of allowed instance RAM, in MB, for each tenant.      |
2535 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2536 | maxTotalVolumeGigabytes   | O               | 1                 | int           | The maximum total amount of volumes, in gibibytes (GiB).         |
2537 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2538 | maxTotalVolumes           | O               | 1                 | int           | The maximum number of volumes.                                   |
2539 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2540 | totalVolumesUsed          | O               | 1                 | int           | The total number of volumes used.                                |
2541 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2542 | totalGigabytesUsed        | O               | 1                 | int           | The total number of gibibytes (GiB) used.                        |
2543 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2544 | network                   | O               | 1                 | int           | The number of networks allowed for each project.                 |
2545 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2546 | subnet                    | O               | 1                 | int           | The number of subnets allowed for each project.                  |
2547 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2548 | subnetpool                | O               | 1                 | int           | The number of subnet pools allowed for each project.             |
2549 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2550 | security\_group\_rule     | O               | 1                 | int           | The number of security group rules allowed for each project.     |
2551 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2552 | security\_group           | O               | 1                 | int           | The number of security groups allowed for each project.          |
2553 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2554 | router                    | O               | 1                 | int           | The number of routers allowed for each project.                  |
2555 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2556 | port                      | O               | 1                 | int           | The number of ports allowed for each project.                    |
2557 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2558
2559 200: ok
2560
2561 500: failed
2562
2563 ::
2564
2565     {
2566
2567     "maxPersonality": 5,
2568
2569     "maxPersonalitySize": 10240,
2570
2571     "maxServerMeta": 128,
2572
2573     "maxTotalCores": 20,
2574
2575     "maxTotalInstances": 10,
2576
2577     "maxTotalKeypairs": 100,
2578
2579     "maxTotalRAMSize": 51200,
2580
2581     "maxServerGroups": 10,
2582
2583     "maxServerGroupMembers": 10,
2584
2585     }
2586
2587 12. **Host Management**
2588 ^^^^^^^^^^^^^^^^^^^^^^^
2589
2590 12.1. **List hosts**
2591 --------------------
2592
2593 +---------------------+------------------------------------------------------------------------------+
2594 | **IF Definition**   | **Description**                                                              |
2595 +=====================+==============================================================================+
2596 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts   |
2597 +---------------------+------------------------------------------------------------------------------+
2598 | Operation           | GET                                                                          |
2599 +---------------------+------------------------------------------------------------------------------+
2600 | Direction           | NSLCM-> MULTIVIM                                                             |
2601 +---------------------+------------------------------------------------------------------------------+
2602
2603 12.1.1. **Request**
2604 >>>>>>>>>>>>>>>>>>>
2605
2606 N/A
2607
2608 12.1.2. **Response**
2609 >>>>>>>>>>>>>>>>>>>>
2610
2611 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2612 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**     | **Description**                   |
2613 +=================+=================+===================+=================+===================================+
2614 | vimId           | M               | 1                 | String          | vim id                            |
2615 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2616 | vimName         | O               | 1                 | string          | vim name                          |
2617 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2618 | tenantId        | M               | 1                 | string          | Tenant Name                       |
2619 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2620 | hosts           | M               | 1                 | Array of host   | List of host information          |
2621 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2622 | service         | M               | 1                 | string          | The service running on the host   |
2623 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2624 | name            | M               | 1                 | string          | host name                         |
2625 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2626 | zone            | O               | 1                 | string          | Available zone for the host       |
2627 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2628
2629 200: ok
2630
2631 500: failed
2632
2633 ::
2634
2635     {
2636
2637         "vimId": "123",
2638
2639         "vimName": "vimName",
2640
2641         "tenantId": "tenantId1"
2642
2643         "hosts": [
2644
2645             {
2646
2647                 "name": "b6e4adbc193d428ea923899d07fb001e",
2648
2649                 "service": "conductor",
2650
2651                 "zone": "internal",
2652
2653                 "vimId": "123",
2654
2655                 "vimName": "vimName",
2656
2657                 "tenantId": "tenantId1"
2658
2659             },
2660
2661             {
2662
2663                 "name": "09c025b0efc64211bd23fc50fa974cdf",
2664
2665                 "service": "compute",
2666
2667                 "zone": "nova"
2668
2669                 "vimId": "123",
2670
2671                 "vimName": "vimName",
2672
2673                 "tenantId": "tenantId1"
2674
2675             },
2676
2677             {
2678
2679                 "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2680
2681                 "service": "consoleauth",
2682
2683                 "zone": "internal"
2684
2685                 "vimId": "123",
2686
2687                 "vimName": "vimName",
2688
2689                 "tenantId": "tenantId1"
2690
2691             },
2692
2693             {
2694
2695                 "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2696
2697                 "service": "network",
2698
2699                 "zone": "internal"
2700
2701                 "vimId": "123",
2702
2703                 "vimName": "vimName",
2704
2705                 "tenantId": "tenantId1"
2706
2707             },
2708
2709             {
2710
2711                 "name": "abffda96592c4eacaf4111c28fddee17",
2712
2713                 "service": "scheduler",
2714
2715                 "zone": "internal"
2716
2717                 "vimId": "123",
2718
2719                 "vimName": "vimName",
2720
2721                 "tenantId": "tenantId1"
2722
2723             }
2724
2725         ]
2726
2727     }
2728
2729 12.2. **Get host**
2730 ------------------
2731
2732 +---------------------+-----------------------------------------------------------------------------------------+
2733 | **IF Definition**   | **Description**                                                                         |
2734 +=====================+=========================================================================================+
2735 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/hosts/{hostname}    |
2736 +---------------------+-----------------------------------------------------------------------------------------+
2737 | Operation           | GET                                                                                     |
2738 +---------------------+-----------------------------------------------------------------------------------------+
2739 | Direction           | NSLCM-> MULTIVIM                                                                        |
2740 +---------------------+-----------------------------------------------------------------------------------------+
2741
2742 12.2.1. **Request**
2743 >>>>>>>>>>>>>>>>>>>
2744
2745 12.2.2. **Response**
2746 >>>>>>>>>>>>>>>>>>>>
2747
2748 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2749 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**         | **Description**                                              |
2750 +=================+=================+===================+=====================+==============================================================+
2751 | vimId           | M               | 1                 | String              | vim id                                                       |
2752 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2753 | vimName         | O               | 1                 | string              | vim name                                                     |
2754 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2755 | tenantId        | M               | 1                 | string              | Tenant Name                                                  |
2756 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2757 | host            | M               | 1                 | List of resources   | Host resource info                                           |
2758 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2759 | resource        | M               | 1..N              | Object              | Resource description                                         |
2760 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2761 | cpu             | M               | 1                 | Int                 | The cpu info on the host.                                    |
2762 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2763 | memory_mb       | M               | 1                 | int                 | The memory info on the host (in MB).                         |
2764 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2765 | name            | M               | 1                 | string              | host name                                                    |
2766 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2767 | project         | M               | 1                 | string              | Value: total, used_now, used_max or specific project_id      |
2768 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2769 | disk_gb         | M               | 1                 | int                 | The disk info on the host (in GB).                           |
2770 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2771
2772 200: ok
2773
2774 500: failed
2775
2776 ::
2777
2778     {
2779
2780         "cpu": 1,
2781
2782         "disk\_gb": 1028,
2783
2784         "name": "c1a7de0ac9d94e4baceae031d05caae3",
2785
2786         "memory\_mb": 8192,
2787
2788         "vimId": "123",
2789
2790         "vimName": "vimName",
2791
2792         "tenantId": "tenantId1",
2793
2794         "host": [
2795
2796             {
2797
2798                 "memory\_mb": 4960,
2799
2800                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2801
2802                 "disk\_gb": 92,
2803
2804                 "project": "(total)",
2805
2806                 "cpu": 4
2807
2808             },
2809
2810             {
2811
2812                 "memory\_mb": 1536,
2813
2814                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2815
2816                 "disk\_gb": 2,
2817
2818                 "project": "(used\_now)",
2819
2820                 "cpu": 2
2821
2822             },
2823
2824             {
2825
2826                 "memory\_mb": 1024,
2827
2828                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2829
2830                 "disk\_gb": 2,
2831
2832                 "project": "(used\_max)",
2833
2834                 "cpu": 2
2835
2836             },
2837
2838             {
2839
2840                 "memory\_mb": 1024,
2841
2842                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2843
2844                 "disk\_gb": 2,
2845
2846                 "project": "568f7ec425db472ba348251bf1e7eebd",
2847
2848                 "cpu": 2
2849
2850             }
2851
2852         ],
2853
2854         "vimName": "openstack\_newton",
2855
2856         "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2857
2858         "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2859
2860     }
2861
2862 13. **VIM Management**
2863 ^^^^^^^^^^^^^^^^^^^^^^
2864
2865 13.1. **Update VIM Info**
2866 -------------------------
2867
2868 +---------------------+----------------------------------------------------------------------------------------------+
2869 | **IF Definition**   | **Description**                                                                              |
2870 +=====================+==============================================================================================+
2871 | URI                 | http(s)://[hostname][:port]/onapapi/ multicloud /v1/{cloud-owner}\_{cloud-region}/registry   |
2872 +---------------------+----------------------------------------------------------------------------------------------+
2873 | Operation           | POST                                                                                         |
2874 +---------------------+----------------------------------------------------------------------------------------------+
2875 | Direction           | ESR-> MULTICLOUD                                                                             |
2876 +---------------------+----------------------------------------------------------------------------------------------+
2877
2878 13.1.1. **Request**
2879 >>>>>>>>>>>>>>>>>>>
2880
2881 +-----------------+-----------------+-------------------+---------------+-----------------------+
2882 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**       |
2883 +=================+=================+===================+===============+=======================+
2884 | defaultTenant   | M               | 1                 | string        | default tenant name   |
2885 +-----------------+-----------------+-------------------+---------------+-----------------------+
2886
2887 13.1.2. **Response**
2888 >>>>>>>>>>>>>>>>>>>>
2889
2890 NA
2891
2892 202: accept
2893
2894 400: failed
2895
2896 13.2. **Unregistry VIM**
2897 ------------------------
2898
2899 +---------------------+-----------------------------------------------------------------------------------------------+
2900 | **IF Definition**   | **Description**                                                                               |
2901 +=====================+===============================================================================================+
2902 | URI                 | http(s)://[hostname][:port]/onapapi/multicloud/v1/{cloud-owner}\_{cloud-region}               |
2903 +---------------------+-----------------------------------------------------------------------------------------------+
2904 | Operation           | DELETE                                                                                        |
2905 +---------------------+-----------------------------------------------------------------------------------------------+
2906 | Direction           | ESR-> MULTICLOUD                                                                              |
2907 +---------------------+-----------------------------------------------------------------------------------------------+
2908
2909 13.2.1. **Request**
2910 >>>>>>>>>>>>>>>>>>>
2911
2912 NA
2913
2914 13.2.2. **Response**
2915 >>>>>>>>>>>>>>>>>>>>
2916
2917 NA
2918
2919 204: No content found
2920
2921 400: failed