docs/MultiCloud-API-Specification-V1.rst

   1 ================================
   2 MultiCloud API Specification V1
   3 ================================
   4
   5 API Catalog
   6 ===========
   7
   8 `1. Scope 5 <#_Toc490851650>`__
   9
  10 `2. Terms, Definitions and Abbreviations 5 <#_Toc490851651>`__
  11
  12 `3. Image Management 5 <#_Toc490851652>`__
  13
  14 `3.1 Create Image 5 <#_Toc490851653>`__
  15
  16 `3.1.1 Request 5 <#_Toc490851654>`__
  17
  18 `3.1.2 Response 6 <#_Toc490851655>`__
  19
  20 `3.2 Delete Image 7 <#_Toc490851656>`__
  21
  22 `3.2.1 Request 7 <#_Toc490851657>`__
  23
  24 `3.2.2 Response 7 <#_Toc490851658>`__
  25
  26 `3.3 List Images 7 <#_Toc490851659>`__
  27
  28 `3.3.1 Request 7 <#_Toc490851660>`__
  29
  30 `3.3.2 Response 8 <#_Toc490851661>`__
  31
  32 `3.4 Get Image 9 <#_Toc490851662>`__
  33
  34 `3.4.1 Request 9 <#_Toc490851663>`__
  35
  36 `3.4.2 Response 9 <#_Toc490851664>`__
  37
  38 `4. Network Management 10 <#_Toc490851665>`__
  39
  40 `4.1 Create Network 10 <#_Toc490851666>`__
  41
  42 `4.1.1 Request 10 <#_Toc490851667>`__
  43
  44 `4.1.2 Response 11 <#_Toc490851668>`__
  45
  46 `4.2 Delete Network 12 <#_Toc490851669>`__
  47
  48 `4.2.1 Request 12 <#_Toc490851670>`__
  49
  50 `4.2.2 Response 12 <#_Toc490851671>`__
  51
  52 `4.3 List Network 12 <#_Toc490851672>`__
  53
  54 `4.3.1 Query 12 <#_Toc490851673>`__
  55
  56 `4.3.2 Response 13 <#_Toc490851674>`__
  57
  58 `4.4 Get Network 14 <#_Toc490851675>`__
  59
  60 `4.4.1 Request 14 <#_Toc490851676>`__
  61
  62 `4.4.2 Response 14 <#_Toc490851677>`__
  63
  64 `5. Subnetwork Management 16 <#_Toc490851678>`__
  65
  66 `5.1 Create Subnets 16 <#_Toc490851679>`__
  67
  68 `5.1.1 Request 16 <#_Toc490851680>`__
  69
  70 `5.1.2 Response 17 <#_Toc490851681>`__
  71
  72 `5.2 Delete Subnets 18 <#_Toc490851682>`__
  73
  74 `5.2.1 Request 18 <#_Toc490851683>`__
  75
  76 `5.2.2 Response 18 <#_Toc490851684>`__
  77
  78 `5.3 List Subnets 18 <#_Toc490851685>`__
  79
  80 `5.3.1 Query 18 <#_Toc490851686>`__
  81
  82 `5.3.2 Response 19 <#_Toc490851687>`__
  83
  84 `5.4 Get Subnets 20 <#_Toc490851688>`__
  85
  86 `5.4.1 Request 20 <#_Toc490851689>`__
  87
  88 `5.4.2 Response 20 <#_Toc490851690>`__
  89
  90 `6. Virtual Port 21 <#_Toc490851691>`__
  91
  92 `6.1 Create Virtual Port 21 <#_Toc490851692>`__
  93
  94 `6.1.1 Request 21 <#_Toc490851693>`__
  95
  96 `6.1.2 Response 22 <#_Toc490851694>`__
  97
  98 `6.2 Delete Virtual Port 22 <#_Toc490851695>`__
  99
 100 `6.2.1 Request 23 <#_Toc490851696>`__
 101
 102 `6.2.2 Response 23 <#_Toc490851697>`__
 103
 104 `6.3 List Virtual Port 23 <#_Toc490851698>`__
 105
 106 `6.3.1 Query 23 <#_Toc490851699>`__
 107
 108 `6.3.2 Response 23 <#_Toc490851700>`__
 109
 110 `6.4 Get Virtual Port 24 <#_Toc490851701>`__
 111
 112 `6.4.1 Request 24 <#_Toc490851702>`__
 113
 114 `6.4.2 Response 24 <#_Toc490851703>`__
 115
 116 `7. Server Management 25 <#_Toc490851704>`__
 117
 118 `7.1 Create Server 25 <#_Toc490851705>`__
 119
 120 `7.1.1 Request 25 <#_Toc490851706>`__
 121
 122 `7.1.2 Response 27 <#_Toc490851707>`__
 123
 124 `7.2 Delete Server 28 <#_Toc490851708>`__
 125
 126 `7.2.1 Request 28 <#_Toc490851709>`__
 127
 128 `7.2.2 Response 28 <#_Toc490851710>`__
 129
 130 `7.3 List Server 28 <#_Toc490851711>`__
 131
 132 `7.3.1 Request 28 <#_Toc490851712>`__
 133
 134 `7.3.2 Response 29 <#_Toc490851713>`__
 135
 136 `7.4 Get Server 29 <#_Toc490851714>`__
 137
 138 `7.4.1 Request 30 <#_Toc490851715>`__
 139
 140 `7.4.2 Response 30 <#_Toc490851716>`__
 141
 142 `8. Flavor Management 30 <#_Toc490851717>`__
 143
 144 `8.1 Create Flavor 31 <#_Toc490851718>`__
 145
 146 `8.1.1 Request 31 <#_Toc490851719>`__
 147
 148 `8.1.2 Response 31 <#_Toc490851720>`__
 149
 150 `8.2 Delete Flavor 32 <#_Toc490851721>`__
 151
 152 `8.2.1 Request 32 <#_Toc490851722>`__
 153
 154 `8.2.2 Response 32 <#_Toc490851723>`__
 155
 156 `8.3 List Flavor 32 <#_Toc490851724>`__
 157
 158 `8.3.1 Query 32 <#_Toc490851725>`__
 159
 160 `8.3.2 Response 32 <#_Toc490851726>`__
 161
 162 `8.4 Get Flavor 33 <#_Toc490851727>`__
 163
 164 `8.4.1 Request 33 <#_Toc490851728>`__
 165
 166 `8.4.2 Response 33 <#_Toc490851729>`__
 167
 168 `9. Volume Management 34 <#_Toc490851730>`__
 169
 170 `9.1 Create Volume 34 <#_Toc490851731>`__
 171
 172 `9.1.1 Request 34 <#_Toc490851732>`__
 173
 174 `9.1.2 Response 34 <#_Toc490851733>`__
 175
 176 `9.2 Delete Volume 35 <#_Toc490851734>`__
 177
 178 `9.2.1 Request 35 <#_Toc490851735>`__
 179
 180 `9.2.2 Response 35 <#_Toc490851736>`__
 181
 182 `9.3 List Volumes 35 <#_Toc490851737>`__
 183
 184 `9.3.1 Request 35 <#_Toc490851738>`__
 185
 186 `9.3.2 Response 36 <#_Toc490851739>`__
 187
 188 `9.4 Get Volumes 37 <#_Toc490851740>`__
 189
 190 `9.4.1 Request 37 <#_Toc490851741>`__
 191
 192 `9.4.2 Response 37 <#_Toc490851742>`__
 193
 194 `10. Tenant Management 38 <#_Toc490851743>`__
 195
 196 `10.1 List tenants 38 <#_Toc490851744>`__
 197
 198 `10.1.1 Query 38 <#_Toc490851745>`__
 199
 200 `10.1.2 Response 38 <#_Toc490851746>`__
 201
 202 `11. Limits 39 <#_Toc490851747>`__
 203
 204 `11.1 List Limits of resouces: CPU&Memory, volume,network,etc
 205 39 <#_Toc490851748>`__
 206
 207 `11.1.1 Request 39 <#_Toc490851749>`__
 208
 209 `11.1.2 Response 39 <#_Toc490851750>`__
 210
 211 `12. Host Management 41 <#_Toc490851751>`__
 212
 213 `12.1 List hosts 41 <#_Toc490851752>`__
 214
 215 `12.1.1 Request 41 <#_Toc490851753>`__
 216
 217 `12.1.2 Response 41 <#_Toc490851754>`__
 218
 219 `12.2 Get host 43 <#_Toc490851755>`__
 220
 221 `12.2.1 Request 43 <#_Toc490851756>`__
 222
 223 `12.2.2 Response 43 <#_Toc490851757>`__
 224
 225 `13. VIM Management 45 <#_Toc490851758>`__
 226
 227 `13.1 Update VIM Info 45 <#_Toc490851759>`__
 228
 229 `13.1.1 Request 45 <#_Toc490851760>`__
 230
 231 `13.1.2 Response 45 <#_Toc490851761>`__
 232
 233 `13.2 Unregistry VIM 45 <#_Toc490851762>`__
 234
 235 `13.2.1 Request 45 <#_Toc490851763>`__
 236
 237 `13.2.2 Response 46 <#_Toc490851764>`__
 238
 239 *
 240 *
 241
 242 1. \ **Scope**
 243
 244 The scope of the present document is to describe the VIM Driver API
 245 specification.
 246
 247 1. \ **Terms, Definitions and Abbreviations**
 248
 249 For the purposes of the present document, the following abbreviations
 250 apply:
 251
 252 +--------------------+-------------------------------------------------------------+
 253 | **Abbreviation**   |                                                             |
 254 +====================+=============================================================+
 255 | NFVO               | Network Functions Virtualization Orchestrator               |
 256 +--------------------+-------------------------------------------------------------+
 257 | VNFM               | Virtual Network Function Management                         |
 258 +--------------------+-------------------------------------------------------------+
 259 | VIM                | Virtualized Infrastructure Manager                          |
 260 +--------------------+-------------------------------------------------------------+
 261 | MultiVIM           | MultVIM driver services for OPEN-O to drive VIM instances   |
 262 +--------------------+-------------------------------------------------------------+
 263
 264 Table 2-1 abbreviations
 265
 266 1. \ **Image Management**
 267
 268    1. \ **Create Image**
 269
 270 +---------------------+-------------------------------------------------------------------------------+
 271 | **IF Definition**   | **Description**                                                               |
 272 +=====================+===============================================================================+
 273 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images   |
 274 +---------------------+-------------------------------------------------------------------------------+
 275 | Operation           | POST                                                                          |
 276 +---------------------+-------------------------------------------------------------------------------+
 277 | Direction           | NSLCM->MULTIVIM                                                               |
 278 +---------------------+-------------------------------------------------------------------------------+
 279 | Description         | Create Image and Upload the image file to the VIM                             |
 280 +---------------------+-------------------------------------------------------------------------------+
 281
 282 1. \ **Request**
 283
 284 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 285 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                  |
 286 +===================+=================+===================+===========================+==================================================================================================+
 287 | name              | M               | 1                 | String                    | Image Name                                                                                       |
 288 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 289 | imagePath         | M               | 1                 | String                    | Image Local Path from catalog                                                                    |
 290 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 291 | imageType         | M               | 1                 | String                    | Image Type                                                                                       |
 292 |                   |                 |                   |                           |                                                                                                  |
 293 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso                                             |
 294 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 295 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                                                           |
 296 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 297 | visibility        | O               | 1                 | string                    | Visibility for this image.                                                                       |
 298 |                   |                 |                   |                           |                                                                                                  |
 299 |                   |                 |                   |                           | public, private, shared, or community                                                            |
 300 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 301 | properties        | O               | 0..N              | List of key-value pairs   | Examples:--property vmware\_disktype=streamOptimized --property vmware\_adaptertype="lsiLogic"   |
 302 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
 303
 304 {
 305
 306 "imageName": "cirros",
 307
 308 "imagePath": "/home/cirros.qcow2",
 309
 310 "imageType": "qcow2"
 311
 312 “containerFormat”:”bare”
 313
 314 }
 315
 316 1. \ **Response**
 317
 318 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 319 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                        |
 320 +===================+=================+===================+===========================+========================================================+
 321 | id                | M               | 1                 | String                    | Image UUID in the VIM                                  |
 322 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 323 | name              | M               | 1                 | String                    | Image Name                                             |
 324 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 325 | returnCode        | M               | 1                 | Int                       | 0: Already exist 1: Newly created                      |
 326 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 327 | imageType         | M               | 1                 | String                    | Image Type                                             |
 328 |                   |                 |                   |                           |                                                        |
 329 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 330 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 331 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                 |
 332 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 333 | visibility        | O               | 1                 | string                    | Visibility for this image.                             |
 334 |                   |                 |                   |                           |                                                        |
 335 |                   |                 |                   |                           | public, private, shared, or community                  |
 336 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 337 | properties        | O               | 0..N              | List of key-value pairs   |                                                        |
 338 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 339 | vimid             | M               | 1                 | String                    | vim id                                                 |
 340 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 341 | vimName           | O               | 1                 | string                    | vim name                                               |
 342 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 343 | tenantId          | M               | 1                 | String                    | Tenant UUID                                            |
 344 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 345
 346 *202*: accepted
 347
 348 500: failed
 349
 350 {
 351
 352     “id”:” 3c9eebdbbfd345658269340b9ea6fb73”,
 353
 354     "name": "cirros",
 355
 356     "returnCode": 1
 357
 358 }
 359
 360 1. \ **Delete Image**
 361
 362 +---------------------+-----------------------------------------------------------------------------------------+
 363 | **IF Definition**   | **Description**                                                                         |
 364 +=====================+=========================================================================================+
 365 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageId}   |
 366 +---------------------+-----------------------------------------------------------------------------------------+
 367 | Operation           | Delete                                                                                  |
 368 +---------------------+-----------------------------------------------------------------------------------------+
 369 | Direction           | NSLCM->MULTIVIM                                                                         |
 370 +---------------------+-----------------------------------------------------------------------------------------+
 371 | Description         | Delete Image                                                                            |
 372 +---------------------+-----------------------------------------------------------------------------------------+
 373
 374 1. \ **Request**
 375
 376 N/A
 377
 378 1. \ **Response**
 379
 380 204: no content
 381
 382 1. \ **List Images**
 383
 384 +---------------------+-------------------------------------------------------------------------------+
 385 | **IF Definition**   | **Description**                                                               |
 386 +=====================+===============================================================================+
 387 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images   |
 388 +---------------------+-------------------------------------------------------------------------------+
 389 | Operation           | GET                                                                           |
 390 +---------------------+-------------------------------------------------------------------------------+
 391 | Direction           | NSLCM->MULTIVIM                                                               |
 392 +---------------------+-------------------------------------------------------------------------------+
 393 | Description         | Query Image list                                                              |
 394 +---------------------+-------------------------------------------------------------------------------+
 395
 396 1. \ **Request**
 397
 398 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……}
 399
 400 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 401 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                  |
 402 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
 403 | 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.   |
 404 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 405 | 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.                                                   |
 406 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 407 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of an image                                                                                                                                                                               |
 408 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 409
 410 1. \ **Response**
 411
 412 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 413 | \ **Parameter**                                 | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 414 +=================================================+=================+===================+===============+========================================================+
 415 | images                                          | M               | 0..N              | List          | Image List                                             |
 416 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 417 | id                                              | M               | 1                 | String        | Image ID                                               |
 418 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 419 | size                                            | M               | 1                 | int           | Image Size                                             |
 420 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 421 | name                                            | M               | 1                 | String        | Image Name                                             |
 422 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 423 | status                                          | M               | 1                 | String        | Image Status                                           |
 424 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 425 | imageType                                       | M               | 1                 | String        | Image Type                                             |
 426 |                                                 |                 |                   |               |                                                        |
 427 |                                                 |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 428 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 429 | containerFormat                                 | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 430 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 431 | visibility                                      | O               | 1                 | string        | Visibility for this image.                             |
 432 |                                                 |                 |                   |               |                                                        |
 433 |                                                 |                 |                   |               | public, private, shared, or community                  |
 434 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 435 | vimId                                           | M               | 1                 | String        | vim id                                                 |
 436 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 437 | vimName                                         | O               | 1                 | string        | vim name                                               |
 438 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 439 | tenantId                                        | M               | 1                 | String        | Tenant UUID                                            |
 440 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 441 | 200: ok                                         |                 |                   |
 442 |                                                 |                 |                   |
 443 | 500: failed                                     |                 |                   |
 444 |                                                 |                 |                   |
 445 | {                                               |                 |                   |
 446 |                                                 |                 |                   |
 447 |  “vimid”:””                                     |                 |                   |
 448 |                                                 |                 |                   |
 449 | “vimname”:””                                    |                 |                   |
 450 |                                                 |                 |                   |
 451 | "imageList": [                                  |                 |                   |
 452 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 453 | {                                               |                 |                   |
 454 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 455 | "status": "active",                             |                 |
 456 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 457 | "id": "5e2757c1-f846-4727-915c-9a872553ed75",   |
 458 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 459 | "size": 862016,                                 |                 |
 460 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 461 | "name": "vim-plus-cgsl40g-z.qcow2"              |
 462 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 463 | }                                               |                 |                   |
 464 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 465 | ]                                               |                 |                   |
 466 |                                                 |                 |                   |
 467 | }                                               |                 |                   |
 468 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 469
 470 1. \ **Get Image**
 471
 472 +---------------------+-----------------------------------------------------------------------------------------+
 473 | **IF Definition**   | **Description**                                                                         |
 474 +=====================+=========================================================================================+
 475 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid}   |
 476 +---------------------+-----------------------------------------------------------------------------------------+
 477 | Operation           | GET                                                                                     |
 478 +---------------------+-----------------------------------------------------------------------------------------+
 479 | Direction           | NSLCM->MULTIVIM                                                                         |
 480 +---------------------+-----------------------------------------------------------------------------------------+
 481 | Description         | Query Image Information                                                                 |
 482 +---------------------+-----------------------------------------------------------------------------------------+
 483
 484 1. \ **Request**
 485
 486 N/A
 487
 488 1. \ **Response**
 489
 490 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 491 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 492 +===================+=================+===================+===============+========================================================+
 493 | id                | M               | 1                 | String        | Image ID                                               |
 494 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 495 | size              | M               | 1                 | int           | Image Size                                             |
 496 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 497 | name              | M               | 1                 | String        | Image Name                                             |
 498 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 499 | status            | M               | 1                 | String        | Image Status                                           |
 500 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 501 | imageType         | M               | 1                 | String        | Image Type                                             |
 502 |                   |                 |                   |               |                                                        |
 503 |                   |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 504 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 505 | containerFormat   | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 506 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 507 | visibility        | O               | 1                 | string        | Visibility for this image.                             |
 508 |                   |                 |                   |               |                                                        |
 509 |                   |                 |                   |               | public, private, shared, or community                  |
 510 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 511 | vimId             | M               | 1                 | String        | vim id                                                 |
 512 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 513 | vimName           | M               | 1                 | string        | vim name                                               |
 514 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 515 | tenantId          | M               | 1                 | String        | Tenant UUID                                            |
 516 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 517
 518 200: ok
 519
 520 500: failed
 521
 522 {
 523
 524 “vimid”:””
 525
 526 “vimname”:””
 527
 528 "status": "active",
 529
 530 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
 531
 532 "size": 862016,
 533
 534 "name": "vim-plus-cgsl40g-z.qcow2"
 535
 536 a}
 537
 538 1. \ **Network Management**
 539
 540    1. \ **Create Network**
 541
 542 +---------------------+---------------------------------------------------------------------------------+
 543 | **IF Definition**   | **Description**                                                                 |
 544 +=====================+=================================================================================+
 545 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 546 +---------------------+---------------------------------------------------------------------------------+
 547 | Operation           | POST                                                                            |
 548 +---------------------+---------------------------------------------------------------------------------+
 549 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                          |
 550 +---------------------+---------------------------------------------------------------------------------+
 551 | Description         | Create network and subnetwork on the VIM                                        |
 552 +---------------------+---------------------------------------------------------------------------------+
 553
 554 1. \ **Request**
 555
 556 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 557 | **Parameter**               | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 558 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 559 | name                        | M               | 1                 | String        | Logical network name                                                                                                                                                                                                                                                                      |
 560 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 561 | shared                      | M               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 562 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 563 | vlanTransparent             | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 564 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 565 | networkType                 | O               | 1                 | String        | Network type                                                                                                                                                                                                                                                                              |
 566 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 567 |                             |                 |                   |               | flat, vlan, vxlan, gre,                                                                                                                                                                                                                                                                   |
 568 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 569 |                             |                 |                   |               | portgroup                                                                                                                                                                                                                                                                                 |
 570 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 571 | segmentationId              | O               | 1                 | Int           | id of paragraph                                                                                                                                                                                                                                                                           |
 572 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 573 | physicalNetwork             | O               | 1                 | string        | The physical network where this network should be implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each compute host.   |
 574 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 575 | routerExternal              | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 576 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 577 | {                           |                 |
 578 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 579 | “tenant”: “tenant1”,        |                 |
 580 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 581 | “networkName”: “ommnet”,    |
 582 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 583 | “shared”: 1,                |                 |
 584 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 585 | “vlanTransparent”: 1,       |                 |
 586 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 587 | “networkType”:”vlan”,       |                 |
 588 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 589 | “segmentationId”:202,       |                 |
 590 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 591 | “physicalNetwork”:”ctrl”,   |                 |
 592 |                             |                 |
 593 | “routerExternal”:0          |                 |
 594 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 595 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 596 | }                           |                 |
 597 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 598
 599 1. \ **Response**
 600
 601 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 602 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 603 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 604 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 605 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 606 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 607 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 608 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 609 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 610 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 611 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 612 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 613 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 614 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 615 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 616 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 617 | 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.   |
 618 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 619 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 620 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 621 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 622 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 623 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 624 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 625 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 626 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 627 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 628 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 629 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 630 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 631
 632 202: accepted
 633
 634 500: failed
 635
 636 {
 637
 638 “returnCode”:0,
 639
 640 “vimId”:”11111”,
 641
 642 “vimName”:”11111”,
 643
 644 “status”: “ACTIVE”,
 645
 646 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 647
 648 “name”: “net1”,
 649
 650 “tenant”: “tenant1”,
 651
 652 “networkName”: “ommnet”,
 653
 654 “shared”: 1,
 655
 656 “vlanTransparent”: 1,
 657
 658 “networkType”:”vlan”,
 659
 660 “segmentationId”:202,
 661
 662 “physicalNetwork ”:”ctrl”,
 663
 664 “routerExternal ”:0
 665
 666 }
 667
 668 1. \ **Delete Network**
 669
 670 +---------------------+---------------------------------------------------------------------------------------------+
 671 | **IF Definition**   | **Description**                                                                             |
 672 +=====================+=============================================================================================+
 673 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 674 +---------------------+---------------------------------------------------------------------------------------------+
 675 | Operation           | Delete                                                                                      |
 676 +---------------------+---------------------------------------------------------------------------------------------+
 677 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 678 +---------------------+---------------------------------------------------------------------------------------------+
 679
 680 1. \ **Request**
 681
 682 N/A
 683
 684 1. \ **Response**
 685
 686 204: no content
 687
 688 1. \ **List Network**
 689
 690 +---------------------+---------------------------------------------------------------------------------+
 691 | **IF Definition**   | **Description**                                                                 |
 692 +=====================+=================================================================================+
 693 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 694 +---------------------+---------------------------------------------------------------------------------+
 695 | Operation           | get                                                                             |
 696 +---------------------+---------------------------------------------------------------------------------+
 697 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
 698 +---------------------+---------------------------------------------------------------------------------+
 699
 700 1. \ **Query**
 701
 702 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 703 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                       |
 704 +=================+=================+===================+===============+=======================================================================================+
 705 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of a network   |
 706 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 707
 708 1. \ **Response**
 709
 710 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 711 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 712 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 713 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 714 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 715 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 716 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 717 | networks          |                 | 0..N              | List          | Network list                                                                                                                                                                                                                                                                              |
 718 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 719 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 720 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 721 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 722 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 723 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 724 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 725 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 726 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 727 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 728 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 729 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 730 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 731 | 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.   |
 732 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 733 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 734 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 735 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 736 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 737 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 738 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 739
 740 200: ok
 741
 742 500: failed
 743
 744 {
 745
 746 “vimId”:”11111”,
 747
 748 “vimName”:”111”,
 749
 750 “networks”:
 751
 752 [{
 753
 754 “status”: “ACTIVE”,
 755
 756 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 757
 758 “name”: “net1”,
 759
 760 “tenant”: “tenant1”,
 761
 762 “networkName”: “ommnet”,
 763
 764 “shared”: 1,
 765
 766 “vlanTransparent”: 1,
 767
 768 “networkType”:”vlan”,
 769
 770 “segmentationId”:202,
 771
 772 “physicalNetwork ”:”ctrl”,
 773
 774 “routerExternal ”:0
 775
 776 }]
 777
 778 }
 779
 780 PHYSICALNETWORK
 781
 782 1. \ **Get Network**
 783
 784 +---------------------+---------------------------------------------------------------------------------------------+
 785 | **IF Definition**   | **Description**                                                                             |
 786 +=====================+=============================================================================================+
 787 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 788 +---------------------+---------------------------------------------------------------------------------------------+
 789 | Operation           | get                                                                                         |
 790 +---------------------+---------------------------------------------------------------------------------------------+
 791 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 792 +---------------------+---------------------------------------------------------------------------------------------+
 793
 794 1. \ **Request**
 795
 796 N/A
 797
 798 1. \ **Response**
 799
 800 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 801 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 802 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 803 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 804 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 805 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 806 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 807 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 808 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 809 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 810 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 811 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 812 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 813 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 814 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 815 | 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.   |
 816 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 817 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 818 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 819 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 820 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 821 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 822 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 823 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 824 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 825 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 826 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 827 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 828 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 829
 830 200: ok
 831
 832 500: failed
 833
 834 {
 835
 836     “vimId”:”11111”,
 837
 838     “vimName”:”11111”,
 839
 840     “status”: “ACTIVE”,
 841
 842     “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 843
 844     “name”: “net1”,
 845
 846     “tenant”: “tenant1”,
 847
 848     “networkName”: “ommnet”,
 849
 850     “shared”: 1,
 851
 852     “vlanTransparent”: 1,
 853
 854     “networkType”:”vlan”,
 855
 856     “segmentationId”:202,
 857
 858     “physicalNetwork ”:”ctrl”,
 859
 860     “routerExternal ”:0
 861
 862 }
 863
 864 1. \ **Subnetwork Management**
 865
 866    1. \ **Create Subnets**
 867
 868 +---------------------+--------------------------------------------------------------------------------+
 869 | **IF Definition**   | **Description**                                                                |
 870 +=====================+================================================================================+
 871 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
 872 +---------------------+--------------------------------------------------------------------------------+
 873 | Operation           | POST                                                                           |
 874 +---------------------+--------------------------------------------------------------------------------+
 875 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                         |
 876 +---------------------+--------------------------------------------------------------------------------+
 877 | Description         | Create network and subnetwork on the VIM                                       |
 878 +---------------------+--------------------------------------------------------------------------------+
 879
 880 1. \ **Request**
 881
 882 +-------------------+-----------------+-------------------+------------------------+----------------------+
 883 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
 884 +===================+=================+===================+========================+======================+
 885 | networkId         | M               | 1                 | String                 | Network Id           |
 886 +-------------------+-----------------+-------------------+------------------------+----------------------+
 887 | name              | M               | 1                 | String                 | SubnetName           |
 888 +-------------------+-----------------+-------------------+------------------------+----------------------+
 889 | cidr              | M               | 1                 | String                 | Subnet cidr          |
 890 +-------------------+-----------------+-------------------+------------------------+----------------------+
 891 | ipVersion         | M               | 1                 | Int                    | Ip type              |
 892 |                   |                 |                   |                        |                      |
 893 |                   |                 |                   |                        | 4,6                  |
 894 +-------------------+-----------------+-------------------+------------------------+----------------------+
 895 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
 896 |                   |                 |                   |                        |                      |
 897 |                   |                 |                   |                        | 1: yes;0: no         |
 898 +-------------------+-----------------+-------------------+------------------------+----------------------+
 899 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
 900 +-------------------+-----------------+-------------------+------------------------+----------------------+
 901 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
 902 +-------------------+-----------------+-------------------+------------------------+----------------------+
 903 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
 904 +-------------------+-----------------+-------------------+------------------------+----------------------+
 905 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
 906 +-------------------+-----------------+-------------------+------------------------+----------------------+
 907 | -->allocation     |                 |                   |                        |                      |
 908 +-------------------+-----------------+-------------------+------------------------+----------------------+
 909 | -->start          | O               | 1                 | String                 | Start ip             |
 910 +-------------------+-----------------+-------------------+------------------------+----------------------+
 911 | -->end            | O               | 1                 | String                 | End ip               |
 912 +-------------------+-----------------+-------------------+------------------------+----------------------+
 913
 914 {
 915
 916 “tenant”: “tenant1”,
 917
 918 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
 919
 920 “subnetName”: “subnet1”,
 921
 922 “cidr”: “10.43.35.0/24”,
 923
 924 “ipVersion”: 4,
 925
 926 “enableDhcp”: 1,
 927
 928 “gatewayIp”: “10.43.35.1”,
 929
 930 “dnsNameservers”: [],
 931
 932 “allocationPools”:[{
 933
 934 “start”: “192.168.199.2”,
 935
 936 “end”: “192.168.199.254”
 937
 938 }],
 939
 940 “hostRoutes”: []
 941
 942 }
 943
 944 1. \ **Response**
 945
 946 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 947 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**                     |
 948 +===================+=================+===================+========================+=====================================+
 949 | returnCode        | M               | 1                 | int                    | 0: Already exist 1: Newly created   |
 950 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 951 | vimId             | M               | 1                 | String                 | vim id                              |
 952 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 953 | vimName           | O               | 1                 | string                 | vim name                            |
 954 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 955 | status            | M               | 1                 | string                 | subnetwork status                   |
 956 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 957 | id                | M               | 1                 | string                 | subNetwork id                       |
 958 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 959 | tenantId          | M               | 1                 | String                 | Tenant UUID                         |
 960 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 961 | networkId         | O               | 1                 | String                 | Network Id                          |
 962 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 963 | networkName       | O               | 1                 | String                 | Network Name                        |
 964 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 965 | name              | M               | 1                 | String                 | SubnetName                          |
 966 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 967 | cidr              | M               | 1                 | String                 | Subnet cidr                         |
 968 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 969 | ipVersion         | M               | 1                 | Int                    | Ip type                             |
 970 |                   |                 |                   |                        |                                     |
 971 |                   |                 |                   |                        | 4,6                                 |
 972 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 973 | enableDhcp        | O               | 1                 | boolean                | Whether to allow                    |
 974 |                   |                 |                   |                        |                                     |
 975 |                   |                 |                   |                        | 1: yes;0: no                        |
 976 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 977 | gatewayIp         | O               | 1                 | String                 | Gateway ip                          |
 978 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 979 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers                     |
 980 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 981 | hostRoutes        | O               | 1..n              | List of routes         | List of routes                      |
 982 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 983 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation                  |
 984 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 985 | -->allocation     |                 |                   |                        |                                     |
 986 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 987 | -->start          | O               | 1                 | String                 | Start ip                            |
 988 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 989 | -->end            | O               | 1                 | String                 | End ip                              |
 990 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 991
 992 202: accepted
 993
 994 500: failed
 995
 996 {
 997
 998     “returnCode”:0,
 999
1000     “vimId”:”11111”,
1001
1002     “vimName”:”11111”,
1003
1004 “status”:” ACTIVE”
1005
1006 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1007
1008 “tenant”: “tenant1”,
1009
1010 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1011
1012 “name”: “subnet1”,
1013
1014 “cidr”: “10.43.35.0/24”,
1015
1016 “ipVersion”: 4,
1017
1018 “enableDhcp”: 1,
1019
1020 “gatewayIp”: “10.43.35.1”,
1021
1022 “dnsNameservers”: [],
1023
1024 “allocationPools”:[{
1025
1026 “start”: “192.168.199.2”,
1027
1028 “end”: “192.168.199.254”
1029
1030 }],
1031
1032 “hostRoutes”: []
1033
1034 }
1035
1036 1. \ **Delete Subnets**
1037
1038 +---------------------+-------------------------------------------------------------------------------------------+
1039 | **IF Definition**   | **Description**                                                                           |
1040 +=====================+===========================================================================================+
1041 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId}   |
1042 +---------------------+-------------------------------------------------------------------------------------------+
1043 | Operation           | Delete                                                                                    |
1044 +---------------------+-------------------------------------------------------------------------------------------+
1045 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1046 +---------------------+-------------------------------------------------------------------------------------------+
1047
1048 1. \ **Request**
1049
1050 N/A
1051
1052 1. \ **Response**
1053
1054 204: no content
1055
1056 1. \ **List Subnets**
1057
1058 +---------------------+--------------------------------------------------------------------------------+
1059 | **IF Definition**   | **Description**                                                                |
1060 +=====================+================================================================================+
1061 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
1062 +---------------------+--------------------------------------------------------------------------------+
1063 | Operation           | get                                                                            |
1064 +---------------------+--------------------------------------------------------------------------------+
1065 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1066 +---------------------+--------------------------------------------------------------------------------+
1067
1068 1. \ **Query**
1069
1070 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
1071
1072 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1073 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                |
1074 +=================+=================+===================+===============+================================================================================================+
1075 | name            | O               | 1                 | String        | Filters fields of the response by a name, as a string. A valid value is the name of a subnet   |
1076 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1077
1078 1. \ **Response**
1079
1080 +-------------------+-----------------+-------------------+------------------------+----------------------+
1081 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1082 +===================+=================+===================+========================+======================+
1083 | vimId             | M               | 1                 | String                 | vim id               |
1084 +-------------------+-----------------+-------------------+------------------------+----------------------+
1085 | vimName           | O               | 1                 | string                 | vim name             |
1086 +-------------------+-----------------+-------------------+------------------------+----------------------+
1087 | subnets           | M               | 0..N              | List                   | Network list         |
1088 +-------------------+-----------------+-------------------+------------------------+----------------------+
1089 | status            |                 | 1                 | string                 | subnetwork status    |
1090 +-------------------+-----------------+-------------------+------------------------+----------------------+
1091 | id                |                 | 1                 | string                 | subNetwork id        |
1092 +-------------------+-----------------+-------------------+------------------------+----------------------+
1093 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1094 +-------------------+-----------------+-------------------+------------------------+----------------------+
1095 | networkId         | O               | 1                 | String                 | Network Id           |
1096 +-------------------+-----------------+-------------------+------------------------+----------------------+
1097 | networkName       | O               | 1                 | String                 | Network Name         |
1098 +-------------------+-----------------+-------------------+------------------------+----------------------+
1099 | name              | M               | 1                 | String                 | SubnetName           |
1100 +-------------------+-----------------+-------------------+------------------------+----------------------+
1101 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1102 +-------------------+-----------------+-------------------+------------------------+----------------------+
1103 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1104 |                   |                 |                   |                        |                      |
1105 |                   |                 |                   |                        | 4,6                  |
1106 +-------------------+-----------------+-------------------+------------------------+----------------------+
1107 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1108 |                   |                 |                   |                        |                      |
1109 |                   |                 |                   |                        | 1: yes;0: no         |
1110 +-------------------+-----------------+-------------------+------------------------+----------------------+
1111 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1112 +-------------------+-----------------+-------------------+------------------------+----------------------+
1113 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1114 +-------------------+-----------------+-------------------+------------------------+----------------------+
1115 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1116 +-------------------+-----------------+-------------------+------------------------+----------------------+
1117 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
1118 +-------------------+-----------------+-------------------+------------------------+----------------------+
1119 | -->allocation     |                 |                   |                        |                      |
1120 +-------------------+-----------------+-------------------+------------------------+----------------------+
1121 | -->start          | O               | 1                 | String                 | Start ip             |
1122 +-------------------+-----------------+-------------------+------------------------+----------------------+
1123 | -->end            | O               | 1                 | String                 | End ip               |
1124 +-------------------+-----------------+-------------------+------------------------+----------------------+
1125
1126 **200: ok**
1127
1128 **500: failed**
1129
1130 {
1131
1132 “vimId”:”11111”,
1133
1134 “vimName”:”11111”,
1135
1136 "subnets":[
1137
1138     {
1139
1140 “status”:” ACTIVE”
1141
1142 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1143
1144 “tenant”: “tenant1”,
1145
1146 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1147
1148 “name”: “subnet1”,
1149
1150 “cidr”: “10.43.35.0/24”,
1151
1152 “ipVersion”: 4,
1153
1154 “enableDhcp”: 1,
1155
1156 “gatewayIp”: “10.43.35.1”,
1157
1158 “dnsNameservers”: [],
1159
1160 “allocationPools”:[{
1161
1162 “start”: “192.168.199.2”,
1163
1164 “end”: “192.168.199.254”
1165
1166 }],
1167
1168 “hostRoutes”: []
1169
1170     }
1171
1172 ]
1173
1174 }
1175
1176 1. \ **Get Subnets**
1177
1178 +---------------------+-------------------------------------------------------------------------------------------+
1179 | **IF Definition**   | **Description**                                                                           |
1180 +=====================+===========================================================================================+
1181 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid}   |
1182 +---------------------+-------------------------------------------------------------------------------------------+
1183 | Operation           | get                                                                                       |
1184 +---------------------+-------------------------------------------------------------------------------------------+
1185 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1186 +---------------------+-------------------------------------------------------------------------------------------+
1187
1188 1. \ **Request**
1189
1190 N/A
1191
1192 1. \ **Response**
1193
1194 +-------------------+-----------------+-------------------+------------------------+----------------------+
1195 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1196 +===================+=================+===================+========================+======================+
1197 | vimId             | M               | 1                 | String                 | vim id               |
1198 +-------------------+-----------------+-------------------+------------------------+----------------------+
1199 | vimName           | O               | 1                 | string                 | vim name             |
1200 +-------------------+-----------------+-------------------+------------------------+----------------------+
1201 | status            |                 | 1                 | string                 | subnetwork status    |
1202 +-------------------+-----------------+-------------------+------------------------+----------------------+
1203 | id                |                 | 1                 | string                 | subNetwork id        |
1204 +-------------------+-----------------+-------------------+------------------------+----------------------+
1205 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1206 +-------------------+-----------------+-------------------+------------------------+----------------------+
1207 | networkId         | O               | 1                 | String                 | Network Id           |
1208 +-------------------+-----------------+-------------------+------------------------+----------------------+
1209 | networkName       | O               | 1                 | String                 | Network Name         |
1210 +-------------------+-----------------+-------------------+------------------------+----------------------+
1211 | name              | M               | 1                 | String                 | SubnetName           |
1212 +-------------------+-----------------+-------------------+------------------------+----------------------+
1213 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1214 +-------------------+-----------------+-------------------+------------------------+----------------------+
1215 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1216 |                   |                 |                   |                        |                      |
1217 |                   |                 |                   |                        | 4,6                  |
1218 +-------------------+-----------------+-------------------+------------------------+----------------------+
1219 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1220 |                   |                 |                   |                        |                      |
1221 |                   |                 |                   |                        | 1: yes;0: no         |
1222 +-------------------+-----------------+-------------------+------------------------+----------------------+
1223 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1224 +-------------------+-----------------+-------------------+------------------------+----------------------+
1225 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1226 +-------------------+-----------------+-------------------+------------------------+----------------------+
1227 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1228 +-------------------+-----------------+-------------------+------------------------+----------------------+
1229 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
1230 +-------------------+-----------------+-------------------+------------------------+----------------------+
1231 | -->allocation     |                 |                   |                        |                      |
1232 +-------------------+-----------------+-------------------+------------------------+----------------------+
1233 | -->start          | O               | 1                 | String                 | Start ip             |
1234 +-------------------+-----------------+-------------------+------------------------+----------------------+
1235 | -->end            | O               | 1                 | String                 | End ip               |
1236 +-------------------+-----------------+-------------------+------------------------+----------------------+
1237
1238 202: accepted
1239
1240 500: failed
1241
1242 {
1243
1244 “status”:” ACTIVE”
1245
1246 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1247
1248 “tenant”: “tenant1”,
1249
1250 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1251
1252 “name”: “subnet1”,
1253
1254 “cidr”: “10.43.35.0/24”,
1255
1256 “ipVersion”: 4,
1257
1258 “enableDhcp”: 1,
1259
1260 “gatewayIp”: “10.43.35.1”,
1261
1262 “dnsNameservers”: [],
1263
1264 “allocationPools”:[{
1265
1266 “start”: “192.168.199.2”,
1267
1268 “end”: “192.168.199.254”
1269
1270 }],
1271
1272 “hostRoutes”: []
1273
1274 }
1275
1276 1. \ **Virtual Port**
1277
1278    1. \ **Create Virtual Port**
1279
1280 +---------------------+------------------------------------------------------------------------------+
1281 | **IF Definition**   | **Description**                                                              |
1282 +=====================+==============================================================================+
1283 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports   |
1284 +---------------------+------------------------------------------------------------------------------+
1285 | Operation           | POST                                                                         |
1286 +---------------------+------------------------------------------------------------------------------+
1287 | Direction           | VNFLCM->MULTIVIM                                                             |
1288 +---------------------+------------------------------------------------------------------------------+
1289
1290 1. \ **Request**
1291
1292 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1293 | **Parameter**          | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                       |
1294 +========================+=================+===================+===============+=======================================================+
1295 | networkId              | M               | 1                 | string        | Network UUID                                          |
1296 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1297 | subnetId               | O               | 1                 | string        | Subnet UUID                                           |
1298 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1299 | name                   | M               | 1                 | string        | Port name                                             |
1300 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1301 | macAddress             | O               | 1                 | string        | Mac address                                           |
1302 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1303 | ip                     | O               | 1                 | string        | Ip address                                            |
1304 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1305 | vnicType               | O               | 1                 | string        | Virtual network card type,                            |
1306 |                        |                 |                   |               |                                                       |
1307 |                        |                 |                   |               | the value of three kinds of normal/direct/macvtap     |
1308 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1309 | \ **securityGroups**   | **O**           | **1**             | **string**    | **The IDs of security groups applied to the port.**   |
1310 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1311
1312 1. \ **Response**
1313
1314 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1315 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1316 +======================+=================+===================+===============+=====================================================+
1317 | returnCode           | M               | 1                 | int           | 0: Already exist 1: Newly created                   |
1318 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1319 | vimId                | M               | 1                 | String        | vim id                                              |
1320 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1321 | vimName              | O               | 1                 | string        | vim name                                            |
1322 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1323 | status               | M               | 1                 | string        | status                                              |
1324 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1325 | id                   | M               | 1                 | string        | Port Id                                             |
1326 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1327 | name                 | M               | 1                 | string        | Port name                                           |
1328 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1329 | tenantId             | M               | 1                 | String        | Tenant UUID                                         |
1330 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1331 | networkName          | M               | 1                 | string        | Network name                                        |
1332 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1333 | networkId            | M               | 1                 | string        | Network Id                                          |
1334 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1335 | subnetName           | M               | 1                 | string        | Subnet name                                         |
1336 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1337 | subnetId             | M               | 1                 | string        | SubnetId                                            |
1338 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1339 | macAddress           | O               | 1                 | string        | Mac address                                         |
1340 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1341 | ip                   | O               | 1                 | string        | Ip address                                          |
1342 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1343 | vnicType             | O               | 1                 | string        | Virtual network card type,                          |
1344 |                      |                 |                   |               |                                                     |
1345 |                      |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1346 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1347 | **securityGroups**   | **O**           | **1**             | **string**    | **List of security group names.**                   |
1348 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1349
1350 1. \ **Delete Virtual Port**
1351
1352 +---------------------+---------------------------------------------------------------------------------------+
1353 | **IF Definition**   | **Description**                                                                       |
1354 +=====================+=======================================================================================+
1355 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1356 +---------------------+---------------------------------------------------------------------------------------+
1357 | Operation           | DELETTE                                                                               |
1358 +---------------------+---------------------------------------------------------------------------------------+
1359 | Direction           | VNFLCM->MULTIVIM                                                                      |
1360 +---------------------+---------------------------------------------------------------------------------------+
1361
1362 1. \ **Request**
1363
1364 N/A
1365
1366 1. \ **Response**
1367
1368 204: no content
1369
1370 1. \ **List Virtual Port**
1371
1372 +---------------------+-----------------------------------------------------------------------------+
1373 | **IF Definition**   | **Description**                                                             |
1374 +=====================+=============================================================================+
1375 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports   |
1376 +---------------------+-----------------------------------------------------------------------------+
1377 | Operation           | GET                                                                         |
1378 +---------------------+-----------------------------------------------------------------------------+
1379 | Direction           | VNFLCM->MULTIVIM                                                            |
1380 +---------------------+-----------------------------------------------------------------------------+
1381
1382 1. \ **Query**
1383
1384 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1385 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                 |
1386 +=================+=================+===================+===============+=================================================+
1387 | name            | M               | 1                 | string        | Port name to filter out list of virtual ports   |
1388 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1389
1390 1. \ **Response**
1391
1392 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1393 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1394 +===================+=================+===================+===============+=====================================================+
1395 | vimId             | M               | 1                 | String        | vim id                                              |
1396 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1397 | vimName           | O               | 1                 | string        | vim name                                            |
1398 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1399 | tenantId          | M               | 1                 | String        | Tenant UUID                                         |
1400 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1401 | Ports             | M               | 0..N              | List          | ports                                               |
1402 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1403 | id                | M               | 1                 | string        | Port Id                                             |
1404 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1405 | name              | M               | 1                 | string        | Port name                                           |
1406 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1407 | status            | M               | 1                 | string        | status                                              |
1408 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1409 | **networkName**   | O               | 1                 | string        | Network name                                        |
1410 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1411 | networkId         | M               | 1                 | string        | Network Id                                          |
1412 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1413 | subnetName        | O               | 1                 | string        | Subnet name                                         |
1414 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1415 | subnetId          | M               | 1                 | string        | SubnetId                                            |
1416 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1417 | macAddress        | O               | 1                 | string        | Mac address                                         |
1418 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1419 | ip                | O               | 1                 | string        | Ip address                                          |
1420 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1421 | vnicType          | O               | 1                 | string        | Virtual network card type,                          |
1422 |                   |                 |                   |               |                                                     |
1423 |                   |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1424 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1425 | securityGroups    | O               | 1                 | string        | List of security group names.                       |
1426 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1427
1428 **200: ok**
1429
1430 **500: failed**
1431
1432 {
1433
1434 }
1435
1436 1. \ **Get Virtual Port**
1437
1438 +---------------------+---------------------------------------------------------------------------------------+
1439 | **IF Definition**   | **Description**                                                                       |
1440 +=====================+=======================================================================================+
1441 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1442 +---------------------+---------------------------------------------------------------------------------------+
1443 | Operation           | GET                                                                                   |
1444 +---------------------+---------------------------------------------------------------------------------------+
1445 | Direction           | VNFLCM->MULTIVIM                                                                      |
1446 +---------------------+---------------------------------------------------------------------------------------+
1447
1448 1. \ **Request**
1449
1450 N/A
1451
1452 1. \ **Response**
1453
1454 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1455 | **Parameter**    | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1456 +==================+=================+===================+===============+=====================================================+
1457 | vimId            | M               | 1                 | String        | vim id                                              |
1458 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1459 | vimName          | O               | 1                 | string        | vim name                                            |
1460 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1461 | status           | M               | 1                 | string        | status                                              |
1462 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1463 | id               | M               | 1                 | string        | Port Id                                             |
1464 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1465 | name             | M               | 1                 | string        | Port name                                           |
1466 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1467 | tenantId         | M               | 1                 | String        | Tenant UUID                                         |
1468 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1469 | networkName      | M               | 1                 | string        | Network name                                        |
1470 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1471 | networkId        | M               | 1                 | string        | Network Id                                          |
1472 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1473 | subnetName       | M               | 1                 | string        | Subnet name                                         |
1474 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1475 | subnetId         | M               | 1                 | string        | SubnetId                                            |
1476 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1477 | macAddress       | O               | 1                 | string        | Mac address                                         |
1478 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1479 | ip               | O               | 1                 | string        | Ip address                                          |
1480 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1481 | vnicType         | O               | 1                 | string        | Virtual network card type,                          |
1482 |                  |                 |                   |               |                                                     |
1483 |                  |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1484 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1485 | securityGroups   | O               | 1                 | string        | **List of security group names.**                   |
1486 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1487
1488 **200: ok**
1489
1490 **500: failed**
1491
1492 {
1493
1494 }
1495
1496 1. \ **Server Management**
1497
1498    1. \ **Create Server**
1499
1500 +---------------------+--------------------------------------------------------------------------------+
1501 | **IF Definition**   | **Description**                                                                |
1502 +=====================+================================================================================+
1503 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1504 +---------------------+--------------------------------------------------------------------------------+
1505 | Operation           | POST                                                                           |
1506 +---------------------+--------------------------------------------------------------------------------+
1507 | Direction           | VNFLCM->MULTIVIM                                                               |
1508 +---------------------+--------------------------------------------------------------------------------+
1509
1510 1. \ **Request**
1511
1512 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1513 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1514 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1515 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1516 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1517 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1518 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1519 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1520 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1521 | contextArray         | O               | 1..n              | list of context                       | list of context                                                                                                                                                                        |
1522 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1523 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1524 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1525 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1526 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1527 | flavorId             | M               | 1                 | String                                | server Flavor id                                                                                                                                                                       |
1528 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1529 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1530 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1531 | userdata             | O               | 1                 | string                                | Configuration information or scripts to use upon launch. Must be Base64 encoded.                                                                                                       |
1532 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1533 |                      |                 |                   |                                       | 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.                                                       |
1534 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1535 | **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.**   |
1536 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1537 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1538 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1539
1540 **boot**
1541
1542 +-----------------+-----------------+-------------------+---------------+---------------------------+
1543 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**           |
1544 +=================+=================+===================+===============+===========================+
1545 | type            | M               | 1                 | int           | Startup mode              |
1546 |                 |                 |                   |               |                           |
1547 |                 |                 |                   |               | 1. boot from the volume   |
1548 |                 |                 |                   |               |                           |
1549 |                 |                 |                   |               | 2. boot from image        |
1550 +-----------------+-----------------+-------------------+---------------+---------------------------+
1551 | volumeId        | O               | 1                 | string        | Volume Id(type=1)         |
1552 +-----------------+-----------------+-------------------+---------------+---------------------------+
1553 | imageId         | O               | 1                 | String        | ImageId（type=2）         |
1554 +-----------------+-----------------+-------------------+---------------+---------------------------+
1555
1556 **contextArray**
1557
1558 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1559 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                           |
1560 +=================+=================+===================+===============+===========================================================================================================================================================+
1561 | fileName        | M               | 1                 | String        | Injection file name                                                                                                                                       |
1562 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1563 | 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. )   |
1564 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1565
1566 volumeArray
1567
1568 +-----------------+-----------------+-------------------+---------------+-------------------+
1569 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1570 +=================+=================+===================+===============+===================+
1571 | volumeId        | M               | 1                 | String        | Volume Id         |
1572 +-----------------+-----------------+-------------------+---------------+-------------------+
1573
1574 nicArray
1575
1576 +-----------------+-----------------+-------------------+---------------+-------------------+
1577 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1578 +=================+=================+===================+===============+===================+
1579 | portId          | M               | 1                 | String        | Port Id           |
1580 +-----------------+-----------------+-------------------+---------------+-------------------+
1581
1582 **metadata**
1583
1584 +-----------------+-----------------+-------------------+---------------+-------------------+
1585 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1586 +=================+=================+===================+===============+===================+
1587 | keyName         | M               | 1                 | String        | Key name          |
1588 +-----------------+-----------------+-------------------+---------------+-------------------+
1589 | value           | M               | 1                 | string        | value             |
1590 +-----------------+-----------------+-------------------+---------------+-------------------+
1591
1592 {
1593
1594 "tenant": "tenant1",
1595
1596 "name": "vm1",
1597
1598 “availabilityZone”:”az1”,
1599
1600 “flavorName”:”vm\_large”,
1601
1602 "boot": {
1603
1604 "type": 1,
1605
1606 " volumeName": "volume1"
1607
1608 },
1609
1610 “flavorId”:”vm\_large\_134213”
1611
1612 "contextArray": [{
1613
1614 "fileName": "test.yaml",
1615
1616 "fileData": "….”
1617
1618 }],
1619
1620 "volumeArray": [{
1621
1622 "volumeName": "vol1",
1623
1624 }],
1625
1626 “nicArray”:[{
1627
1628     “portId”:”port\_a”
1629
1630 }]
1631
1632 “metada”: [{
1633
1634 "keyName": "foo",
1635
1636 "value": "foo value”
1637
1638 }],
1639
1640 “userdata”:”abcdedf”
1641
1642 }
1643
1644 1. \ **Response**
1645
1646 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1647 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                          | **Description**                                                                                                                                                                        |
1648 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1649 | vimId                | M               | 1                 | String                               | vim id                                                                                                                                                                                 |
1650 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1651 | vimName              | O               | 1                 | string                               | vim name                                                                                                                                                                               |
1652 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1653 | returnCode           |                 | 1                 | int                                  | 0: Already exist 1: Newly created                                                                                                                                                      |
1654 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1655 | id                   | M               | 1                 | string                               | server id                                                                                                                                                                              |
1656 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1657 | name                 |                 | 1                 | string                               | server name                                                                                                                                                                            |
1658 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1659 | tenantId             | M               | 1                 | String                               | Tenant UUID                                                                                                                                                                            |
1660 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1661 | boot                 | M               | 1                 | String                               | Start parameters                                                                                                                                                                       |
1662 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1663 | nicArray             | O               | 1..n              | List of nic                          | List of nic                                                                                                                                                                            |
1664 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1665 | volumeArray          | O               | 1..n              | list of volume                       | list of volume                                                                                                                                                                         |
1666 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1667 | availabilityZone     | O               | 1                 | string                               | Usable field                                                                                                                                                                           |
1668 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1669 | flavorId             | M               | 1                 | String                               | server Flavor                                                                                                                                                                          |
1670 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1671 | metadata             | O               | 1                 | List of metadata                     | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1672 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1673 | **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.**   |
1674 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1675 |                      |                 |                   |                                      | **[TBD]**                                                                                                                                                                              |
1676 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1677 | **serverGroup**      | **O**           | **1**             | **string**                           | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1678 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1679 |                      |                 |                   |                                      | [TBD]                                                                                                                                                                                  |
1680 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1681 | **status**           | **M**           | **1**             | **string**                           | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR                                                                                                                                             |
1682 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1683
1684 202: accepted
1685
1686 500: failed
1687
1688 {
1689
1690 "id": "3c9eebdbbfd345658269340b9ea6fb73",
1691
1692 "name": "vm1",
1693
1694 "returnCode": 1,
1695
1696 }
1697
1698 1. \ **Delete Server**
1699
1700 +---------------------+-------------------------------------------------------------------------------------------+
1701 | **IF Definition**   | **Description**                                                                           |
1702 +=====================+===========================================================================================+
1703 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1704 +---------------------+-------------------------------------------------------------------------------------------+
1705 | Operation           | DELETE                                                                                    |
1706 +---------------------+-------------------------------------------------------------------------------------------+
1707 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1708 +---------------------+-------------------------------------------------------------------------------------------+
1709
1710 1. \ **Request**
1711
1712 N/A
1713
1714 1. \ **Response**
1715
1716 204: no content
1717
1718 1. \ **List Server**
1719
1720 +---------------------+--------------------------------------------------------------------------------+
1721 | **IF Definition**   | **Description**                                                                |
1722 +=====================+================================================================================+
1723 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1724 +---------------------+--------------------------------------------------------------------------------+
1725 | Operation           | get                                                                            |
1726 +---------------------+--------------------------------------------------------------------------------+
1727 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1728 +---------------------+--------------------------------------------------------------------------------+
1729
1730 1. \ **Request**
1731
1732 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1733
1734 +-----------------+-----------------+-------------------+---------------+-------------------+
1735 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1736 +=================+=================+===================+===============+===================+
1737 | name            | M               | 1                 | string        | server name       |
1738 +-----------------+-----------------+-------------------+---------------+-------------------+
1739
1740 1. \ **Response**
1741
1742 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1743 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1744 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1745 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1746 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1747 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1748 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1749 | servers              | M               | 1                 | array                                 | server list                                                                                                                                                                            |
1750 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1751 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1752 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1753 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1754 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1755 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1756 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1757 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1758 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1759 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1760 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1761 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1762 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1763 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1764 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1765 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1766 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1767 | metada               | O               | 1                 | keypair                               | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1768 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1769 | **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.**   |
1770 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1771 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1772 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1773 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1774 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1775 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1776 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1777
1778 200: ok
1779
1780 500: failed
1781
1782 {
1783
1784 }
1785
1786 1. \ **Get Server**
1787
1788 +---------------------+-------------------------------------------------------------------------------------------+
1789 | **IF Definition**   | **Description**                                                                           |
1790 +=====================+===========================================================================================+
1791 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1792 +---------------------+-------------------------------------------------------------------------------------------+
1793 | Operation           | get                                                                                       |
1794 +---------------------+-------------------------------------------------------------------------------------------+
1795 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1796 +---------------------+-------------------------------------------------------------------------------------------+
1797
1798 1. \ **Request**
1799
1800 N/A
1801
1802 1. \ **Response**
1803
1804 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1805 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1806 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1807 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1808 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1809 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1810 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1811 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1812 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1813 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1814 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1815 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1816 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1817 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1818 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1819 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1820 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1821 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1822 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1823 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1824 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1825 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1826 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1827 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1828 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1829 | **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.**   |
1830 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1831 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1832 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1833 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1834 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1835 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1836 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1837
1838 200: ok
1839
1840 500: failed
1841
1842 {
1843
1844 }
1845
1846 1. \ **Flavor Management**
1847
1848    1. \ **Create Flavor**
1849
1850 +---------------------+--------------------------------------------------------------------------------+
1851 | **IF Definition**   | **Description**                                                                |
1852 +=====================+================================================================================+
1853 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors   |
1854 +---------------------+--------------------------------------------------------------------------------+
1855 | Operation           | POST                                                                           |
1856 +---------------------+--------------------------------------------------------------------------------+
1857 | Direction           | VNFLCM->MULTIVIM                                                               |
1858 +---------------------+--------------------------------------------------------------------------------+
1859
1860 1. \ **Request**
1861
1862 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1863 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1864 +=================+=================+===================+===============================+==============================================================================================================================+
1865 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1866 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1867 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1868 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1869 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1870 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1871 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1872 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1873 | ephemeral       | O               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1874 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1875 | swap            | O               | 1                 | int                           | The size of the swap disk                                                                                                    |
1876 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1877 | 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.   |
1878 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1879 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1880 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1881
1882 1. \ **Response**
1883
1884 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1885 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                                              |
1886 +=================+=================+===================+===========================+==============================================================================================================================+
1887 | id              | M               | 1                 | string                    | Flavor id                                                                                                                    |
1888 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1889 | name            | M               | 1                 | string                    | Flavor name                                                                                                                  |
1890 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1891 | returnCode      | M               | 1                 | int                       | 0: Already exist 1: Newly created                                                                                            |
1892 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1893 | tenantId        | M               | 1                 | String                    | Tenant UUID                                                                                                                  |
1894 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1895 | vcpu            | M               | 1                 | int                       | Virtual CPU number                                                                                                           |
1896 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1897 | memory          | M               | 1                 | int                       | Memory size                                                                                                                  |
1898 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1899 | disk            | M               | 1                 | int                       | The size of the root disk                                                                                                    |
1900 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1901 | ephemeral       | M               | 1                 | int                       | The size of the ephemeral disk                                                                                               |
1902 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1903 | swap            | M               | 1                 | int                       | The size of the swap disk                                                                                                    |
1904 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1905 | 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.   |
1906 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1907 | extraSpecs      | O               | 0..N              | List of Key-value pairs   | EPA parameter                                                                                                                |
1908 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1909 | vimId           | M               | 1                 | String                    | vim id                                                                                                                       |
1910 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1911 | vimName         | O               | 1                 | string                    | vim name                                                                                                                     |
1912 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1913
1914 1. \ **Delete Flavor**
1915
1916 +---------------------+--------------------------------------------------------------------------------------------+
1917 | **IF Definition**   | **Description**                                                                            |
1918 +=====================+============================================================================================+
1919 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid}   |
1920 +---------------------+--------------------------------------------------------------------------------------------+
1921 | Operation           | DELETE                                                                                     |
1922 +---------------------+--------------------------------------------------------------------------------------------+
1923 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                      |
1924 +---------------------+--------------------------------------------------------------------------------------------+
1925
1926 1. \ **Request**
1927
1928 N/A
1929
1930 1. \ **Response**
1931
1932 204: no content
1933
1934 1. \ **List Flavor**
1935
1936 +---------------------+---------------------------------------------------------------------------------+
1937 | **IF Definition**   | **Description**                                                                 |
1938 +=====================+=================================================================================+
1939 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors   |
1940 +---------------------+---------------------------------------------------------------------------------+
1941 | Operation           | get                                                                             |
1942 +---------------------+---------------------------------------------------------------------------------+
1943 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
1944 +---------------------+---------------------------------------------------------------------------------+
1945
1946 1. \ **Query**
1947
1948 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1949 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                  |
1950 +=================+=================+===================+===============+==================================+
1951 | name            | M               | 1                 | string        | Flavor name to filter out list   |
1952 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1953
1954 1. \ **Response**
1955
1956 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1957 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1958 +=================+=================+===================+===============================+==============================================================================================================================+
1959 | flavors         | M               | 0..N              | list                          | Vm list                                                                                                                      |
1960 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1961 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
1962 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1963 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1964 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1965 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1966 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1967 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1968 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1969 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1970 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1971 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1972 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1973 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
1974 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1975 | 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.   |
1976 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1977 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1978 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1979 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
1980 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1981 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
1982 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1983 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
1984 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1985
1986 200: ok
1987
1988 500: failed
1989
1990 1. \ **Get Flavor**
1991
1992 +---------------------+----------------------------------------------------------------------------------------------+
1993 | **IF Definition**   | **Description**                                                                              |
1994 +=====================+==============================================================================================+
1995 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid }   |
1996 +---------------------+----------------------------------------------------------------------------------------------+
1997 | Operation           | get                                                                                          |
1998 +---------------------+----------------------------------------------------------------------------------------------+
1999 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                        |
2000 +---------------------+----------------------------------------------------------------------------------------------+
2001
2002 1. \ **Request**
2003
2004 N/A
2005
2006 1. \ **Response**
2007
2008 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2009 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
2010 +=================+=================+===================+===============================+==============================================================================================================================+
2011 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
2012 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2013 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
2014 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2015 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
2016 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2017 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
2018 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2019 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
2020 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2021 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
2022 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2023 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
2024 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2025 | 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.   |
2026 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2027 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
2028 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2029 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
2030 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2031 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
2032 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2033 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
2034 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2035
2036 200: ok
2037
2038 500: failed
2039
2040 1. \ **Volume Management**
2041
2042    1. \ **Create Volume**
2043
2044 +---------------------+--------------------------------------------------------------------------------+
2045 | **IF Definition**   | **Description**                                                                |
2046 +=====================+================================================================================+
2047 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2048 +---------------------+--------------------------------------------------------------------------------+
2049 | Operation           | POST                                                                           |
2050 +---------------------+--------------------------------------------------------------------------------+
2051 | Direction           | NSLCM->MULTIVIM                                                                |
2052 +---------------------+--------------------------------------------------------------------------------+
2053
2054 1. \ **Request**
2055
2056 +--------------------+-----------------+-------------------+---------------+-------------------+
2057 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2058 +====================+=================+===================+===============+===================+
2059 | name               | M               | 1                 | string        | Volume name       |
2060 +--------------------+-----------------+-------------------+---------------+-------------------+
2061 | volumeSize         | M               | 1                 | int           | Volume size       |
2062 +--------------------+-----------------+-------------------+---------------+-------------------+
2063 | imageId            | O               | 1                 | string        | Image UUID        |
2064 +--------------------+-----------------+-------------------+---------------+-------------------+
2065 | volumeType         | O               | 1                 | string        | Volume type       |
2066 +--------------------+-----------------+-------------------+---------------+-------------------+
2067 | availabilityZone   | O               | 1                 | string        | Usable field      |
2068 +--------------------+-----------------+-------------------+---------------+-------------------+
2069
2070     {
2071
2072     "tenant": "tenant1",
2073
2074     "volumeName": "volume1",
2075
2076     "volumeSize": 3,
2077
2078     "imageName": "cirros.qcow2",
2079
2080     "volumeType": "volumetype1",
2081
2082     "availabilityZone": "zone1"
2083
2084     }
2085
2086 1. \ **Response**
2087
2088 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2089 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2090 +====================+=================+===================+===============+=====================================+
2091 | returnCode         | M               | 1                 | int           | 0: Already exist 1: Newly created   |
2092 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2093 | vimId              | M               | 1                 | String        | vim id                              |
2094 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2095 | vimName            | O               | 1                 | string        | vim name                            |
2096 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2097 | tenantId           | M               | 1                 | String        | Tenant UUID                         |
2098 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2099 | status             | M               | 1                 | string        | Volume status                       |
2100 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2101 | id                 | M               | 1                 | string        | Volume id                           |
2102 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2103 | name               | M               | 1                 | string        | Volume name                         |
2104 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2105 | volumeType         | O               | 1                 | string        | Volume type                         |
2106 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2107 | availabilityZone   | O               | 1                 | string        | Availability Zone                   |
2108 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2109
2110 202: accepted
2111
2112 500: failed
2113
2114     {
2115
2116     "id": "bc9eebdbbfd356458269340b9ea6fb73",
2117
2118     "name": "volume1",
2119
2120     "returnCode": 1,
2121
2122     }
2123
2124 1. \ **Delete Volume**
2125
2126 +---------------------+-------------------------------------------------------------------------------------------+
2127 | **IF Definition**   | **Description**                                                                           |
2128 +=====================+===========================================================================================+
2129 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId}   |
2130 +---------------------+-------------------------------------------------------------------------------------------+
2131 | Operation           | DELETE                                                                                    |
2132 +---------------------+-------------------------------------------------------------------------------------------+
2133 | Direction           | NSLCM->MULTIVIM                                                                           |
2134 +---------------------+-------------------------------------------------------------------------------------------+
2135
2136 1. \ **Request**
2137
2138     N/A
2139
2140 1. \ **Response**
2141
2142     204: no content
2143
2144 1. \ **List Volumes**
2145
2146 +---------------------+--------------------------------------------------------------------------------+
2147 | **IF Definition**   | **Description**                                                                |
2148 +=====================+================================================================================+
2149 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2150 +---------------------+--------------------------------------------------------------------------------+
2151 | Operation           | GET                                                                            |
2152 +---------------------+--------------------------------------------------------------------------------+
2153 | Direction           | NSLCM-> MULTIVIM                                                               |
2154 +---------------------+--------------------------------------------------------------------------------+
2155
2156 1. \ **Request**
2157
2158     msb.onap.org:80/api/multicloud/v0/{cloud
2159     owner}\_{region}/volumes?{……}
2160
2161 +-----------------+-----------------+-------------------+---------------+-------------------+
2162 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2163 +=================+=================+===================+===============+===================+
2164 | name            | M               | 1                 | string        | Volume name       |
2165 +-----------------+-----------------+-------------------+---------------+-------------------+
2166
2167 1. \ **Response**
2168
2169 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2170 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2171 +====================+=================+===================+======================+====================================================+
2172 | vimId              | M               | 1                 | String               | vim id                                             |
2173 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2174 | vimName            | O               | 1                 | string               | vim name                                           |
2175 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2176 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2177 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2178 | volumes            | M               | 1                 | Array                |                                                    |
2179 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2180 | id                 | M               | 1                 | string               | Volume id                                          |
2181 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2182 | name               | M               | 1                 | string               | Volume name                                        |
2183 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2184 | createTime         | O               | 1                 | string               | Create time                                        |
2185 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2186 | status             | M               | 1                 | string               | Volume status                                      |
2187 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2188 | volumeSize         | M               | 1                 | int                  | Volume size                                        |
2189 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2190 | volumeType         | M               | 1                 | string               | Volume type                                        |
2191 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2192 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2193 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2194 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2195 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2196
2197 200: ok
2198
2199 500: failed
2200
2201     {
2202
2203     "volumes": [
2204
2205     {
2206
2207     "status": "available",
2208
2209     "name": "test",
2210
2211     "attachments": [],
2212
2213     "createTime": "2015-12-02T07:57:23.000000",
2214
2215     " volumeType ": "ws",
2216
2217     "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2218
2219     "size": 20
2220
2221     },
2222
2223     {
2224
2225     "status": "in-use",
2226
2227     "name": "wangsong",
2228
2229     "attachments": [
2230
2231     {
2232
2233     "device": "/dev/vdc",
2234
2235     "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2236
2237     "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2238
2239     "hostName": null,
2240
2241     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2242
2243     }
2244
2245     ],
2246
2247     "createTime": "2015-12-02T06:39:40.000000",
2248
2249     " volumeType ": null,
2250
2251     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2252
2253     "size": 40
2254
2255     }
2256
2257     ]
2258
2259     }
2260
2261 1. \ **Get Volumes**
2262
2263 +---------------------+-------------------------------------------------------------------------------------------+
2264 | **IF Definition**   | **Description**                                                                           |
2265 +=====================+===========================================================================================+
2266 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid}   |
2267 +---------------------+-------------------------------------------------------------------------------------------+
2268 | Operation           | GET                                                                                       |
2269 +---------------------+-------------------------------------------------------------------------------------------+
2270 | Direction           | NSLCM-> MULTIVIM                                                                          |
2271 +---------------------+-------------------------------------------------------------------------------------------+
2272
2273 1. \ **Request**
2274
2275     N/A
2276
2277 1. \ **Response**
2278
2279 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2280 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2281 +====================+=================+===================+======================+====================================================+
2282 | vimId              | M               | 1                 | String               | vim id                                             |
2283 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2284 | vimName            | O               | 1                 | string               | vim name                                           |
2285 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2286 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2287 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2288 | id                 |                 | 1                 | string               | Volume id                                          |
2289 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2290 | name               |                 | 1                 | string               | Volume name                                        |
2291 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2292 | createTime         |                 | 1                 | string               | Create time                                        |
2293 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2294 | status             |                 | 1                 | string               | Volume status                                      |
2295 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2296 | volumeType         |                 | 1                 | list of string       | Volume type                                        |
2297 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2298 | volumeSize         |                 | 1                 | int                  | Volume size                                        |
2299 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2300 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2301 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2302 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2303 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2304
2305 **attachment：**
2306
2307 +-----------------+-----------------+-------------------+---------------+-------------------+
2308 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2309 +=================+=================+===================+===============+===================+
2310 | device          |                 | 1                 | string        | Device name       |
2311 +-----------------+-----------------+-------------------+---------------+-------------------+
2312 | serverId        |                 | 1                 | string        | VM id             |
2313 +-----------------+-----------------+-------------------+---------------+-------------------+
2314 | volumeId        |                 | 1                 | string        | Volume id         |
2315 +-----------------+-----------------+-------------------+---------------+-------------------+
2316 | hostName        |                 | 1                 | string        | Host name         |
2317 +-----------------+-----------------+-------------------+---------------+-------------------+
2318 | id              |                 | 1                 | string        | Device id         |
2319 +-----------------+-----------------+-------------------+---------------+-------------------+
2320
2321 200: ok
2322
2323 500: failed
2324
2325     {
2326
2327     "status": "in-use",
2328
2329     "name": "wangsong",
2330
2331     "attachments": [
2332
2333     {
2334
2335     "device": "/dev/vdc",
2336
2337     "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2338
2339     "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2340
2341     "hostName": null,
2342
2343     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2344
2345     }
2346
2347     ],
2348
2349     "createTime": "2015-12-02T06:39:40.000000",
2350
2351     "volumeType ": null,
2352
2353     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2354
2355     "volumeSize ": 40
2356
2357     }
2358
2359 1. \ **Tenant Management**
2360
2361    1. \ **List tenants**
2362
2363 +---------------------+---------------------------------------------------------------------+
2364 | **IF Definition**   | **Description**                                                     |
2365 +=====================+=====================================================================+
2366 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants   |
2367 +---------------------+---------------------------------------------------------------------+
2368 | Operation           | GET                                                                 |
2369 +---------------------+---------------------------------------------------------------------+
2370 | Direction           | NSLCM-> MULTIVIM                                                    |
2371 +---------------------+---------------------------------------------------------------------+
2372
2373 1. \ **Query**
2374
2375 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2376 | **Parameter**       | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2377 +=====================+=================+===================+===============+=====================================+
2378 | name={tenantname}   | O               | 1                 | string        | Tenant name to filter output list   |
2379 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2380
2381 1. \ **Response**
2382
2383 +-----------------+-----------------+-------------------+---------------+-------------------+
2384 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2385 +=================+=================+===================+===============+===================+
2386 | vimId           | M               | 1                 | String        | vim id            |
2387 +-----------------+-----------------+-------------------+---------------+-------------------+
2388 | vimName         | O               | 1                 | string        | vim name          |
2389 +-----------------+-----------------+-------------------+---------------+-------------------+
2390 | tenants         | M               | 1                 | Array         |                   |
2391 +-----------------+-----------------+-------------------+---------------+-------------------+
2392 | id              | M               | 1                 | string        | tenant UUID       |
2393 +-----------------+-----------------+-------------------+---------------+-------------------+
2394 | name            | M               | 1                 | string        | tenant name       |
2395 +-----------------+-----------------+-------------------+---------------+-------------------+
2396
2397 200: ok
2398
2399 500: failed
2400
2401     {
2402
2403     " tenants ": [
2404
2405     {
2406
2407     "id": "1",
2408
2409     "name": "test\_a"
2410
2411     }
2412
2413     ]
2414
2415     }
2416
2417 1. \ **Limits**
2418
2419    1. \ **List Limits of resouces: CPU&Memory, volume,network,etc**
2420
2421 +---------------------+-------------------------------------------------------------------------------+
2422 | **IF Definition**   | **Description**                                                               |
2423 +=====================+===============================================================================+
2424 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits   |
2425 +---------------------+-------------------------------------------------------------------------------+
2426 | Operation           | GET                                                                           |
2427 +---------------------+-------------------------------------------------------------------------------+
2428 | Direction           | NSLCM-> MULTIVIM                                                              |
2429 +---------------------+-------------------------------------------------------------------------------+
2430
2431 1. \ **Request**
2432
2433 2. \ **Response**
2434
2435 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2436 | **Parameter**             | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                  |
2437 +===========================+=================+===================+===============+==================================================================+
2438 | vimId                     | M               | 1                 | String        | vim id                                                           |
2439 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2440 | vimName                   | O               | 1                 | string        | vim name                                                         |
2441 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2442 | tenantId                  | M               | 1                 | string        | Tenant UUID                                                      |
2443 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2444 | maxPersonality            | O               | 1                 | int           | The number of allowed injected files for each tenant.            |
2445 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2446 | maxPersonalitySize        | O               | 1                 | int           | The number of allowed bytes of content for each injected file.   |
2447 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2448 | maxServerGroupMembers     | O               | 1                 | int           | The number of allowed members for each server group.             |
2449 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2450 | maxServerGroups           | O               | 1                 | int           | The number of allowed server groups for each tenant.             |
2451 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2452 | maxServerMeta             | O               | 1                 | int           | The number of allowed metadata items for each instance.          |
2453 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2454 | maxTotalCores             | O               | 1                 | int           | The number of allowed instance cores for each tenant.            |
2455 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2456 | maxTotalInstances         | O               | 1                 | int           | The number of allowed instances for each tenant.                 |
2457 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2458 | maxTotalKeypairs          | O               | 1                 | int           | The number of allowed key pairs for each user.                   |
2459 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2460 | maxTotalRAMSize           | O               | 1                 | int           | The amount of allowed instance RAM, in MB, for each tenant.      |
2461 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2462 | maxTotalVolumeGigabytes   | O               | 1                 | int           | The maximum total amount of volumes, in gibibytes (GiB).         |
2463 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2464 | maxTotalVolumes           | O               | 1                 | int           | The maximum number of volumes.                                   |
2465 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2466 | totalVolumesUsed          | O               | 1                 | int           | The total number of volumes used.                                |
2467 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2468 | totalGigabytesUsed        | O               | 1                 | int           | The total number of gibibytes (GiB) used.                        |
2469 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2470 | network                   | O               | 1                 | int           | The number of networks allowed for each project.                 |
2471 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2472 | subnet                    | O               | 1                 | int           | The number of subnets allowed for each project.                  |
2473 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2474 | subnetpool                | O               | 1                 | int           | The number of subnet pools allowed for each project.             |
2475 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2476 | security\_group\_rule     | O               | 1                 | int           | The number of security group rules allowed for each project.     |
2477 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2478 | security\_group           | O               | 1                 | int           | The number of security groups allowed for each project.          |
2479 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2480 | router                    | O               | 1                 | int           | The number of routers allowed for each project.                  |
2481 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2482 | port                      | O               | 1                 | int           | The number of ports allowed for each project.                    |
2483 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2484
2485 200: ok
2486
2487 500: failed
2488
2489     {
2490
2491     "maxPersonality": 5,
2492
2493     "maxPersonalitySize": 10240,
2494
2495     "maxServerMeta": 128,
2496
2497     "maxTotalCores": 20,
2498
2499     "maxTotalInstances": 10,
2500
2501     "maxTotalKeypairs": 100,
2502
2503     "maxTotalRAMSize": 51200,
2504
2505     "maxServerGroups": 10,
2506
2507     "maxServerGroupMembers": 10,
2508
2509     }
2510
2511 1. \ **Host Management**
2512
2513    1. \ **List hosts**
2514
2515 +---------------------+------------------------------------------------------------------------------+
2516 | **IF Definition**   | **Description**                                                              |
2517 +=====================+==============================================================================+
2518 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts   |
2519 +---------------------+------------------------------------------------------------------------------+
2520 | Operation           | GET                                                                          |
2521 +---------------------+------------------------------------------------------------------------------+
2522 | Direction           | NSLCM-> MULTIVIM                                                             |
2523 +---------------------+------------------------------------------------------------------------------+
2524
2525 1. \ **Request**
2526
2527 2. \ **Response**
2528
2529 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2530 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**     | **Description**                   |
2531 +=================+=================+===================+=================+===================================+
2532 | vimId           | M               | 1                 | String          | vim id                            |
2533 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2534 | vimName         | O               | 1                 | string          | vim name                          |
2535 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2536 | tenantId        | M               | 1                 | string          | Tenant Name                       |
2537 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2538 | hosts           | M               | 1                 | Array of host   | List of host information          |
2539 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2540 | service         | M               | 1                 | string          | The service running on the host   |
2541 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2542 | name            | M               | 1                 | string          | host name                         |
2543 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2544 | zone            | O               | 1                 | string          | Available zone for the host       |
2545 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2546
2547 200: ok
2548
2549 500: failed
2550
2551     {
2552
2553     "vimId": "123",
2554
2555     "vimName": "vimName",
2556
2557     "tenantId": "tenantId1"
2558
2559     "hosts": [
2560
2561     {
2562
2563     "name": "b6e4adbc193d428ea923899d07fb001e",
2564
2565     "service": "conductor",
2566
2567     "zone": "internal",
2568
2569     "vimId": "123",
2570
2571     "vimName": "vimName",
2572
2573     "tenantId": "tenantId1"
2574
2575     },
2576
2577     {
2578
2579     "name": "09c025b0efc64211bd23fc50fa974cdf",
2580
2581     "service": "compute",
2582
2583     "zone": "nova"
2584
2585     "vimId": "123",
2586
2587     "vimName": "vimName",
2588
2589     "tenantId": "tenantId1"
2590
2591     },
2592
2593     {
2594
2595     "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2596
2597     "service": "consoleauth",
2598
2599     "zone": "internal"
2600
2601     "vimId": "123",
2602
2603     "vimName": "vimName",
2604
2605     "tenantId": "tenantId1"
2606
2607     },
2608
2609     {
2610
2611     "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2612
2613     "service": "network",
2614
2615     "zone": "internal"
2616
2617     "vimId": "123",
2618
2619     "vimName": "vimName",
2620
2621     "tenantId": "tenantId1"
2622
2623     },
2624
2625     {
2626
2627     "name": "abffda96592c4eacaf4111c28fddee17",
2628
2629     "service": "scheduler",
2630
2631     "zone": "internal"
2632
2633     "vimId": "123",
2634
2635     "vimName": "vimName",
2636
2637     "tenantId": "tenantId1"
2638
2639     }
2640
2641     ]
2642
2643     }
2644
2645 1. \ **Get host**
2646
2647 +---------------------+-----------------------------------------------------------------------------------------+
2648 | **IF Definition**   | **Description**                                                                         |
2649 +=====================+=========================================================================================+
2650 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts/{hostname}   |
2651 +---------------------+-----------------------------------------------------------------------------------------+
2652 | Operation           | GET                                                                                     |
2653 +---------------------+-----------------------------------------------------------------------------------------+
2654 | Direction           | NSLCM-> MULTIVIM                                                                        |
2655 +---------------------+-----------------------------------------------------------------------------------------+
2656
2657 1. \ **Request**
2658
2659 2. \ **Response**
2660
2661 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2662 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**         | **Description**                                              |
2663 +=================+=================+===================+=====================+==============================================================+
2664 | vimId           | M               | 1                 | String              | vim id                                                       |
2665 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2666 | vimName         | O               | 1                 | string              | vim name                                                     |
2667 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2668 | tenantId        | M               | 1                 | string              | Tenant Name                                                  |
2669 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2670 | host            | M               | 1                 | List of resources   | Host resource info                                           |
2671 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2672 | resource        | M               | 1..N              | Object              | Resource description                                         |
2673 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2674 | cpu             | M               | 1                 | Int                 | The cpu info on the host.                                    |
2675 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2676 | memory\_mb      | M               | 1                 | int                 | The memory info on the host (in MB).                         |
2677 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2678 | name            | M               | 1                 | string              | host name                                                    |
2679 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2680 | project         | M               | 1                 | string              | Value: total, used\_now, used\_max or specific project\_id   |
2681 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2682 | disk\_gb        | M               | 1                 | int                 | The disk info on the host (in GB).                           |
2683 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2684
2685 200: ok
2686
2687 500: failed
2688
2689 {
2690
2691 "cpu": 1,
2692
2693 "disk\_gb": 1028,
2694
2695 "name": "c1a7de0ac9d94e4baceae031d05caae3",
2696
2697 "memory\_mb": 8192,
2698
2699 "vimId": "123",
2700
2701 "vimName": "vimName",
2702
2703 "tenantId": "tenantId1"
2704
2705 }
2706
2707     {
2708
2709     "host": [
2710
2711     {
2712
2713     "memory\_mb": 4960,
2714
2715     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2716
2717     "disk\_gb": 92,
2718
2719     "project": "(total)",
2720
2721     "cpu": 4
2722
2723     },
2724
2725     {
2726
2727     "memory\_mb": 1536,
2728
2729     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2730
2731     "disk\_gb": 2,
2732
2733     "project": "(used\_now)",
2734
2735     "cpu": 2
2736
2737     },
2738
2739     {
2740
2741     "memory\_mb": 1024,
2742
2743     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2744
2745     "disk\_gb": 2,
2746
2747     "project": "(used\_max)",
2748
2749     "cpu": 2
2750
2751     },
2752
2753     {
2754
2755     "memory\_mb": 1024,
2756
2757     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2758
2759     "disk\_gb": 2,
2760
2761     "project": "568f7ec425db472ba348251bf1e7eebd",
2762
2763     "cpu": 2
2764
2765     }
2766
2767     ],
2768
2769     "vimName": "openstack\_newton",
2770
2771     "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2772
2773     "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2774
2775     }
2776
2777 1. \ **VIM Management**
2778
2779    1. \ **Update VIM Info**
2780
2781 +---------------------+----------------------------------------------------------------------------------------------+
2782 | **IF Definition**   | **Description**                                                                              |
2783 +=====================+==============================================================================================+
2784 | URI                 | http(s)://[hostname][:port]/onapapi/ multicloud /v1/{cloud-owner}\_{cloud-region}/registry   |
2785 +---------------------+----------------------------------------------------------------------------------------------+
2786 | Operation           | POST                                                                                         |
2787 +---------------------+----------------------------------------------------------------------------------------------+
2788 | Direction           | ESR-> MULTICLOUD                                                                             |
2789 +---------------------+----------------------------------------------------------------------------------------------+
2790
2791 1. \ **Request**
2792
2793 +-----------------+-----------------+-------------------+---------------+-----------------------+
2794 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**       |
2795 +=================+=================+===================+===============+=======================+
2796 | defaultTenant   | M               | 1                 | string        | default tenant name   |
2797 +-----------------+-----------------+-------------------+---------------+-----------------------+
2798
2799 1. \ **Response**
2800
2801 NA
2802
2803 202: accept
2804
2805 400: failed
2806
2807 1. \ **Unregistry VIM**
2808
2809 +---------------------+-----------------------------------------------------------------------------------------------+
2810 | **IF Definition**   | **Description**                                                                               |
2811 +=====================+===============================================================================================+
2812 | URI                 | http(s)://[hostname][:port]/onapapi/multicloud/v1 /{cloud-owner}\_{cloud-region}/unregistry   |
2813 +---------------------+-----------------------------------------------------------------------------------------------+
2814 | Operation           | DELETE                                                                                        |
2815 +---------------------+-----------------------------------------------------------------------------------------------+
2816 | Direction           | ESR-> MULTICLOUD                                                                              |
2817 +---------------------+-----------------------------------------------------------------------------------------------+
2818
2819 1. \ **Request**
2820
2821 NA
2822
2823 1. \ **Response**
2824
2825 NA
2826
2827 204: No content found
2828
2829 400: failed