docs/MultiCloud-API-Specification-V1.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (c) 2017-2018 VMware, Inc.
   4
   5 ================================
   6 MultiCloud API Specification V1
   7 ================================
   8
   9 API Catalog
  10 ===========
  11
  12 `1. Scope 5 <#_Toc490851650>`__
  13
  14 `2. Terms, Definitions and Abbreviations 5 <#_Toc490851651>`__
  15
  16 `3. Image Management 5 <#_Toc490851652>`__
  17
  18 `3.1 Create Image 5 <#_Toc490851653>`__
  19
  20 `3.1.1 Request 5 <#_Toc490851654>`__
  21
  22 `3.1.2 Response 6 <#_Toc490851655>`__
  23
  24 `3.2 Delete Image 7 <#_Toc490851656>`__
  25
  26 `3.2.1 Request 7 <#_Toc490851657>`__
  27
  28 `3.2.2 Response 7 <#_Toc490851658>`__
  29
  30 `3.3 List Images 7 <#_Toc490851659>`__
  31
  32 `3.3.1 Request 7 <#_Toc490851660>`__
  33
  34 `3.3.2 Response 8 <#_Toc490851661>`__
  35
  36 `3.4 Get Image 9 <#_Toc490851662>`__
  37
  38 `3.4.1 Request 9 <#_Toc490851663>`__
  39
  40 `3.4.2 Response 9 <#_Toc490851664>`__
  41
  42 `4. Network Management 10 <#_Toc490851665>`__
  43
  44 `4.1 Create Network 10 <#_Toc490851666>`__
  45
  46 `4.1.1 Request 10 <#_Toc490851667>`__
  47
  48 `4.1.2 Response 11 <#_Toc490851668>`__
  49
  50 `4.2 Delete Network 12 <#_Toc490851669>`__
  51
  52 `4.2.1 Request 12 <#_Toc490851670>`__
  53
  54 `4.2.2 Response 12 <#_Toc490851671>`__
  55
  56 `4.3 List Network 12 <#_Toc490851672>`__
  57
  58 `4.3.1 Query 12 <#_Toc490851673>`__
  59
  60 `4.3.2 Response 13 <#_Toc490851674>`__
  61
  62 `4.4 Get Network 14 <#_Toc490851675>`__
  63
  64 `4.4.1 Request 14 <#_Toc490851676>`__
  65
  66 `4.4.2 Response 14 <#_Toc490851677>`__
  67
  68 `5. Subnetwork Management 16 <#_Toc490851678>`__
  69
  70 `5.1 Create Subnets 16 <#_Toc490851679>`__
  71
  72 `5.1.1 Request 16 <#_Toc490851680>`__
  73
  74 `5.1.2 Response 17 <#_Toc490851681>`__
  75
  76 `5.2 Delete Subnets 18 <#_Toc490851682>`__
  77
  78 `5.2.1 Request 18 <#_Toc490851683>`__
  79
  80 `5.2.2 Response 18 <#_Toc490851684>`__
  81
  82 `5.3 List Subnets 18 <#_Toc490851685>`__
  83
  84 `5.3.1 Query 18 <#_Toc490851686>`__
  85
  86 `5.3.2 Response 19 <#_Toc490851687>`__
  87
  88 `5.4 Get Subnets 20 <#_Toc490851688>`__
  89
  90 `5.4.1 Request 20 <#_Toc490851689>`__
  91
  92 `5.4.2 Response 20 <#_Toc490851690>`__
  93
  94 `6. Virtual Port 21 <#_Toc490851691>`__
  95
  96 `6.1 Create Virtual Port 21 <#_Toc490851692>`__
  97
  98 `6.1.1 Request 21 <#_Toc490851693>`__
  99
 100 `6.1.2 Response 22 <#_Toc490851694>`__
 101
 102 `6.2 Delete Virtual Port 22 <#_Toc490851695>`__
 103
 104 `6.2.1 Request 23 <#_Toc490851696>`__
 105
 106 `6.2.2 Response 23 <#_Toc490851697>`__
 107
 108 `6.3 List Virtual Port 23 <#_Toc490851698>`__
 109
 110 `6.3.1 Query 23 <#_Toc490851699>`__
 111
 112 `6.3.2 Response 23 <#_Toc490851700>`__
 113
 114 `6.4 Get Virtual Port 24 <#_Toc490851701>`__
 115
 116 `6.4.1 Request 24 <#_Toc490851702>`__
 117
 118 `6.4.2 Response 24 <#_Toc490851703>`__
 119
 120 `7. Server Management 25 <#_Toc490851704>`__
 121
 122 `7.1 Create Server 25 <#_Toc490851705>`__
 123
 124 `7.1.1 Request 25 <#_Toc490851706>`__
 125
 126 `7.1.2 Response 27 <#_Toc490851707>`__
 127
 128 `7.2 Delete Server 28 <#_Toc490851708>`__
 129
 130 `7.2.1 Request 28 <#_Toc490851709>`__
 131
 132 `7.2.2 Response 28 <#_Toc490851710>`__
 133
 134 `7.3 List Server 28 <#_Toc490851711>`__
 135
 136 `7.3.1 Request 28 <#_Toc490851712>`__
 137
 138 `7.3.2 Response 29 <#_Toc490851713>`__
 139
 140 `7.4 Get Server 29 <#_Toc490851714>`__
 141
 142 `7.4.1 Request 30 <#_Toc490851715>`__
 143
 144 `7.4.2 Response 30 <#_Toc490851716>`__
 145
 146 `8. Flavor Management 30 <#_Toc490851717>`__
 147
 148 `8.1 Create Flavor 31 <#_Toc490851718>`__
 149
 150 `8.1.1 Request 31 <#_Toc490851719>`__
 151
 152 `8.1.2 Response 31 <#_Toc490851720>`__
 153
 154 `8.2 Delete Flavor 32 <#_Toc490851721>`__
 155
 156 `8.2.1 Request 32 <#_Toc490851722>`__
 157
 158 `8.2.2 Response 32 <#_Toc490851723>`__
 159
 160 `8.3 List Flavor 32 <#_Toc490851724>`__
 161
 162 `8.3.1 Query 32 <#_Toc490851725>`__
 163
 164 `8.3.2 Response 32 <#_Toc490851726>`__
 165
 166 `8.4 Get Flavor 33 <#_Toc490851727>`__
 167
 168 `8.4.1 Request 33 <#_Toc490851728>`__
 169
 170 `8.4.2 Response 33 <#_Toc490851729>`__
 171
 172 `9. Volume Management 34 <#_Toc490851730>`__
 173
 174 `9.1 Create Volume 34 <#_Toc490851731>`__
 175
 176 `9.1.1 Request 34 <#_Toc490851732>`__
 177
 178 `9.1.2 Response 34 <#_Toc490851733>`__
 179
 180 `9.2 Delete Volume 35 <#_Toc490851734>`__
 181
 182 `9.2.1 Request 35 <#_Toc490851735>`__
 183
 184 `9.2.2 Response 35 <#_Toc490851736>`__
 185
 186 `9.3 List Volumes 35 <#_Toc490851737>`__
 187
 188 `9.3.1 Request 35 <#_Toc490851738>`__
 189
 190 `9.3.2 Response 36 <#_Toc490851739>`__
 191
 192 `9.4 Get Volumes 37 <#_Toc490851740>`__
 193
 194 `9.4.1 Request 37 <#_Toc490851741>`__
 195
 196 `9.4.2 Response 37 <#_Toc490851742>`__
 197
 198 `10. Tenant Management 38 <#_Toc490851743>`__
 199
 200 `10.1 List tenants 38 <#_Toc490851744>`__
 201
 202 `10.1.1 Query 38 <#_Toc490851745>`__
 203
 204 `10.1.2 Response 38 <#_Toc490851746>`__
 205
 206 `11. Limits 39 <#_Toc490851747>`__
 207
 208 `11.1 List Limits of resouces: CPU&Memory, volume,network,etc
 209 39 <#_Toc490851748>`__
 210
 211 `11.1.1 Request 39 <#_Toc490851749>`__
 212
 213 `11.1.2 Response 39 <#_Toc490851750>`__
 214
 215 `12. Host Management 41 <#_Toc490851751>`__
 216
 217 `12.1 List hosts 41 <#_Toc490851752>`__
 218
 219 `12.1.1 Request 41 <#_Toc490851753>`__
 220
 221 `12.1.2 Response 41 <#_Toc490851754>`__
 222
 223 `12.2 Get host 43 <#_Toc490851755>`__
 224
 225 `12.2.1 Request 43 <#_Toc490851756>`__
 226
 227 `12.2.2 Response 43 <#_Toc490851757>`__
 228
 229 `13. VIM Management 45 <#_Toc490851758>`__
 230
 231 `13.1 Update VIM Info 45 <#_Toc490851759>`__
 232
 233 `13.1.1 Request 45 <#_Toc490851760>`__
 234
 235 `13.1.2 Response 45 <#_Toc490851761>`__
 236
 237 `13.2 Unregistry VIM 45 <#_Toc490851762>`__
 238
 239 `13.2.1 Request 45 <#_Toc490851763>`__
 240
 241 `13.2.2 Response 46 <#_Toc490851764>`__
 242
 243 *
 244 *
 245
 246 1. \ **Scope**
 247
 248 The scope of the present document is to describe the VIM Driver API
 249 specification.
 250
 251 1. \ **Terms, Definitions and Abbreviations**
 252
 253 For the purposes of the present document, the following abbreviations
 254 apply:
 255
 256 +--------------------+-------------------------------------------------------------+
 257 | **Abbreviation**   |                                                             |
 258 +====================+=============================================================+
 259 | NFVO               | Network Functions Virtualization Orchestrator               |
 260 +--------------------+-------------------------------------------------------------+
 261 | VNFM               | Virtual Network Function Management                         |
 262 +--------------------+-------------------------------------------------------------+
 263 | VIM                | Virtualized Infrastructure Manager                          |
 264 +--------------------+-------------------------------------------------------------+
 265 | MultiVIM           | MultVIM driver services for OPEN-O to drive VIM instances   |
 266 +--------------------+-------------------------------------------------------------+
 267
 268 Table 2-1 abbreviations
 269
 270 1. \ **Image Management**
 271
 272    1. \ **Create Image**
 273
 274 +---------------------+-------------------------------------------------------------------------------+
 275 | **IF Definition**   | **Description**                                                               |
 276 +=====================+===============================================================================+
 277 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images   |
 278 +---------------------+-------------------------------------------------------------------------------+
 279 | Operation           | POST                                                                          |
 280 +---------------------+-------------------------------------------------------------------------------+
 281 | Direction           | NSLCM->MULTIVIM                                                               |
 282 +---------------------+-------------------------------------------------------------------------------+
 283 | Description         | Create Image and Upload the image file to the VIM                             |
 284 +---------------------+-------------------------------------------------------------------------------+
 285
 286 1. \ **Request**
 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 "imageName": "cirros",
 311
 312 "imagePath": "/home/cirros.qcow2",
 313
 314 "imageType": "qcow2"
 315
 316 “containerFormat”:”bare”
 317
 318 }
 319
 320 1. \ **Response**
 321
 322 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 323 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                        |
 324 +===================+=================+===================+===========================+========================================================+
 325 | id                | M               | 1                 | String                    | Image UUID in the VIM                                  |
 326 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 327 | name              | M               | 1                 | String                    | Image Name                                             |
 328 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 329 | returnCode        | M               | 1                 | Int                       | 0: Already exist 1: Newly created                      |
 330 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 331 | imageType         | M               | 1                 | String                    | Image Type                                             |
 332 |                   |                 |                   |                           |                                                        |
 333 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 334 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 335 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                 |
 336 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 337 | visibility        | O               | 1                 | string                    | Visibility for this image.                             |
 338 |                   |                 |                   |                           |                                                        |
 339 |                   |                 |                   |                           | public, private, shared, or community                  |
 340 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 341 | properties        | O               | 0..N              | List of key-value pairs   |                                                        |
 342 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 343 | vimid             | M               | 1                 | String                    | vim id                                                 |
 344 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 345 | vimName           | O               | 1                 | string                    | vim name                                               |
 346 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 347 | tenantId          | M               | 1                 | String                    | Tenant UUID                                            |
 348 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 349
 350 *202*: accepted
 351
 352 500: failed
 353
 354 {
 355
 356     “id”:” 3c9eebdbbfd345658269340b9ea6fb73”,
 357
 358     "name": "cirros",
 359
 360     "returnCode": 1
 361
 362 }
 363
 364 1. \ **Delete Image**
 365
 366 +---------------------+-----------------------------------------------------------------------------------------+
 367 | **IF Definition**   | **Description**                                                                         |
 368 +=====================+=========================================================================================+
 369 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageId}   |
 370 +---------------------+-----------------------------------------------------------------------------------------+
 371 | Operation           | Delete                                                                                  |
 372 +---------------------+-----------------------------------------------------------------------------------------+
 373 | Direction           | NSLCM->MULTIVIM                                                                         |
 374 +---------------------+-----------------------------------------------------------------------------------------+
 375 | Description         | Delete Image                                                                            |
 376 +---------------------+-----------------------------------------------------------------------------------------+
 377
 378 1. \ **Request**
 379
 380 N/A
 381
 382 1. \ **Response**
 383
 384 204: no content
 385
 386 1. \ **List Images**
 387
 388 +---------------------+-------------------------------------------------------------------------------+
 389 | **IF Definition**   | **Description**                                                               |
 390 +=====================+===============================================================================+
 391 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images   |
 392 +---------------------+-------------------------------------------------------------------------------+
 393 | Operation           | GET                                                                           |
 394 +---------------------+-------------------------------------------------------------------------------+
 395 | Direction           | NSLCM->MULTIVIM                                                               |
 396 +---------------------+-------------------------------------------------------------------------------+
 397 | Description         | Query Image list                                                              |
 398 +---------------------+-------------------------------------------------------------------------------+
 399
 400 1. \ **Request**
 401
 402 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……}
 403
 404 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 405 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                  |
 406 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
 407 | 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.   |
 408 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 409 | 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.                                                   |
 410 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 411 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of an image                                                                                                                                                                               |
 412 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 413
 414 1. \ **Response**
 415
 416 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 417 | \ **Parameter**                                 | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 418 +=================================================+=================+===================+===============+========================================================+
 419 | images                                          | M               | 0..N              | List          | Image List                                             |
 420 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 421 | id                                              | M               | 1                 | String        | Image ID                                               |
 422 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 423 | size                                            | M               | 1                 | int           | Image Size                                             |
 424 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 425 | name                                            | M               | 1                 | String        | Image Name                                             |
 426 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 427 | status                                          | M               | 1                 | String        | Image Status                                           |
 428 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 429 | imageType                                       | M               | 1                 | String        | Image Type                                             |
 430 |                                                 |                 |                   |               |                                                        |
 431 |                                                 |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 432 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 433 | containerFormat                                 | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 434 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 435 | visibility                                      | O               | 1                 | string        | Visibility for this image.                             |
 436 |                                                 |                 |                   |               |                                                        |
 437 |                                                 |                 |                   |               | public, private, shared, or community                  |
 438 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 439 | vimId                                           | M               | 1                 | String        | vim id                                                 |
 440 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 441 | vimName                                         | O               | 1                 | string        | vim name                                               |
 442 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 443 | tenantId                                        | M               | 1                 | String        | Tenant UUID                                            |
 444 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 445 | 200: ok                                         |                 |                   |               |                                                        |
 446 |                                                 |                 |                   |               |                                                        |
 447 | 500: failed                                     |                 |                   |               |                                                        |
 448 |                                                 |                 |                   |               |                                                        |
 449 | {                                               |                 |                   |               |                                                        |
 450 |                                                 |                 |                   |               |                                                        |
 451 |  “vimid”:””                                     |                 |                   |               |                                                        |
 452 |                                                 |                 |                   |               |                                                        |
 453 | “vimname”:””                                    |                 |                   |               |                                                        |
 454 |                                                 |                 |                   |               |                                                        |
 455 | "imageList": [                                  |                 |                   |               |                                                        |
 456 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 457 | {                                               |                 |                   |               |                                                        |
 458 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 459 | "status": "active",                             |                 |                   |               |                                                        |
 460 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 461 | "id": "5e2757c1-f846-4727-915c-9a872553ed75",   |                 |                   |               |                                                        |
 462 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 463 | "size": 862016,                                 |                 |                   |               |                                                        |
 464 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 465 | "name": "vim-plus-cgsl40g-z.qcow2"              |                 |                   |               |                                                        |
 466 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 467 | }                                               |                 |                   |               |                                                        |
 468 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 469 | ]                                               |                 |                   |               |                                                        |
 470 |                                                 |                 |                   |               |                                                        |
 471 | }                                               |                 |                   |               |                                                        |
 472 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 473
 474 1. \ **Get Image**
 475
 476 +---------------------+-----------------------------------------------------------------------------------------+
 477 | **IF Definition**   | **Description**                                                                         |
 478 +=====================+=========================================================================================+
 479 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid}   |
 480 +---------------------+-----------------------------------------------------------------------------------------+
 481 | Operation           | GET                                                                                     |
 482 +---------------------+-----------------------------------------------------------------------------------------+
 483 | Direction           | NSLCM->MULTIVIM                                                                         |
 484 +---------------------+-----------------------------------------------------------------------------------------+
 485 | Description         | Query Image Information                                                                 |
 486 +---------------------+-----------------------------------------------------------------------------------------+
 487
 488 1. \ **Request**
 489
 490 N/A
 491
 492 1. \ **Response**
 493
 494 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 495 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 496 +===================+=================+===================+===============+========================================================+
 497 | id                | M               | 1                 | String        | Image ID                                               |
 498 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 499 | size              | M               | 1                 | int           | Image Size                                             |
 500 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 501 | name              | M               | 1                 | String        | Image Name                                             |
 502 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 503 | status            | M               | 1                 | String        | Image Status                                           |
 504 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 505 | imageType         | M               | 1                 | String        | Image Type                                             |
 506 |                   |                 |                   |               |                                                        |
 507 |                   |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 508 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 509 | containerFormat   | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 510 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 511 | visibility        | O               | 1                 | string        | Visibility for this image.                             |
 512 |                   |                 |                   |               |                                                        |
 513 |                   |                 |                   |               | public, private, shared, or community                  |
 514 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 515 | vimId             | M               | 1                 | String        | vim id                                                 |
 516 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 517 | vimName           | M               | 1                 | string        | vim name                                               |
 518 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 519 | tenantId          | M               | 1                 | String        | Tenant UUID                                            |
 520 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 521
 522 200: ok
 523
 524 500: failed
 525
 526 {
 527
 528 “vimid”:””
 529
 530 “vimname”:””
 531
 532 "status": "active",
 533
 534 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
 535
 536 "size": 862016,
 537
 538 "name": "vim-plus-cgsl40g-z.qcow2"
 539
 540 a}
 541
 542 1. \ **Network Management**
 543
 544    1. \ **Create Network**
 545
 546 +---------------------+---------------------------------------------------------------------------------+
 547 | **IF Definition**   | **Description**                                                                 |
 548 +=====================+=================================================================================+
 549 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 550 +---------------------+---------------------------------------------------------------------------------+
 551 | Operation           | POST                                                                            |
 552 +---------------------+---------------------------------------------------------------------------------+
 553 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                          |
 554 +---------------------+---------------------------------------------------------------------------------+
 555 | Description         | Create network and subnetwork on the VIM                                        |
 556 +---------------------+---------------------------------------------------------------------------------+
 557
 558 1. \ **Request**
 559
 560 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 561 | **Parameter**               | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 562 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 563 | name                        | M               | 1                 | String        | Logical network name                                                                                                                                                                                                                                                                      |
 564 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 565 | shared                      | M               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 566 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 567 | vlanTransparent             | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 568 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 569 | networkType                 | O               | 1                 | String        | Network type                                                                                                                                                                                                                                                                              |
 570 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 571 |                             |                 |                   |               | flat, vlan, vxlan, gre,                                                                                                                                                                                                                                                                   |
 572 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 573 |                             |                 |                   |               | portgroup                                                                                                                                                                                                                                                                                 |
 574 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 575 | segmentationId              | O               | 1                 | Int           | id of paragraph                                                                                                                                                                                                                                                                           |
 576 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 577 | 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.   |
 578 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 579 | routerExternal              | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 580 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 581 | {                           |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 582 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 583 | “tenant”: “tenant1”,        |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 584 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 585 | “networkName”: “ommnet”,    |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 586 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 587 | “shared”: 1,                |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 588 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 589 | “vlanTransparent”: 1,       |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 590 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 591 | “networkType”:”vlan”,       |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 592 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 593 | “segmentationId”:202,       |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 594 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 595 | “physicalNetwork”:”ctrl”,   |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 596 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 597 | “routerExternal”:0          |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 598 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 599 | }                           |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 600 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 601
 602 1. \ **Response**
 603
 604 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 605 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 606 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 607 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 608 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 609 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 610 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 611 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 612 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 613 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 614 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 615 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 616 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 617 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 618 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 619 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 620 | 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.   |
 621 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 622 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 623 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 624 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 625 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 626 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 627 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 628 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 629 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 630 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 631 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 632 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 633 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 634
 635 202: accepted
 636
 637 500: failed
 638
 639 {
 640
 641 “returnCode”:0,
 642
 643 “vimId”:”11111”,
 644
 645 “vimName”:”11111”,
 646
 647 “status”: “ACTIVE”,
 648
 649 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 650
 651 “name”: “net1”,
 652
 653 “tenant”: “tenant1”,
 654
 655 “networkName”: “ommnet”,
 656
 657 “shared”: 1,
 658
 659 “vlanTransparent”: 1,
 660
 661 “networkType”:”vlan”,
 662
 663 “segmentationId”:202,
 664
 665 “physicalNetwork ”:”ctrl”,
 666
 667 “routerExternal ”:0
 668
 669 }
 670
 671 1. \ **Delete Network**
 672
 673 +---------------------+---------------------------------------------------------------------------------------------+
 674 | **IF Definition**   | **Description**                                                                             |
 675 +=====================+=============================================================================================+
 676 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 677 +---------------------+---------------------------------------------------------------------------------------------+
 678 | Operation           | Delete                                                                                      |
 679 +---------------------+---------------------------------------------------------------------------------------------+
 680 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 681 +---------------------+---------------------------------------------------------------------------------------------+
 682
 683 1. \ **Request**
 684
 685 N/A
 686
 687 1. \ **Response**
 688
 689 204: no content
 690
 691 1. \ **List Network**
 692
 693 +---------------------+---------------------------------------------------------------------------------+
 694 | **IF Definition**   | **Description**                                                                 |
 695 +=====================+=================================================================================+
 696 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 697 +---------------------+---------------------------------------------------------------------------------+
 698 | Operation           | get                                                                             |
 699 +---------------------+---------------------------------------------------------------------------------+
 700 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
 701 +---------------------+---------------------------------------------------------------------------------+
 702
 703 1. \ **Query**
 704
 705 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 706 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                       |
 707 +=================+=================+===================+===============+=======================================================================================+
 708 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of a network   |
 709 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 710
 711 1. \ **Response**
 712
 713 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 714 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 715 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 716 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 717 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 718 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 719 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 720 | networks          |                 | 0..N              | List          | Network list                                                                                                                                                                                                                                                                              |
 721 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 722 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 723 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 724 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 725 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 726 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 727 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 728 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 729 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 730 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 731 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 732 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 733 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 734 | 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.   |
 735 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 736 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 737 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 738 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 739 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 740 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 741 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 742
 743 200: ok
 744
 745 500: failed
 746
 747 {
 748
 749 “vimId”:”11111”,
 750
 751 “vimName”:”111”,
 752
 753 “networks”:
 754
 755 [{
 756
 757 “status”: “ACTIVE”,
 758
 759 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 760
 761 “name”: “net1”,
 762
 763 “tenant”: “tenant1”,
 764
 765 “networkName”: “ommnet”,
 766
 767 “shared”: 1,
 768
 769 “vlanTransparent”: 1,
 770
 771 “networkType”:”vlan”,
 772
 773 “segmentationId”:202,
 774
 775 “physicalNetwork ”:”ctrl”,
 776
 777 “routerExternal ”:0
 778
 779 }]
 780
 781 }
 782
 783 PHYSICALNETWORK
 784
 785 1. \ **Get Network**
 786
 787 +---------------------+---------------------------------------------------------------------------------------------+
 788 | **IF Definition**   | **Description**                                                                             |
 789 +=====================+=============================================================================================+
 790 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 791 +---------------------+---------------------------------------------------------------------------------------------+
 792 | Operation           | get                                                                                         |
 793 +---------------------+---------------------------------------------------------------------------------------------+
 794 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 795 +---------------------+---------------------------------------------------------------------------------------------+
 796
 797 1. \ **Request**
 798
 799 N/A
 800
 801 1. \ **Response**
 802
 803 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 804 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 805 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 806 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 807 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 808 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 809 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 810 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 811 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 812 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 813 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 814 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 815 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 816 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 817 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 818 | 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.   |
 819 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 820 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 821 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 822 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 823 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 824 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 825 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 826 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 827 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 828 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 829 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 830 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 831 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 832
 833 200: ok
 834
 835 500: failed
 836
 837 {
 838
 839     “vimId”:”11111”,
 840
 841     “vimName”:”11111”,
 842
 843     “status”: “ACTIVE”,
 844
 845     “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 846
 847     “name”: “net1”,
 848
 849     “tenant”: “tenant1”,
 850
 851     “networkName”: “ommnet”,
 852
 853     “shared”: 1,
 854
 855     “vlanTransparent”: 1,
 856
 857     “networkType”:”vlan”,
 858
 859     “segmentationId”:202,
 860
 861     “physicalNetwork ”:”ctrl”,
 862
 863     “routerExternal ”:0
 864
 865 }
 866
 867 1. \ **Subnetwork Management**
 868
 869    1. \ **Create Subnets**
 870
 871 +---------------------+--------------------------------------------------------------------------------+
 872 | **IF Definition**   | **Description**                                                                |
 873 +=====================+================================================================================+
 874 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
 875 +---------------------+--------------------------------------------------------------------------------+
 876 | Operation           | POST                                                                           |
 877 +---------------------+--------------------------------------------------------------------------------+
 878 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                         |
 879 +---------------------+--------------------------------------------------------------------------------+
 880 | Description         | Create network and subnetwork on the VIM                                       |
 881 +---------------------+--------------------------------------------------------------------------------+
 882
 883 1. \ **Request**
 884
 885 +-------------------+-----------------+-------------------+------------------------+----------------------+
 886 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
 887 +===================+=================+===================+========================+======================+
 888 | networkId         | M               | 1                 | String                 | Network Id           |
 889 +-------------------+-----------------+-------------------+------------------------+----------------------+
 890 | name              | M               | 1                 | String                 | SubnetName           |
 891 +-------------------+-----------------+-------------------+------------------------+----------------------+
 892 | cidr              | M               | 1                 | String                 | Subnet cidr          |
 893 +-------------------+-----------------+-------------------+------------------------+----------------------+
 894 | ipVersion         | M               | 1                 | Int                    | Ip type              |
 895 |                   |                 |                   |                        |                      |
 896 |                   |                 |                   |                        | 4,6                  |
 897 +-------------------+-----------------+-------------------+------------------------+----------------------+
 898 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
 899 |                   |                 |                   |                        |                      |
 900 |                   |                 |                   |                        | 1: yes;0: no         |
 901 +-------------------+-----------------+-------------------+------------------------+----------------------+
 902 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
 903 +-------------------+-----------------+-------------------+------------------------+----------------------+
 904 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
 905 +-------------------+-----------------+-------------------+------------------------+----------------------+
 906 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
 907 +-------------------+-----------------+-------------------+------------------------+----------------------+
 908 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
 909 +-------------------+-----------------+-------------------+------------------------+----------------------+
 910 | -->allocation     |                 |                   |                        |                      |
 911 +-------------------+-----------------+-------------------+------------------------+----------------------+
 912 | -->start          | O               | 1                 | String                 | Start ip             |
 913 +-------------------+-----------------+-------------------+------------------------+----------------------+
 914 | -->end            | O               | 1                 | String                 | End ip               |
 915 +-------------------+-----------------+-------------------+------------------------+----------------------+
 916
 917 {
 918
 919 “tenant”: “tenant1”,
 920
 921 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
 922
 923 “subnetName”: “subnet1”,
 924
 925 “cidr”: “10.43.35.0/24”,
 926
 927 “ipVersion”: 4,
 928
 929 “enableDhcp”: 1,
 930
 931 “gatewayIp”: “10.43.35.1”,
 932
 933 “dnsNameservers”: [],
 934
 935 “allocationPools”:[{
 936
 937 “start”: “192.168.199.2”,
 938
 939 “end”: “192.168.199.254”
 940
 941 }],
 942
 943 “hostRoutes”: []
 944
 945 }
 946
 947 1. \ **Response**
 948
 949 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 950 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**                     |
 951 +===================+=================+===================+========================+=====================================+
 952 | returnCode        | M               | 1                 | int                    | 0: Already exist 1: Newly created   |
 953 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 954 | vimId             | M               | 1                 | String                 | vim id                              |
 955 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 956 | vimName           | O               | 1                 | string                 | vim name                            |
 957 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 958 | status            | M               | 1                 | string                 | subnetwork status                   |
 959 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 960 | id                | M               | 1                 | string                 | subNetwork id                       |
 961 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 962 | tenantId          | M               | 1                 | String                 | Tenant UUID                         |
 963 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 964 | networkId         | O               | 1                 | String                 | Network Id                          |
 965 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 966 | networkName       | O               | 1                 | String                 | Network Name                        |
 967 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 968 | name              | M               | 1                 | String                 | SubnetName                          |
 969 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 970 | cidr              | M               | 1                 | String                 | Subnet cidr                         |
 971 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 972 | ipVersion         | M               | 1                 | Int                    | Ip type                             |
 973 |                   |                 |                   |                        |                                     |
 974 |                   |                 |                   |                        | 4,6                                 |
 975 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 976 | enableDhcp        | O               | 1                 | boolean                | Whether to allow                    |
 977 |                   |                 |                   |                        |                                     |
 978 |                   |                 |                   |                        | 1: yes;0: no                        |
 979 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 980 | gatewayIp         | O               | 1                 | String                 | Gateway ip                          |
 981 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 982 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers                     |
 983 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 984 | hostRoutes        | O               | 1..n              | List of routes         | List of routes                      |
 985 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 986 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation                  |
 987 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 988 | -->allocation     |                 |                   |                        |                                     |
 989 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 990 | -->start          | O               | 1                 | String                 | Start ip                            |
 991 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 992 | -->end            | O               | 1                 | String                 | End ip                              |
 993 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 994
 995 202: accepted
 996
 997 500: failed
 998
 999 {
1000
1001     “returnCode”:0,
1002
1003     “vimId”:”11111”,
1004
1005     “vimName”:”11111”,
1006
1007 “status”:” ACTIVE”
1008
1009 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1010
1011 “tenant”: “tenant1”,
1012
1013 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1014
1015 “name”: “subnet1”,
1016
1017 “cidr”: “10.43.35.0/24”,
1018
1019 “ipVersion”: 4,
1020
1021 “enableDhcp”: 1,
1022
1023 “gatewayIp”: “10.43.35.1”,
1024
1025 “dnsNameservers”: [],
1026
1027 “allocationPools”:[{
1028
1029 “start”: “192.168.199.2”,
1030
1031 “end”: “192.168.199.254”
1032
1033 }],
1034
1035 “hostRoutes”: []
1036
1037 }
1038
1039 1. \ **Delete Subnets**
1040
1041 +---------------------+-------------------------------------------------------------------------------------------+
1042 | **IF Definition**   | **Description**                                                                           |
1043 +=====================+===========================================================================================+
1044 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId}   |
1045 +---------------------+-------------------------------------------------------------------------------------------+
1046 | Operation           | Delete                                                                                    |
1047 +---------------------+-------------------------------------------------------------------------------------------+
1048 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1049 +---------------------+-------------------------------------------------------------------------------------------+
1050
1051 1. \ **Request**
1052
1053 N/A
1054
1055 1. \ **Response**
1056
1057 204: no content
1058
1059 1. \ **List Subnets**
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 1. \ **Query**
1072
1073 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
1074
1075 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1076 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                |
1077 +=================+=================+===================+===============+================================================================================================+
1078 | name            | O               | 1                 | String        | Filters fields of the response by a name, as a string. A valid value is the name of a subnet   |
1079 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1080
1081 1. \ **Response**
1082
1083 +-------------------+-----------------+-------------------+------------------------+----------------------+
1084 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1085 +===================+=================+===================+========================+======================+
1086 | vimId             | M               | 1                 | String                 | vim id               |
1087 +-------------------+-----------------+-------------------+------------------------+----------------------+
1088 | vimName           | O               | 1                 | string                 | vim name             |
1089 +-------------------+-----------------+-------------------+------------------------+----------------------+
1090 | subnets           | M               | 0..N              | List                   | Network list         |
1091 +-------------------+-----------------+-------------------+------------------------+----------------------+
1092 | status            |                 | 1                 | string                 | subnetwork status    |
1093 +-------------------+-----------------+-------------------+------------------------+----------------------+
1094 | id                |                 | 1                 | string                 | subNetwork id        |
1095 +-------------------+-----------------+-------------------+------------------------+----------------------+
1096 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1097 +-------------------+-----------------+-------------------+------------------------+----------------------+
1098 | networkId         | O               | 1                 | String                 | Network Id           |
1099 +-------------------+-----------------+-------------------+------------------------+----------------------+
1100 | networkName       | O               | 1                 | String                 | Network Name         |
1101 +-------------------+-----------------+-------------------+------------------------+----------------------+
1102 | name              | M               | 1                 | String                 | SubnetName           |
1103 +-------------------+-----------------+-------------------+------------------------+----------------------+
1104 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1105 +-------------------+-----------------+-------------------+------------------------+----------------------+
1106 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1107 |                   |                 |                   |                        |                      |
1108 |                   |                 |                   |                        | 4,6                  |
1109 +-------------------+-----------------+-------------------+------------------------+----------------------+
1110 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1111 |                   |                 |                   |                        |                      |
1112 |                   |                 |                   |                        | 1: yes;0: no         |
1113 +-------------------+-----------------+-------------------+------------------------+----------------------+
1114 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1115 +-------------------+-----------------+-------------------+------------------------+----------------------+
1116 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1117 +-------------------+-----------------+-------------------+------------------------+----------------------+
1118 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1119 +-------------------+-----------------+-------------------+------------------------+----------------------+
1120 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
1121 +-------------------+-----------------+-------------------+------------------------+----------------------+
1122 | -->allocation     |                 |                   |                        |                      |
1123 +-------------------+-----------------+-------------------+------------------------+----------------------+
1124 | -->start          | O               | 1                 | String                 | Start ip             |
1125 +-------------------+-----------------+-------------------+------------------------+----------------------+
1126 | -->end            | O               | 1                 | String                 | End ip               |
1127 +-------------------+-----------------+-------------------+------------------------+----------------------+
1128
1129 **200: ok**
1130
1131 **500: failed**
1132
1133 {
1134
1135 “vimId”:”11111”,
1136
1137 “vimName”:”11111”,
1138
1139 "subnets":[
1140
1141     {
1142
1143 “status”:” ACTIVE”
1144
1145 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1146
1147 “tenant”: “tenant1”,
1148
1149 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1150
1151 “name”: “subnet1”,
1152
1153 “cidr”: “10.43.35.0/24”,
1154
1155 “ipVersion”: 4,
1156
1157 “enableDhcp”: 1,
1158
1159 “gatewayIp”: “10.43.35.1”,
1160
1161 “dnsNameservers”: [],
1162
1163 “allocationPools”:[{
1164
1165 “start”: “192.168.199.2”,
1166
1167 “end”: “192.168.199.254”
1168
1169 }],
1170
1171 “hostRoutes”: []
1172
1173     }
1174
1175 ]
1176
1177 }
1178
1179 1. \ **Get Subnets**
1180
1181 +---------------------+-------------------------------------------------------------------------------------------+
1182 | **IF Definition**   | **Description**                                                                           |
1183 +=====================+===========================================================================================+
1184 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid}   |
1185 +---------------------+-------------------------------------------------------------------------------------------+
1186 | Operation           | get                                                                                       |
1187 +---------------------+-------------------------------------------------------------------------------------------+
1188 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1189 +---------------------+-------------------------------------------------------------------------------------------+
1190
1191 1. \ **Request**
1192
1193 N/A
1194
1195 1. \ **Response**
1196
1197 +-------------------+-----------------+-------------------+------------------------+----------------------+
1198 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1199 +===================+=================+===================+========================+======================+
1200 | vimId             | M               | 1                 | String                 | vim id               |
1201 +-------------------+-----------------+-------------------+------------------------+----------------------+
1202 | vimName           | O               | 1                 | string                 | vim name             |
1203 +-------------------+-----------------+-------------------+------------------------+----------------------+
1204 | status            |                 | 1                 | string                 | subnetwork status    |
1205 +-------------------+-----------------+-------------------+------------------------+----------------------+
1206 | id                |                 | 1                 | string                 | subNetwork id        |
1207 +-------------------+-----------------+-------------------+------------------------+----------------------+
1208 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1209 +-------------------+-----------------+-------------------+------------------------+----------------------+
1210 | networkId         | O               | 1                 | String                 | Network Id           |
1211 +-------------------+-----------------+-------------------+------------------------+----------------------+
1212 | networkName       | O               | 1                 | String                 | Network Name         |
1213 +-------------------+-----------------+-------------------+------------------------+----------------------+
1214 | name              | M               | 1                 | String                 | SubnetName           |
1215 +-------------------+-----------------+-------------------+------------------------+----------------------+
1216 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1217 +-------------------+-----------------+-------------------+------------------------+----------------------+
1218 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1219 |                   |                 |                   |                        |                      |
1220 |                   |                 |                   |                        | 4,6                  |
1221 +-------------------+-----------------+-------------------+------------------------+----------------------+
1222 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1223 |                   |                 |                   |                        |                      |
1224 |                   |                 |                   |                        | 1: yes;0: no         |
1225 +-------------------+-----------------+-------------------+------------------------+----------------------+
1226 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1227 +-------------------+-----------------+-------------------+------------------------+----------------------+
1228 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1229 +-------------------+-----------------+-------------------+------------------------+----------------------+
1230 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1231 +-------------------+-----------------+-------------------+------------------------+----------------------+
1232 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
1233 +-------------------+-----------------+-------------------+------------------------+----------------------+
1234 | -->allocation     |                 |                   |                        |                      |
1235 +-------------------+-----------------+-------------------+------------------------+----------------------+
1236 | -->start          | O               | 1                 | String                 | Start ip             |
1237 +-------------------+-----------------+-------------------+------------------------+----------------------+
1238 | -->end            | O               | 1                 | String                 | End ip               |
1239 +-------------------+-----------------+-------------------+------------------------+----------------------+
1240
1241 202: accepted
1242
1243 500: failed
1244
1245 {
1246
1247 “status”:” ACTIVE”
1248
1249 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1250
1251 “tenant”: “tenant1”,
1252
1253 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1254
1255 “name”: “subnet1”,
1256
1257 “cidr”: “10.43.35.0/24”,
1258
1259 “ipVersion”: 4,
1260
1261 “enableDhcp”: 1,
1262
1263 “gatewayIp”: “10.43.35.1”,
1264
1265 “dnsNameservers”: [],
1266
1267 “allocationPools”:[{
1268
1269 “start”: “192.168.199.2”,
1270
1271 “end”: “192.168.199.254”
1272
1273 }],
1274
1275 “hostRoutes”: []
1276
1277 }
1278
1279 1. \ **Virtual Port**
1280
1281    1. \ **Create Virtual Port**
1282
1283 +---------------------+------------------------------------------------------------------------------+
1284 | **IF Definition**   | **Description**                                                              |
1285 +=====================+==============================================================================+
1286 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports   |
1287 +---------------------+------------------------------------------------------------------------------+
1288 | Operation           | POST                                                                         |
1289 +---------------------+------------------------------------------------------------------------------+
1290 | Direction           | VNFLCM->MULTIVIM                                                             |
1291 +---------------------+------------------------------------------------------------------------------+
1292
1293 1. \ **Request**
1294
1295 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1296 | **Parameter**          | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                       |
1297 +========================+=================+===================+===============+=======================================================+
1298 | networkId              | M               | 1                 | string        | Network UUID                                          |
1299 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1300 | subnetId               | O               | 1                 | string        | Subnet UUID                                           |
1301 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1302 | name                   | M               | 1                 | string        | Port name                                             |
1303 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1304 | macAddress             | O               | 1                 | string        | Mac address                                           |
1305 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1306 | ip                     | O               | 1                 | string        | Ip address                                            |
1307 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1308 | vnicType               | O               | 1                 | string        | Virtual network card type,                            |
1309 |                        |                 |                   |               |                                                       |
1310 |                        |                 |                   |               | the value of three kinds of normal/direct/macvtap     |
1311 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1312 | \ **securityGroups**   | **O**           | **1**             | **string**    | **The IDs of security groups applied to the port.**   |
1313 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1314
1315 1. \ **Response**
1316
1317 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1318 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1319 +======================+=================+===================+===============+=====================================================+
1320 | returnCode           | M               | 1                 | int           | 0: Already exist 1: Newly created                   |
1321 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1322 | vimId                | M               | 1                 | String        | vim id                                              |
1323 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1324 | vimName              | O               | 1                 | string        | vim name                                            |
1325 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1326 | status               | M               | 1                 | string        | status                                              |
1327 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1328 | id                   | M               | 1                 | string        | Port Id                                             |
1329 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1330 | name                 | M               | 1                 | string        | Port name                                           |
1331 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1332 | tenantId             | M               | 1                 | String        | Tenant UUID                                         |
1333 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1334 | networkName          | M               | 1                 | string        | Network name                                        |
1335 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1336 | networkId            | M               | 1                 | string        | Network Id                                          |
1337 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1338 | subnetName           | M               | 1                 | string        | Subnet name                                         |
1339 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1340 | subnetId             | M               | 1                 | string        | SubnetId                                            |
1341 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1342 | macAddress           | O               | 1                 | string        | Mac address                                         |
1343 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1344 | ip                   | O               | 1                 | string        | Ip address                                          |
1345 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1346 | vnicType             | O               | 1                 | string        | Virtual network card type,                          |
1347 |                      |                 |                   |               |                                                     |
1348 |                      |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1349 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1350 | **securityGroups**   | **O**           | **1**             | **string**    | **List of security group names.**                   |
1351 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1352
1353 1. \ **Delete Virtual Port**
1354
1355 +---------------------+---------------------------------------------------------------------------------------+
1356 | **IF Definition**   | **Description**                                                                       |
1357 +=====================+=======================================================================================+
1358 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1359 +---------------------+---------------------------------------------------------------------------------------+
1360 | Operation           | DELETTE                                                                               |
1361 +---------------------+---------------------------------------------------------------------------------------+
1362 | Direction           | VNFLCM->MULTIVIM                                                                      |
1363 +---------------------+---------------------------------------------------------------------------------------+
1364
1365 1. \ **Request**
1366
1367 N/A
1368
1369 1. \ **Response**
1370
1371 204: no content
1372
1373 1. \ **List Virtual Port**
1374
1375 +---------------------+-----------------------------------------------------------------------------+
1376 | **IF Definition**   | **Description**                                                             |
1377 +=====================+=============================================================================+
1378 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports   |
1379 +---------------------+-----------------------------------------------------------------------------+
1380 | Operation           | GET                                                                         |
1381 +---------------------+-----------------------------------------------------------------------------+
1382 | Direction           | VNFLCM->MULTIVIM                                                            |
1383 +---------------------+-----------------------------------------------------------------------------+
1384
1385 1. \ **Query**
1386
1387 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1388 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                 |
1389 +=================+=================+===================+===============+=================================================+
1390 | name            | M               | 1                 | string        | Port name to filter out list of virtual ports   |
1391 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1392
1393 1. \ **Response**
1394
1395 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1396 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1397 +===================+=================+===================+===============+=====================================================+
1398 | vimId             | M               | 1                 | String        | vim id                                              |
1399 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1400 | vimName           | O               | 1                 | string        | vim name                                            |
1401 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1402 | tenantId          | M               | 1                 | String        | Tenant UUID                                         |
1403 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1404 | Ports             | M               | 0..N              | List          | ports                                               |
1405 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1406 | id                | M               | 1                 | string        | Port Id                                             |
1407 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1408 | name              | M               | 1                 | string        | Port name                                           |
1409 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1410 | status            | M               | 1                 | string        | status                                              |
1411 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1412 | **networkName**   | O               | 1                 | string        | Network name                                        |
1413 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1414 | networkId         | M               | 1                 | string        | Network Id                                          |
1415 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1416 | subnetName        | O               | 1                 | string        | Subnet name                                         |
1417 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1418 | subnetId          | M               | 1                 | string        | SubnetId                                            |
1419 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1420 | macAddress        | O               | 1                 | string        | Mac address                                         |
1421 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1422 | ip                | O               | 1                 | string        | Ip address                                          |
1423 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1424 | vnicType          | O               | 1                 | string        | Virtual network card type,                          |
1425 |                   |                 |                   |               |                                                     |
1426 |                   |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1427 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1428 | securityGroups    | O               | 1                 | string        | List of security group names.                       |
1429 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1430
1431 **200: ok**
1432
1433 **500: failed**
1434
1435 {
1436
1437 }
1438
1439 1. \ **Get Virtual Port**
1440
1441 +---------------------+---------------------------------------------------------------------------------------+
1442 | **IF Definition**   | **Description**                                                                       |
1443 +=====================+=======================================================================================+
1444 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1445 +---------------------+---------------------------------------------------------------------------------------+
1446 | Operation           | GET                                                                                   |
1447 +---------------------+---------------------------------------------------------------------------------------+
1448 | Direction           | VNFLCM->MULTIVIM                                                                      |
1449 +---------------------+---------------------------------------------------------------------------------------+
1450
1451 1. \ **Request**
1452
1453 N/A
1454
1455 1. \ **Response**
1456
1457 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1458 | **Parameter**    | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1459 +==================+=================+===================+===============+=====================================================+
1460 | vimId            | M               | 1                 | String        | vim id                                              |
1461 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1462 | vimName          | O               | 1                 | string        | vim name                                            |
1463 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1464 | status           | M               | 1                 | string        | status                                              |
1465 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1466 | id               | M               | 1                 | string        | Port Id                                             |
1467 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1468 | name             | M               | 1                 | string        | Port name                                           |
1469 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1470 | tenantId         | M               | 1                 | String        | Tenant UUID                                         |
1471 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1472 | networkName      | M               | 1                 | string        | Network name                                        |
1473 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1474 | networkId        | M               | 1                 | string        | Network Id                                          |
1475 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1476 | subnetName       | M               | 1                 | string        | Subnet name                                         |
1477 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1478 | subnetId         | M               | 1                 | string        | SubnetId                                            |
1479 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1480 | macAddress       | O               | 1                 | string        | Mac address                                         |
1481 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1482 | ip               | O               | 1                 | string        | Ip address                                          |
1483 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1484 | vnicType         | O               | 1                 | string        | Virtual network card type,                          |
1485 |                  |                 |                   |               |                                                     |
1486 |                  |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1487 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1488 | securityGroups   | O               | 1                 | string        | **List of security group names.**                   |
1489 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1490
1491 **200: ok**
1492
1493 **500: failed**
1494
1495 {
1496
1497 }
1498
1499 1. \ **Server Management**
1500
1501    1. \ **Create Server**
1502
1503 +---------------------+--------------------------------------------------------------------------------+
1504 | **IF Definition**   | **Description**                                                                |
1505 +=====================+================================================================================+
1506 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1507 +---------------------+--------------------------------------------------------------------------------+
1508 | Operation           | POST                                                                           |
1509 +---------------------+--------------------------------------------------------------------------------+
1510 | Direction           | VNFLCM->MULTIVIM                                                               |
1511 +---------------------+--------------------------------------------------------------------------------+
1512
1513 1. \ **Request**
1514
1515 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1516 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1517 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1518 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1519 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1520 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1521 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1522 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1523 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1524 | contextArray         | O               | 1..n              | list of context                       | list of context                                                                                                                                                                        |
1525 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1526 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1527 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1528 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1529 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1530 | flavorId             | M               | 1                 | String                                | server Flavor id                                                                                                                                                                       |
1531 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1532 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1533 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1534 | userdata             | O               | 1                 | string                                | Configuration information or scripts to use upon launch. Must be Base64 encoded.                                                                                                       |
1535 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1536 |                      |                 |                   |                                       | 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.                                                       |
1537 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1538 | **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.**   |
1539 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1540 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1541 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1542
1543 **boot**
1544
1545 +-----------------+-----------------+-------------------+---------------+---------------------------+
1546 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**           |
1547 +=================+=================+===================+===============+===========================+
1548 | type            | M               | 1                 | int           | Startup mode              |
1549 |                 |                 |                   |               |                           |
1550 |                 |                 |                   |               | 1. boot from the volume   |
1551 |                 |                 |                   |               |                           |
1552 |                 |                 |                   |               | 2. boot from image        |
1553 +-----------------+-----------------+-------------------+---------------+---------------------------+
1554 | volumeId        | O               | 1                 | string        | Volume Id(type=1)         |
1555 +-----------------+-----------------+-------------------+---------------+---------------------------+
1556 | imageId         | O               | 1                 | String        | ImageId（type=2）         |
1557 +-----------------+-----------------+-------------------+---------------+---------------------------+
1558
1559 **contextArray**
1560
1561 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1562 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                           |
1563 +=================+=================+===================+===============+===========================================================================================================================================================+
1564 | fileName        | M               | 1                 | String        | Injection file name                                                                                                                                       |
1565 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1566 | 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. )   |
1567 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1568
1569 volumeArray
1570
1571 +-----------------+-----------------+-------------------+---------------+-------------------+
1572 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1573 +=================+=================+===================+===============+===================+
1574 | volumeId        | M               | 1                 | String        | Volume Id         |
1575 +-----------------+-----------------+-------------------+---------------+-------------------+
1576
1577 nicArray
1578
1579 +-----------------+-----------------+-------------------+---------------+-------------------+
1580 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1581 +=================+=================+===================+===============+===================+
1582 | portId          | M               | 1                 | String        | Port Id           |
1583 +-----------------+-----------------+-------------------+---------------+-------------------+
1584
1585 **metadata**
1586
1587 +-----------------+-----------------+-------------------+---------------+-------------------+
1588 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1589 +=================+=================+===================+===============+===================+
1590 | keyName         | M               | 1                 | String        | Key name          |
1591 +-----------------+-----------------+-------------------+---------------+-------------------+
1592 | value           | M               | 1                 | string        | value             |
1593 +-----------------+-----------------+-------------------+---------------+-------------------+
1594
1595 {
1596
1597 "tenant": "tenant1",
1598
1599 "name": "vm1",
1600
1601 “availabilityZone”:”az1”,
1602
1603 “flavorName”:”vm\_large”,
1604
1605 "boot": {
1606
1607 "type": 1,
1608
1609 " volumeName": "volume1"
1610
1611 },
1612
1613 “flavorId”:”vm\_large\_134213”
1614
1615 "contextArray": [{
1616
1617 "fileName": "test.yaml",
1618
1619 "fileData": "….”
1620
1621 }],
1622
1623 "volumeArray": [{
1624
1625 "volumeName": "vol1",
1626
1627 }],
1628
1629 “nicArray”:[{
1630
1631     “portId”:”port\_a”
1632
1633 }]
1634
1635 “metada”: [{
1636
1637 "keyName": "foo",
1638
1639 "value": "foo value”
1640
1641 }],
1642
1643 “userdata”:”abcdedf”
1644
1645 }
1646
1647 1. \ **Response**
1648
1649 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1650 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                          | **Description**                                                                                                                                                                        |
1651 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1652 | vimId                | M               | 1                 | String                               | vim id                                                                                                                                                                                 |
1653 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1654 | vimName              | O               | 1                 | string                               | vim name                                                                                                                                                                               |
1655 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1656 | returnCode           |                 | 1                 | int                                  | 0: Already exist 1: Newly created                                                                                                                                                      |
1657 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1658 | id                   | M               | 1                 | string                               | server id                                                                                                                                                                              |
1659 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1660 | name                 |                 | 1                 | string                               | server name                                                                                                                                                                            |
1661 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1662 | tenantId             | M               | 1                 | String                               | Tenant UUID                                                                                                                                                                            |
1663 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1664 | boot                 | M               | 1                 | String                               | Start parameters                                                                                                                                                                       |
1665 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1666 | nicArray             | O               | 1..n              | List of nic                          | List of nic                                                                                                                                                                            |
1667 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1668 | volumeArray          | O               | 1..n              | list of volume                       | list of volume                                                                                                                                                                         |
1669 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1670 | availabilityZone     | O               | 1                 | string                               | Usable field                                                                                                                                                                           |
1671 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1672 | flavorId             | M               | 1                 | String                               | server Flavor                                                                                                                                                                          |
1673 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1674 | metadata             | O               | 1                 | List of metadata                     | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1675 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1676 | **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.**   |
1677 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1678 |                      |                 |                   |                                      | **[TBD]**                                                                                                                                                                              |
1679 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1680 | **serverGroup**      | **O**           | **1**             | **string**                           | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1681 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1682 |                      |                 |                   |                                      | [TBD]                                                                                                                                                                                  |
1683 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1684 | **status**           | **M**           | **1**             | **string**                           | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR                                                                                                                                             |
1685 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1686
1687 202: accepted
1688
1689 500: failed
1690
1691 {
1692
1693 "id": "3c9eebdbbfd345658269340b9ea6fb73",
1694
1695 "name": "vm1",
1696
1697 "returnCode": 1,
1698
1699 }
1700
1701 1. \ **Delete Server**
1702
1703 +---------------------+-------------------------------------------------------------------------------------------+
1704 | **IF Definition**   | **Description**                                                                           |
1705 +=====================+===========================================================================================+
1706 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1707 +---------------------+-------------------------------------------------------------------------------------------+
1708 | Operation           | DELETE                                                                                    |
1709 +---------------------+-------------------------------------------------------------------------------------------+
1710 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1711 +---------------------+-------------------------------------------------------------------------------------------+
1712
1713 1. \ **Request**
1714
1715 N/A
1716
1717 1. \ **Response**
1718
1719 204: no content
1720
1721 1. \ **List Server**
1722
1723 +---------------------+--------------------------------------------------------------------------------+
1724 | **IF Definition**   | **Description**                                                                |
1725 +=====================+================================================================================+
1726 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1727 +---------------------+--------------------------------------------------------------------------------+
1728 | Operation           | get                                                                            |
1729 +---------------------+--------------------------------------------------------------------------------+
1730 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1731 +---------------------+--------------------------------------------------------------------------------+
1732
1733 1. \ **Request**
1734
1735 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1736
1737 +-----------------+-----------------+-------------------+---------------+-------------------+
1738 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1739 +=================+=================+===================+===============+===================+
1740 | name            | M               | 1                 | string        | server name       |
1741 +-----------------+-----------------+-------------------+---------------+-------------------+
1742
1743 1. \ **Response**
1744
1745 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1746 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1747 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1748 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1749 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1750 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1751 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1752 | servers              | M               | 1                 | array                                 | server list                                                                                                                                                                            |
1753 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1754 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1755 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1756 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1757 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1758 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1759 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1760 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1761 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1762 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1763 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1764 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1765 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1766 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1767 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1768 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1769 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1770 | metada               | O               | 1                 | keypair                               | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1771 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1772 | **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.**   |
1773 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1774 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1775 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1776 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1777 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1778 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1779 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1780
1781 200: ok
1782
1783 500: failed
1784
1785 {
1786
1787 }
1788
1789 1. \ **Get Server**
1790
1791 +---------------------+-------------------------------------------------------------------------------------------+
1792 | **IF Definition**   | **Description**                                                                           |
1793 +=====================+===========================================================================================+
1794 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1795 +---------------------+-------------------------------------------------------------------------------------------+
1796 | Operation           | get                                                                                       |
1797 +---------------------+-------------------------------------------------------------------------------------------+
1798 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1799 +---------------------+-------------------------------------------------------------------------------------------+
1800
1801 1. \ **Request**
1802
1803 N/A
1804
1805 1. \ **Response**
1806
1807 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1808 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1809 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1810 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1811 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1812 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1813 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1814 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1815 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1816 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1817 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1818 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1819 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1820 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1821 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1822 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1823 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1824 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1825 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1826 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1827 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1828 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1829 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1830 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1831 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1832 | **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.**   |
1833 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1834 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1835 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1836 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1837 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1838 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1839 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1840
1841 200: ok
1842
1843 500: failed
1844
1845 {
1846
1847 }
1848
1849 1. \ **Flavor Management**
1850
1851    1. \ **Create Flavor**
1852
1853 +---------------------+--------------------------------------------------------------------------------+
1854 | **IF Definition**   | **Description**                                                                |
1855 +=====================+================================================================================+
1856 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors   |
1857 +---------------------+--------------------------------------------------------------------------------+
1858 | Operation           | POST                                                                           |
1859 +---------------------+--------------------------------------------------------------------------------+
1860 | Direction           | VNFLCM->MULTIVIM                                                               |
1861 +---------------------+--------------------------------------------------------------------------------+
1862
1863 1. \ **Request**
1864
1865 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1866 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1867 +=================+=================+===================+===============================+==============================================================================================================================+
1868 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1869 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1870 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1871 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1872 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1873 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1874 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1875 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1876 | ephemeral       | O               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1877 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1878 | swap            | O               | 1                 | int                           | The size of the swap disk                                                                                                    |
1879 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1880 | 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.   |
1881 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1882 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1883 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1884
1885 1. \ **Response**
1886
1887 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1888 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                                              |
1889 +=================+=================+===================+===========================+==============================================================================================================================+
1890 | id              | M               | 1                 | string                    | Flavor id                                                                                                                    |
1891 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1892 | name            | M               | 1                 | string                    | Flavor name                                                                                                                  |
1893 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1894 | returnCode      | M               | 1                 | int                       | 0: Already exist 1: Newly created                                                                                            |
1895 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1896 | tenantId        | M               | 1                 | String                    | Tenant UUID                                                                                                                  |
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       | M               | 1                 | int                       | The size of the ephemeral disk                                                                                               |
1905 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1906 | swap            | M               | 1                 | int                       | The size of the swap disk                                                                                                    |
1907 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1908 | 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.   |
1909 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1910 | extraSpecs      | O               | 0..N              | List of Key-value pairs   | EPA parameter                                                                                                                |
1911 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1912 | vimId           | M               | 1                 | String                    | vim id                                                                                                                       |
1913 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1914 | vimName         | O               | 1                 | string                    | vim name                                                                                                                     |
1915 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1916
1917 1. \ **Delete Flavor**
1918
1919 +---------------------+--------------------------------------------------------------------------------------------+
1920 | **IF Definition**   | **Description**                                                                            |
1921 +=====================+============================================================================================+
1922 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid}   |
1923 +---------------------+--------------------------------------------------------------------------------------------+
1924 | Operation           | DELETE                                                                                     |
1925 +---------------------+--------------------------------------------------------------------------------------------+
1926 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                      |
1927 +---------------------+--------------------------------------------------------------------------------------------+
1928
1929 1. \ **Request**
1930
1931 N/A
1932
1933 1. \ **Response**
1934
1935 204: no content
1936
1937 1. \ **List Flavor**
1938
1939 +---------------------+---------------------------------------------------------------------------------+
1940 | **IF Definition**   | **Description**                                                                 |
1941 +=====================+=================================================================================+
1942 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors   |
1943 +---------------------+---------------------------------------------------------------------------------+
1944 | Operation           | get                                                                             |
1945 +---------------------+---------------------------------------------------------------------------------+
1946 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
1947 +---------------------+---------------------------------------------------------------------------------+
1948
1949 1. \ **Query**
1950
1951 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1952 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                  |
1953 +=================+=================+===================+===============+==================================+
1954 | name            | M               | 1                 | string        | Flavor name to filter out list   |
1955 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1956
1957 1. \ **Response**
1958
1959 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1960 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1961 +=================+=================+===================+===============================+==============================================================================================================================+
1962 | flavors         | M               | 0..N              | list                          | Vm list                                                                                                                      |
1963 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1964 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
1965 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1966 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1967 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1968 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1969 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1970 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1971 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1972 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1973 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1974 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1975 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1976 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
1977 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1978 | 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.   |
1979 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1980 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1981 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1982 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
1983 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1984 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
1985 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1986 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
1987 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1988
1989 200: ok
1990
1991 500: failed
1992
1993 1. \ **Get Flavor**
1994
1995 +---------------------+----------------------------------------------------------------------------------------------+
1996 | **IF Definition**   | **Description**                                                                              |
1997 +=====================+==============================================================================================+
1998 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid }   |
1999 +---------------------+----------------------------------------------------------------------------------------------+
2000 | Operation           | get                                                                                          |
2001 +---------------------+----------------------------------------------------------------------------------------------+
2002 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                        |
2003 +---------------------+----------------------------------------------------------------------------------------------+
2004
2005 1. \ **Request**
2006
2007 N/A
2008
2009 1. \ **Response**
2010
2011 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2012 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
2013 +=================+=================+===================+===============================+==============================================================================================================================+
2014 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
2015 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2016 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
2017 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2018 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
2019 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2020 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
2021 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2022 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
2023 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2024 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
2025 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2026 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
2027 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2028 | 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.   |
2029 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2030 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
2031 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2032 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
2033 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2034 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
2035 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2036 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
2037 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2038
2039 200: ok
2040
2041 500: failed
2042
2043 1. \ **Volume Management**
2044
2045    1. \ **Create Volume**
2046
2047 +---------------------+--------------------------------------------------------------------------------+
2048 | **IF Definition**   | **Description**                                                                |
2049 +=====================+================================================================================+
2050 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2051 +---------------------+--------------------------------------------------------------------------------+
2052 | Operation           | POST                                                                           |
2053 +---------------------+--------------------------------------------------------------------------------+
2054 | Direction           | NSLCM->MULTIVIM                                                                |
2055 +---------------------+--------------------------------------------------------------------------------+
2056
2057 1. \ **Request**
2058
2059 +--------------------+-----------------+-------------------+---------------+-------------------+
2060 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2061 +====================+=================+===================+===============+===================+
2062 | name               | M               | 1                 | string        | Volume name       |
2063 +--------------------+-----------------+-------------------+---------------+-------------------+
2064 | volumeSize         | M               | 1                 | int           | Volume size       |
2065 +--------------------+-----------------+-------------------+---------------+-------------------+
2066 | imageId            | O               | 1                 | string        | Image UUID        |
2067 +--------------------+-----------------+-------------------+---------------+-------------------+
2068 | volumeType         | O               | 1                 | string        | Volume type       |
2069 +--------------------+-----------------+-------------------+---------------+-------------------+
2070 | availabilityZone   | O               | 1                 | string        | Usable field      |
2071 +--------------------+-----------------+-------------------+---------------+-------------------+
2072
2073     {
2074
2075     "tenant": "tenant1",
2076
2077     "volumeName": "volume1",
2078
2079     "volumeSize": 3,
2080
2081     "imageName": "cirros.qcow2",
2082
2083     "volumeType": "volumetype1",
2084
2085     "availabilityZone": "zone1"
2086
2087     }
2088
2089 1. \ **Response**
2090
2091 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2092 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2093 +====================+=================+===================+===============+=====================================+
2094 | returnCode         | M               | 1                 | int           | 0: Already exist 1: Newly created   |
2095 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2096 | vimId              | M               | 1                 | String        | vim id                              |
2097 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2098 | vimName            | O               | 1                 | string        | vim name                            |
2099 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2100 | tenantId           | M               | 1                 | String        | Tenant UUID                         |
2101 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2102 | status             | M               | 1                 | string        | Volume status                       |
2103 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2104 | id                 | M               | 1                 | string        | Volume id                           |
2105 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2106 | name               | M               | 1                 | string        | Volume name                         |
2107 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2108 | volumeType         | O               | 1                 | string        | Volume type                         |
2109 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2110 | availabilityZone   | O               | 1                 | string        | Availability Zone                   |
2111 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2112
2113 202: accepted
2114
2115 500: failed
2116
2117     {
2118
2119     "id": "bc9eebdbbfd356458269340b9ea6fb73",
2120
2121     "name": "volume1",
2122
2123     "returnCode": 1,
2124
2125     }
2126
2127 1. \ **Delete Volume**
2128
2129 +---------------------+-------------------------------------------------------------------------------------------+
2130 | **IF Definition**   | **Description**                                                                           |
2131 +=====================+===========================================================================================+
2132 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId}   |
2133 +---------------------+-------------------------------------------------------------------------------------------+
2134 | Operation           | DELETE                                                                                    |
2135 +---------------------+-------------------------------------------------------------------------------------------+
2136 | Direction           | NSLCM->MULTIVIM                                                                           |
2137 +---------------------+-------------------------------------------------------------------------------------------+
2138
2139 1. \ **Request**
2140
2141     N/A
2142
2143 1. \ **Response**
2144
2145     204: no content
2146
2147 1. \ **List Volumes**
2148
2149 +---------------------+--------------------------------------------------------------------------------+
2150 | **IF Definition**   | **Description**                                                                |
2151 +=====================+================================================================================+
2152 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2153 +---------------------+--------------------------------------------------------------------------------+
2154 | Operation           | GET                                                                            |
2155 +---------------------+--------------------------------------------------------------------------------+
2156 | Direction           | NSLCM-> MULTIVIM                                                               |
2157 +---------------------+--------------------------------------------------------------------------------+
2158
2159 1. \ **Request**
2160
2161     msb.onap.org:80/api/multicloud/v0/{cloud
2162     owner}\_{region}/volumes?{……}
2163
2164 +-----------------+-----------------+-------------------+---------------+-------------------+
2165 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2166 +=================+=================+===================+===============+===================+
2167 | name            | M               | 1                 | string        | Volume name       |
2168 +-----------------+-----------------+-------------------+---------------+-------------------+
2169
2170 1. \ **Response**
2171
2172 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2173 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2174 +====================+=================+===================+======================+====================================================+
2175 | vimId              | M               | 1                 | String               | vim id                                             |
2176 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2177 | vimName            | O               | 1                 | string               | vim name                                           |
2178 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2179 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2180 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2181 | volumes            | M               | 1                 | Array                |                                                    |
2182 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2183 | id                 | M               | 1                 | string               | Volume id                                          |
2184 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2185 | name               | M               | 1                 | string               | Volume name                                        |
2186 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2187 | createTime         | O               | 1                 | string               | Create time                                        |
2188 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2189 | status             | M               | 1                 | string               | Volume status                                      |
2190 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2191 | volumeSize         | M               | 1                 | int                  | Volume size                                        |
2192 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2193 | volumeType         | M               | 1                 | string               | Volume type                                        |
2194 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2195 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2196 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2197 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2198 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2199
2200 200: ok
2201
2202 500: failed
2203
2204     {
2205
2206     "volumes": [
2207
2208     {
2209
2210     "status": "available",
2211
2212     "name": "test",
2213
2214     "attachments": [],
2215
2216     "createTime": "2015-12-02T07:57:23.000000",
2217
2218     " volumeType ": "ws",
2219
2220     "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2221
2222     "size": 20
2223
2224     },
2225
2226     {
2227
2228     "status": "in-use",
2229
2230     "name": "wangsong",
2231
2232     "attachments": [
2233
2234     {
2235
2236     "device": "/dev/vdc",
2237
2238     "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2239
2240     "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2241
2242     "hostName": null,
2243
2244     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2245
2246     }
2247
2248     ],
2249
2250     "createTime": "2015-12-02T06:39:40.000000",
2251
2252     " volumeType ": null,
2253
2254     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2255
2256     "size": 40
2257
2258     }
2259
2260     ]
2261
2262     }
2263
2264 1. \ **Get Volumes**
2265
2266 +---------------------+-------------------------------------------------------------------------------------------+
2267 | **IF Definition**   | **Description**                                                                           |
2268 +=====================+===========================================================================================+
2269 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid}   |
2270 +---------------------+-------------------------------------------------------------------------------------------+
2271 | Operation           | GET                                                                                       |
2272 +---------------------+-------------------------------------------------------------------------------------------+
2273 | Direction           | NSLCM-> MULTIVIM                                                                          |
2274 +---------------------+-------------------------------------------------------------------------------------------+
2275
2276 1. \ **Request**
2277
2278     N/A
2279
2280 1. \ **Response**
2281
2282 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2283 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2284 +====================+=================+===================+======================+====================================================+
2285 | vimId              | M               | 1                 | String               | vim id                                             |
2286 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2287 | vimName            | O               | 1                 | string               | vim name                                           |
2288 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2289 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2290 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2291 | id                 |                 | 1                 | string               | Volume id                                          |
2292 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2293 | name               |                 | 1                 | string               | Volume name                                        |
2294 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2295 | createTime         |                 | 1                 | string               | Create time                                        |
2296 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2297 | status             |                 | 1                 | string               | Volume status                                      |
2298 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2299 | volumeType         |                 | 1                 | list of string       | Volume type                                        |
2300 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2301 | volumeSize         |                 | 1                 | int                  | Volume size                                        |
2302 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2303 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2304 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2305 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2306 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2307
2308 **attachment：**
2309
2310 +-----------------+-----------------+-------------------+---------------+-------------------+
2311 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2312 +=================+=================+===================+===============+===================+
2313 | device          |                 | 1                 | string        | Device name       |
2314 +-----------------+-----------------+-------------------+---------------+-------------------+
2315 | serverId        |                 | 1                 | string        | VM id             |
2316 +-----------------+-----------------+-------------------+---------------+-------------------+
2317 | volumeId        |                 | 1                 | string        | Volume id         |
2318 +-----------------+-----------------+-------------------+---------------+-------------------+
2319 | hostName        |                 | 1                 | string        | Host name         |
2320 +-----------------+-----------------+-------------------+---------------+-------------------+
2321 | id              |                 | 1                 | string        | Device id         |
2322 +-----------------+-----------------+-------------------+---------------+-------------------+
2323
2324 200: ok
2325
2326 500: failed
2327
2328     {
2329
2330     "status": "in-use",
2331
2332     "name": "wangsong",
2333
2334     "attachments": [
2335
2336     {
2337
2338     "device": "/dev/vdc",
2339
2340     "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2341
2342     "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2343
2344     "hostName": null,
2345
2346     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2347
2348     }
2349
2350     ],
2351
2352     "createTime": "2015-12-02T06:39:40.000000",
2353
2354     "volumeType ": null,
2355
2356     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2357
2358     "volumeSize ": 40
2359
2360     }
2361
2362 1. \ **Tenant Management**
2363
2364    1. \ **List tenants**
2365
2366 +---------------------+---------------------------------------------------------------------+
2367 | **IF Definition**   | **Description**                                                     |
2368 +=====================+=====================================================================+
2369 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants   |
2370 +---------------------+---------------------------------------------------------------------+
2371 | Operation           | GET                                                                 |
2372 +---------------------+---------------------------------------------------------------------+
2373 | Direction           | NSLCM-> MULTIVIM                                                    |
2374 +---------------------+---------------------------------------------------------------------+
2375
2376 1. \ **Query**
2377
2378 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2379 | **Parameter**       | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2380 +=====================+=================+===================+===============+=====================================+
2381 | name={tenantname}   | O               | 1                 | string        | Tenant name to filter output list   |
2382 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2383
2384 1. \ **Response**
2385
2386 +-----------------+-----------------+-------------------+---------------+-------------------+
2387 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2388 +=================+=================+===================+===============+===================+
2389 | vimId           | M               | 1                 | String        | vim id            |
2390 +-----------------+-----------------+-------------------+---------------+-------------------+
2391 | vimName         | O               | 1                 | string        | vim name          |
2392 +-----------------+-----------------+-------------------+---------------+-------------------+
2393 | tenants         | M               | 1                 | Array         |                   |
2394 +-----------------+-----------------+-------------------+---------------+-------------------+
2395 | id              | M               | 1                 | string        | tenant UUID       |
2396 +-----------------+-----------------+-------------------+---------------+-------------------+
2397 | name            | M               | 1                 | string        | tenant name       |
2398 +-----------------+-----------------+-------------------+---------------+-------------------+
2399
2400 200: ok
2401
2402 500: failed
2403
2404     {
2405
2406     " tenants ": [
2407
2408     {
2409
2410     "id": "1",
2411
2412     "name": "test\_a"
2413
2414     }
2415
2416     ]
2417
2418     }
2419
2420 1. \ **Limits**
2421
2422    1. \ **List Limits of resouces: CPU&Memory, volume,network,etc**
2423
2424 +---------------------+-------------------------------------------------------------------------------+
2425 | **IF Definition**   | **Description**                                                               |
2426 +=====================+===============================================================================+
2427 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits   |
2428 +---------------------+-------------------------------------------------------------------------------+
2429 | Operation           | GET                                                                           |
2430 +---------------------+-------------------------------------------------------------------------------+
2431 | Direction           | NSLCM-> MULTIVIM                                                              |
2432 +---------------------+-------------------------------------------------------------------------------+
2433
2434 1. \ **Request**
2435
2436 2. \ **Response**
2437
2438 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2439 | **Parameter**             | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                  |
2440 +===========================+=================+===================+===============+==================================================================+
2441 | vimId                     | M               | 1                 | String        | vim id                                                           |
2442 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2443 | vimName                   | O               | 1                 | string        | vim name                                                         |
2444 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2445 | tenantId                  | M               | 1                 | string        | Tenant UUID                                                      |
2446 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2447 | maxPersonality            | O               | 1                 | int           | The number of allowed injected files for each tenant.            |
2448 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2449 | maxPersonalitySize        | O               | 1                 | int           | The number of allowed bytes of content for each injected file.   |
2450 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2451 | maxServerGroupMembers     | O               | 1                 | int           | The number of allowed members for each server group.             |
2452 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2453 | maxServerGroups           | O               | 1                 | int           | The number of allowed server groups for each tenant.             |
2454 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2455 | maxServerMeta             | O               | 1                 | int           | The number of allowed metadata items for each instance.          |
2456 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2457 | maxTotalCores             | O               | 1                 | int           | The number of allowed instance cores for each tenant.            |
2458 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2459 | maxTotalInstances         | O               | 1                 | int           | The number of allowed instances for each tenant.                 |
2460 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2461 | maxTotalKeypairs          | O               | 1                 | int           | The number of allowed key pairs for each user.                   |
2462 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2463 | maxTotalRAMSize           | O               | 1                 | int           | The amount of allowed instance RAM, in MB, for each tenant.      |
2464 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2465 | maxTotalVolumeGigabytes   | O               | 1                 | int           | The maximum total amount of volumes, in gibibytes (GiB).         |
2466 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2467 | maxTotalVolumes           | O               | 1                 | int           | The maximum number of volumes.                                   |
2468 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2469 | totalVolumesUsed          | O               | 1                 | int           | The total number of volumes used.                                |
2470 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2471 | totalGigabytesUsed        | O               | 1                 | int           | The total number of gibibytes (GiB) used.                        |
2472 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2473 | network                   | O               | 1                 | int           | The number of networks allowed for each project.                 |
2474 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2475 | subnet                    | O               | 1                 | int           | The number of subnets allowed for each project.                  |
2476 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2477 | subnetpool                | O               | 1                 | int           | The number of subnet pools allowed for each project.             |
2478 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2479 | security\_group\_rule     | O               | 1                 | int           | The number of security group rules allowed for each project.     |
2480 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2481 | security\_group           | O               | 1                 | int           | The number of security groups allowed for each project.          |
2482 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2483 | router                    | O               | 1                 | int           | The number of routers allowed for each project.                  |
2484 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2485 | port                      | O               | 1                 | int           | The number of ports allowed for each project.                    |
2486 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2487
2488 200: ok
2489
2490 500: failed
2491
2492     {
2493
2494     "maxPersonality": 5,
2495
2496     "maxPersonalitySize": 10240,
2497
2498     "maxServerMeta": 128,
2499
2500     "maxTotalCores": 20,
2501
2502     "maxTotalInstances": 10,
2503
2504     "maxTotalKeypairs": 100,
2505
2506     "maxTotalRAMSize": 51200,
2507
2508     "maxServerGroups": 10,
2509
2510     "maxServerGroupMembers": 10,
2511
2512     }
2513
2514 1. \ **Host Management**
2515
2516    1. \ **List hosts**
2517
2518 +---------------------+------------------------------------------------------------------------------+
2519 | **IF Definition**   | **Description**                                                              |
2520 +=====================+==============================================================================+
2521 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts   |
2522 +---------------------+------------------------------------------------------------------------------+
2523 | Operation           | GET                                                                          |
2524 +---------------------+------------------------------------------------------------------------------+
2525 | Direction           | NSLCM-> MULTIVIM                                                             |
2526 +---------------------+------------------------------------------------------------------------------+
2527
2528 1. \ **Request**
2529
2530 2. \ **Response**
2531
2532 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2533 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**     | **Description**                   |
2534 +=================+=================+===================+=================+===================================+
2535 | vimId           | M               | 1                 | String          | vim id                            |
2536 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2537 | vimName         | O               | 1                 | string          | vim name                          |
2538 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2539 | tenantId        | M               | 1                 | string          | Tenant Name                       |
2540 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2541 | hosts           | M               | 1                 | Array of host   | List of host information          |
2542 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2543 | service         | M               | 1                 | string          | The service running on the host   |
2544 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2545 | name            | M               | 1                 | string          | host name                         |
2546 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2547 | zone            | O               | 1                 | string          | Available zone for the host       |
2548 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2549
2550 200: ok
2551
2552 500: failed
2553
2554     {
2555
2556     "vimId": "123",
2557
2558     "vimName": "vimName",
2559
2560     "tenantId": "tenantId1"
2561
2562     "hosts": [
2563
2564     {
2565
2566     "name": "b6e4adbc193d428ea923899d07fb001e",
2567
2568     "service": "conductor",
2569
2570     "zone": "internal",
2571
2572     "vimId": "123",
2573
2574     "vimName": "vimName",
2575
2576     "tenantId": "tenantId1"
2577
2578     },
2579
2580     {
2581
2582     "name": "09c025b0efc64211bd23fc50fa974cdf",
2583
2584     "service": "compute",
2585
2586     "zone": "nova"
2587
2588     "vimId": "123",
2589
2590     "vimName": "vimName",
2591
2592     "tenantId": "tenantId1"
2593
2594     },
2595
2596     {
2597
2598     "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2599
2600     "service": "consoleauth",
2601
2602     "zone": "internal"
2603
2604     "vimId": "123",
2605
2606     "vimName": "vimName",
2607
2608     "tenantId": "tenantId1"
2609
2610     },
2611
2612     {
2613
2614     "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2615
2616     "service": "network",
2617
2618     "zone": "internal"
2619
2620     "vimId": "123",
2621
2622     "vimName": "vimName",
2623
2624     "tenantId": "tenantId1"
2625
2626     },
2627
2628     {
2629
2630     "name": "abffda96592c4eacaf4111c28fddee17",
2631
2632     "service": "scheduler",
2633
2634     "zone": "internal"
2635
2636     "vimId": "123",
2637
2638     "vimName": "vimName",
2639
2640     "tenantId": "tenantId1"
2641
2642     }
2643
2644     ]
2645
2646     }
2647
2648 1. \ **Get host**
2649
2650 +---------------------+-----------------------------------------------------------------------------------------+
2651 | **IF Definition**   | **Description**                                                                         |
2652 +=====================+=========================================================================================+
2653 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts/{hostname}   |
2654 +---------------------+-----------------------------------------------------------------------------------------+
2655 | Operation           | GET                                                                                     |
2656 +---------------------+-----------------------------------------------------------------------------------------+
2657 | Direction           | NSLCM-> MULTIVIM                                                                        |
2658 +---------------------+-----------------------------------------------------------------------------------------+
2659
2660 1. \ **Request**
2661
2662 2. \ **Response**
2663
2664 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2665 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**         | **Description**                                              |
2666 +=================+=================+===================+=====================+==============================================================+
2667 | vimId           | M               | 1                 | String              | vim id                                                       |
2668 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2669 | vimName         | O               | 1                 | string              | vim name                                                     |
2670 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2671 | tenantId        | M               | 1                 | string              | Tenant Name                                                  |
2672 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2673 | host            | M               | 1                 | List of resources   | Host resource info                                           |
2674 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2675 | resource        | M               | 1..N              | Object              | Resource description                                         |
2676 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2677 | cpu             | M               | 1                 | Int                 | The cpu info on the host.                                    |
2678 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2679 | memory\_mb      | M               | 1                 | int                 | The memory info on the host (in MB).                         |
2680 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2681 | name            | M               | 1                 | string              | host name                                                    |
2682 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2683 | project         | M               | 1                 | string              | Value: total, used\_now, used\_max or specific project\_id   |
2684 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2685 | disk\_gb        | M               | 1                 | int                 | The disk info on the host (in GB).                           |
2686 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2687
2688 200: ok
2689
2690 500: failed
2691
2692 {
2693
2694 "cpu": 1,
2695
2696 "disk\_gb": 1028,
2697
2698 "name": "c1a7de0ac9d94e4baceae031d05caae3",
2699
2700 "memory\_mb": 8192,
2701
2702 "vimId": "123",
2703
2704 "vimName": "vimName",
2705
2706 "tenantId": "tenantId1"
2707
2708 }
2709
2710     {
2711
2712     "host": [
2713
2714     {
2715
2716     "memory\_mb": 4960,
2717
2718     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2719
2720     "disk\_gb": 92,
2721
2722     "project": "(total)",
2723
2724     "cpu": 4
2725
2726     },
2727
2728     {
2729
2730     "memory\_mb": 1536,
2731
2732     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2733
2734     "disk\_gb": 2,
2735
2736     "project": "(used\_now)",
2737
2738     "cpu": 2
2739
2740     },
2741
2742     {
2743
2744     "memory\_mb": 1024,
2745
2746     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2747
2748     "disk\_gb": 2,
2749
2750     "project": "(used\_max)",
2751
2752     "cpu": 2
2753
2754     },
2755
2756     {
2757
2758     "memory\_mb": 1024,
2759
2760     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2761
2762     "disk\_gb": 2,
2763
2764     "project": "568f7ec425db472ba348251bf1e7eebd",
2765
2766     "cpu": 2
2767
2768     }
2769
2770     ],
2771
2772     "vimName": "openstack\_newton",
2773
2774     "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2775
2776     "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2777
2778     }
2779
2780 1. \ **VIM Management**
2781
2782    1. \ **Update VIM Info**
2783
2784 +---------------------+----------------------------------------------------------------------------------------------+
2785 | **IF Definition**   | **Description**                                                                              |
2786 +=====================+==============================================================================================+
2787 | URI                 | http(s)://[hostname][:port]/onapapi/ multicloud /v1/{cloud-owner}\_{cloud-region}/registry   |
2788 +---------------------+----------------------------------------------------------------------------------------------+
2789 | Operation           | POST                                                                                         |
2790 +---------------------+----------------------------------------------------------------------------------------------+
2791 | Direction           | ESR-> MULTICLOUD                                                                             |
2792 +---------------------+----------------------------------------------------------------------------------------------+
2793
2794 1. \ **Request**
2795
2796 +-----------------+-----------------+-------------------+---------------+-----------------------+
2797 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**       |
2798 +=================+=================+===================+===============+=======================+
2799 | defaultTenant   | M               | 1                 | string        | default tenant name   |
2800 +-----------------+-----------------+-------------------+---------------+-----------------------+
2801
2802 1. \ **Response**
2803
2804 NA
2805
2806 202: accept
2807
2808 400: failed
2809
2810 1. \ **Unregistry VIM**
2811
2812 +---------------------+-----------------------------------------------------------------------------------------------+
2813 | **IF Definition**   | **Description**                                                                               |
2814 +=====================+===============================================================================================+
2815 | URI                 | http(s)://[hostname][:port]/onapapi/multicloud/v1 /{cloud-owner}\_{cloud-region}/unregistry   |
2816 +---------------------+-----------------------------------------------------------------------------------------------+
2817 | Operation           | DELETE                                                                                        |
2818 +---------------------+-----------------------------------------------------------------------------------------------+
2819 | Direction           | ESR-> MULTICLOUD                                                                              |
2820 +---------------------+-----------------------------------------------------------------------------------------------+
2821
2822 1. \ **Request**
2823
2824 NA
2825
2826 1. \ **Response**
2827
2828 NA
2829
2830 204: No content found
2831
2832 400: failed