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 1. \ **Response**
 599
 600 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 601 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 602 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 603 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 604 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 605 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 606 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 607 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 608 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 609 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 610 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 611 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 612 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 613 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 614 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 615 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 616 | 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.   |
 617 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 618 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 619 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 620 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 621 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 622 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 623 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 624 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 625 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 626 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 627 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 628 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 629 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 630
 631 202: accepted
 632
 633 500: failed
 634
 635 {
 636
 637 “returnCode”:0,
 638
 639 “vimId”:”11111”,
 640
 641 “vimName”:”11111”,
 642
 643 “status”: “ACTIVE”,
 644
 645 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 646
 647 “name”: “net1”,
 648
 649 “tenant”: “tenant1”,
 650
 651 “networkName”: “ommnet”,
 652
 653 “shared”: 1,
 654
 655 “vlanTransparent”: 1,
 656
 657 “networkType”:”vlan”,
 658
 659 “segmentationId”:202,
 660
 661 “physicalNetwork ”:”ctrl”,
 662
 663 “routerExternal ”:0
 664
 665 }
 666
 667 1. \ **Delete Network**
 668
 669 +---------------------+---------------------------------------------------------------------------------------------+
 670 | **IF Definition**   | **Description**                                                                             |
 671 +=====================+=============================================================================================+
 672 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 673 +---------------------+---------------------------------------------------------------------------------------------+
 674 | Operation           | Delete                                                                                      |
 675 +---------------------+---------------------------------------------------------------------------------------------+
 676 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 677 +---------------------+---------------------------------------------------------------------------------------------+
 678
 679 1. \ **Request**
 680
 681 N/A
 682
 683 1. \ **Response**
 684
 685 204: no content
 686
 687 1. \ **List Network**
 688
 689 +---------------------+---------------------------------------------------------------------------------+
 690 | **IF Definition**   | **Description**                                                                 |
 691 +=====================+=================================================================================+
 692 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 693 +---------------------+---------------------------------------------------------------------------------+
 694 | Operation           | get                                                                             |
 695 +---------------------+---------------------------------------------------------------------------------+
 696 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
 697 +---------------------+---------------------------------------------------------------------------------+
 698
 699 1. \ **Query**
 700
 701 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 702 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                       |
 703 +=================+=================+===================+===============+=======================================================================================+
 704 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of a network   |
 705 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 706
 707 1. \ **Response**
 708
 709 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 710 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 711 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 712 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 713 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 714 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 715 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 716 | networks          |                 | 0..N              | List          | Network list                                                                                                                                                                                                                                                                              |
 717 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 718 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 719 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 720 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 721 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 722 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 723 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 724 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 725 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 726 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 727 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 728 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 729 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 730 | 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.   |
 731 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 732 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 733 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 734 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 735 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 736 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 737 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 738
 739 200: ok
 740
 741 500: failed
 742
 743 {
 744
 745 “vimId”:”11111”,
 746
 747 “vimName”:”111”,
 748
 749 “networks”:
 750
 751 [{
 752
 753 “status”: “ACTIVE”,
 754
 755 “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 756
 757 “name”: “net1”,
 758
 759 “tenant”: “tenant1”,
 760
 761 “networkName”: “ommnet”,
 762
 763 “shared”: 1,
 764
 765 “vlanTransparent”: 1,
 766
 767 “networkType”:”vlan”,
 768
 769 “segmentationId”:202,
 770
 771 “physicalNetwork ”:”ctrl”,
 772
 773 “routerExternal ”:0
 774
 775 }]
 776
 777 }
 778
 779 PHYSICALNETWORK
 780
 781 1. \ **Get Network**
 782
 783 +---------------------+---------------------------------------------------------------------------------------------+
 784 | **IF Definition**   | **Description**                                                                             |
 785 +=====================+=============================================================================================+
 786 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 787 +---------------------+---------------------------------------------------------------------------------------------+
 788 | Operation           | get                                                                                         |
 789 +---------------------+---------------------------------------------------------------------------------------------+
 790 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 791 +---------------------+---------------------------------------------------------------------------------------------+
 792
 793 1. \ **Request**
 794
 795 N/A
 796
 797 1. \ **Response**
 798
 799 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 800 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 801 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 802 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 803 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 804 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 805 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 806 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 807 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 808 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 809 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 810 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 811 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 812 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 813 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 814 | 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.   |
 815 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 816 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 817 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 818 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 819 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 820 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 821 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 822 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 823 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 824 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 825 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 826 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 827 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 828
 829 200: ok
 830
 831 500: failed
 832
 833 {
 834
 835     “vimId”:”11111”,
 836
 837     “vimName”:”11111”,
 838
 839     “status”: “ACTIVE”,
 840
 841     “id”: “3c9eebdbbfd345658269340b9ea6fb73”,
 842
 843     “name”: “net1”,
 844
 845     “tenant”: “tenant1”,
 846
 847     “networkName”: “ommnet”,
 848
 849     “shared”: 1,
 850
 851     “vlanTransparent”: 1,
 852
 853     “networkType”:”vlan”,
 854
 855     “segmentationId”:202,
 856
 857     “physicalNetwork ”:”ctrl”,
 858
 859     “routerExternal ”:0
 860
 861 }
 862
 863 1. \ **Subnetwork Management**
 864
 865    1. \ **Create Subnets**
 866
 867 +---------------------+--------------------------------------------------------------------------------+
 868 | **IF Definition**   | **Description**                                                                |
 869 +=====================+================================================================================+
 870 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
 871 +---------------------+--------------------------------------------------------------------------------+
 872 | Operation           | POST                                                                           |
 873 +---------------------+--------------------------------------------------------------------------------+
 874 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                         |
 875 +---------------------+--------------------------------------------------------------------------------+
 876 | Description         | Create network and subnetwork on the VIM                                       |
 877 +---------------------+--------------------------------------------------------------------------------+
 878
 879 1. \ **Request**
 880
 881 +-------------------+-----------------+-------------------+------------------------+----------------------+
 882 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
 883 +===================+=================+===================+========================+======================+
 884 | networkId         | M               | 1                 | String                 | Network Id           |
 885 +-------------------+-----------------+-------------------+------------------------+----------------------+
 886 | name              | M               | 1                 | String                 | SubnetName           |
 887 +-------------------+-----------------+-------------------+------------------------+----------------------+
 888 | cidr              | M               | 1                 | String                 | Subnet cidr          |
 889 +-------------------+-----------------+-------------------+------------------------+----------------------+
 890 | ipVersion         | M               | 1                 | Int                    | Ip type              |
 891 |                   |                 |                   |                        |                      |
 892 |                   |                 |                   |                        | 4,6                  |
 893 +-------------------+-----------------+-------------------+------------------------+----------------------+
 894 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
 895 |                   |                 |                   |                        |                      |
 896 |                   |                 |                   |                        | 1: yes;0: no         |
 897 +-------------------+-----------------+-------------------+------------------------+----------------------+
 898 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
 899 +-------------------+-----------------+-------------------+------------------------+----------------------+
 900 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
 901 +-------------------+-----------------+-------------------+------------------------+----------------------+
 902 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
 903 +-------------------+-----------------+-------------------+------------------------+----------------------+
 904 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
 905 +-------------------+-----------------+-------------------+------------------------+----------------------+
 906 | -->allocation     |                 |                   |                        |                      |
 907 +-------------------+-----------------+-------------------+------------------------+----------------------+
 908 | -->start          | O               | 1                 | String                 | Start ip             |
 909 +-------------------+-----------------+-------------------+------------------------+----------------------+
 910 | -->end            | O               | 1                 | String                 | End ip               |
 911 +-------------------+-----------------+-------------------+------------------------+----------------------+
 912
 913 {
 914
 915 “tenant”: “tenant1”,
 916
 917 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
 918
 919 “subnetName”: “subnet1”,
 920
 921 “cidr”: “10.43.35.0/24”,
 922
 923 “ipVersion”: 4,
 924
 925 “enableDhcp”: 1,
 926
 927 “gatewayIp”: “10.43.35.1”,
 928
 929 “dnsNameservers”: [],
 930
 931 “allocationPools”:[{
 932
 933 “start”: “192.168.199.2”,
 934
 935 “end”: “192.168.199.254”
 936
 937 }],
 938
 939 “hostRoutes”: []
 940
 941 }
 942
 943 1. \ **Response**
 944
 945 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 946 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**                     |
 947 +===================+=================+===================+========================+=====================================+
 948 | returnCode        | M               | 1                 | int                    | 0: Already exist 1: Newly created   |
 949 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 950 | vimId             | M               | 1                 | String                 | vim id                              |
 951 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 952 | vimName           | O               | 1                 | string                 | vim name                            |
 953 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 954 | status            | M               | 1                 | string                 | subnetwork status                   |
 955 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 956 | id                | M               | 1                 | string                 | subNetwork id                       |
 957 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 958 | tenantId          | M               | 1                 | String                 | Tenant UUID                         |
 959 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 960 | networkId         | O               | 1                 | String                 | Network Id                          |
 961 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 962 | networkName       | O               | 1                 | String                 | Network Name                        |
 963 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 964 | name              | M               | 1                 | String                 | SubnetName                          |
 965 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 966 | cidr              | M               | 1                 | String                 | Subnet cidr                         |
 967 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 968 | ipVersion         | M               | 1                 | Int                    | Ip type                             |
 969 |                   |                 |                   |                        |                                     |
 970 |                   |                 |                   |                        | 4,6                                 |
 971 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 972 | enableDhcp        | O               | 1                 | boolean                | Whether to allow                    |
 973 |                   |                 |                   |                        |                                     |
 974 |                   |                 |                   |                        | 1: yes;0: no                        |
 975 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 976 | gatewayIp         | O               | 1                 | String                 | Gateway ip                          |
 977 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 978 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers                     |
 979 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 980 | hostRoutes        | O               | 1..n              | List of routes         | List of routes                      |
 981 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 982 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation                  |
 983 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 984 | -->allocation     |                 |                   |                        |                                     |
 985 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 986 | -->start          | O               | 1                 | String                 | Start ip                            |
 987 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 988 | -->end            | O               | 1                 | String                 | End ip                              |
 989 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 990
 991 202: accepted
 992
 993 500: failed
 994
 995 {
 996
 997     “returnCode”:0,
 998
 999     “vimId”:”11111”,
1000
1001     “vimName”:”11111”,
1002
1003 “status”:” ACTIVE”
1004
1005 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1006
1007 “tenant”: “tenant1”,
1008
1009 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1010
1011 “name”: “subnet1”,
1012
1013 “cidr”: “10.43.35.0/24”,
1014
1015 “ipVersion”: 4,
1016
1017 “enableDhcp”: 1,
1018
1019 “gatewayIp”: “10.43.35.1”,
1020
1021 “dnsNameservers”: [],
1022
1023 “allocationPools”:[{
1024
1025 “start”: “192.168.199.2”,
1026
1027 “end”: “192.168.199.254”
1028
1029 }],
1030
1031 “hostRoutes”: []
1032
1033 }
1034
1035 1. \ **Delete Subnets**
1036
1037 +---------------------+-------------------------------------------------------------------------------------------+
1038 | **IF Definition**   | **Description**                                                                           |
1039 +=====================+===========================================================================================+
1040 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId}   |
1041 +---------------------+-------------------------------------------------------------------------------------------+
1042 | Operation           | Delete                                                                                    |
1043 +---------------------+-------------------------------------------------------------------------------------------+
1044 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1045 +---------------------+-------------------------------------------------------------------------------------------+
1046
1047 1. \ **Request**
1048
1049 N/A
1050
1051 1. \ **Response**
1052
1053 204: no content
1054
1055 1. \ **List Subnets**
1056
1057 +---------------------+--------------------------------------------------------------------------------+
1058 | **IF Definition**   | **Description**                                                                |
1059 +=====================+================================================================================+
1060 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
1061 +---------------------+--------------------------------------------------------------------------------+
1062 | Operation           | get                                                                            |
1063 +---------------------+--------------------------------------------------------------------------------+
1064 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1065 +---------------------+--------------------------------------------------------------------------------+
1066
1067 1. \ **Query**
1068
1069 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
1070
1071 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1072 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                |
1073 +=================+=================+===================+===============+================================================================================================+
1074 | name            | O               | 1                 | String        | Filters fields of the response by a name, as a string. A valid value is the name of a subnet   |
1075 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
1076
1077 1. \ **Response**
1078
1079 +-------------------+-----------------+-------------------+------------------------+----------------------+
1080 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1081 +===================+=================+===================+========================+======================+
1082 | vimId             | M               | 1                 | String                 | vim id               |
1083 +-------------------+-----------------+-------------------+------------------------+----------------------+
1084 | vimName           | O               | 1                 | string                 | vim name             |
1085 +-------------------+-----------------+-------------------+------------------------+----------------------+
1086 | subnets           | M               | 0..N              | List                   | Network list         |
1087 +-------------------+-----------------+-------------------+------------------------+----------------------+
1088 | status            |                 | 1                 | string                 | subnetwork status    |
1089 +-------------------+-----------------+-------------------+------------------------+----------------------+
1090 | id                |                 | 1                 | string                 | subNetwork id        |
1091 +-------------------+-----------------+-------------------+------------------------+----------------------+
1092 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1093 +-------------------+-----------------+-------------------+------------------------+----------------------+
1094 | networkId         | O               | 1                 | String                 | Network Id           |
1095 +-------------------+-----------------+-------------------+------------------------+----------------------+
1096 | networkName       | O               | 1                 | String                 | Network Name         |
1097 +-------------------+-----------------+-------------------+------------------------+----------------------+
1098 | name              | M               | 1                 | String                 | SubnetName           |
1099 +-------------------+-----------------+-------------------+------------------------+----------------------+
1100 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1101 +-------------------+-----------------+-------------------+------------------------+----------------------+
1102 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1103 |                   |                 |                   |                        |                      |
1104 |                   |                 |                   |                        | 4,6                  |
1105 +-------------------+-----------------+-------------------+------------------------+----------------------+
1106 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1107 |                   |                 |                   |                        |                      |
1108 |                   |                 |                   |                        | 1: yes;0: no         |
1109 +-------------------+-----------------+-------------------+------------------------+----------------------+
1110 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1111 +-------------------+-----------------+-------------------+------------------------+----------------------+
1112 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1113 +-------------------+-----------------+-------------------+------------------------+----------------------+
1114 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1115 +-------------------+-----------------+-------------------+------------------------+----------------------+
1116 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
1117 +-------------------+-----------------+-------------------+------------------------+----------------------+
1118 | -->allocation     |                 |                   |                        |                      |
1119 +-------------------+-----------------+-------------------+------------------------+----------------------+
1120 | -->start          | O               | 1                 | String                 | Start ip             |
1121 +-------------------+-----------------+-------------------+------------------------+----------------------+
1122 | -->end            | O               | 1                 | String                 | End ip               |
1123 +-------------------+-----------------+-------------------+------------------------+----------------------+
1124
1125 **200: ok**
1126
1127 **500: failed**
1128
1129 {
1130
1131 “vimId”:”11111”,
1132
1133 “vimName”:”11111”,
1134
1135 "subnets":[
1136
1137     {
1138
1139 “status”:” ACTIVE”
1140
1141 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1142
1143 “tenant”: “tenant1”,
1144
1145 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1146
1147 “name”: “subnet1”,
1148
1149 “cidr”: “10.43.35.0/24”,
1150
1151 “ipVersion”: 4,
1152
1153 “enableDhcp”: 1,
1154
1155 “gatewayIp”: “10.43.35.1”,
1156
1157 “dnsNameservers”: [],
1158
1159 “allocationPools”:[{
1160
1161 “start”: “192.168.199.2”,
1162
1163 “end”: “192.168.199.254”
1164
1165 }],
1166
1167 “hostRoutes”: []
1168
1169     }
1170
1171 ]
1172
1173 }
1174
1175 1. \ **Get Subnets**
1176
1177 +---------------------+-------------------------------------------------------------------------------------------+
1178 | **IF Definition**   | **Description**                                                                           |
1179 +=====================+===========================================================================================+
1180 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid}   |
1181 +---------------------+-------------------------------------------------------------------------------------------+
1182 | Operation           | get                                                                                       |
1183 +---------------------+-------------------------------------------------------------------------------------------+
1184 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1185 +---------------------+-------------------------------------------------------------------------------------------+
1186
1187 1. \ **Request**
1188
1189 N/A
1190
1191 1. \ **Response**
1192
1193 +-------------------+-----------------+-------------------+------------------------+----------------------+
1194 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
1195 +===================+=================+===================+========================+======================+
1196 | vimId             | M               | 1                 | String                 | vim id               |
1197 +-------------------+-----------------+-------------------+------------------------+----------------------+
1198 | vimName           | O               | 1                 | string                 | vim name             |
1199 +-------------------+-----------------+-------------------+------------------------+----------------------+
1200 | status            |                 | 1                 | string                 | subnetwork status    |
1201 +-------------------+-----------------+-------------------+------------------------+----------------------+
1202 | id                |                 | 1                 | string                 | subNetwork id        |
1203 +-------------------+-----------------+-------------------+------------------------+----------------------+
1204 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
1205 +-------------------+-----------------+-------------------+------------------------+----------------------+
1206 | networkId         | O               | 1                 | String                 | Network Id           |
1207 +-------------------+-----------------+-------------------+------------------------+----------------------+
1208 | networkName       | O               | 1                 | String                 | Network Name         |
1209 +-------------------+-----------------+-------------------+------------------------+----------------------+
1210 | name              | M               | 1                 | String                 | SubnetName           |
1211 +-------------------+-----------------+-------------------+------------------------+----------------------+
1212 | cidr              | M               | 1                 | String                 | Subnet cidr          |
1213 +-------------------+-----------------+-------------------+------------------------+----------------------+
1214 | ipVersion         | M               | 1                 | Int                    | Ip type              |
1215 |                   |                 |                   |                        |                      |
1216 |                   |                 |                   |                        | 4,6                  |
1217 +-------------------+-----------------+-------------------+------------------------+----------------------+
1218 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
1219 |                   |                 |                   |                        |                      |
1220 |                   |                 |                   |                        | 1: yes;0: no         |
1221 +-------------------+-----------------+-------------------+------------------------+----------------------+
1222 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1223 +-------------------+-----------------+-------------------+------------------------+----------------------+
1224 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1225 +-------------------+-----------------+-------------------+------------------------+----------------------+
1226 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1227 +-------------------+-----------------+-------------------+------------------------+----------------------+
1228 | allocationPools   | O               | 1..n              | list of “allocation”   | list of allocation   |
1229 +-------------------+-----------------+-------------------+------------------------+----------------------+
1230 | -->allocation     |                 |                   |                        |                      |
1231 +-------------------+-----------------+-------------------+------------------------+----------------------+
1232 | -->start          | O               | 1                 | String                 | Start ip             |
1233 +-------------------+-----------------+-------------------+------------------------+----------------------+
1234 | -->end            | O               | 1                 | String                 | End ip               |
1235 +-------------------+-----------------+-------------------+------------------------+----------------------+
1236
1237 202: accepted
1238
1239 500: failed
1240
1241 {
1242
1243 “status”:” ACTIVE”
1244
1245 “id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23”
1246
1247 “tenant”: “tenant1”,
1248
1249 “network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”,
1250
1251 “name”: “subnet1”,
1252
1253 “cidr”: “10.43.35.0/24”,
1254
1255 “ipVersion”: 4,
1256
1257 “enableDhcp”: 1,
1258
1259 “gatewayIp”: “10.43.35.1”,
1260
1261 “dnsNameservers”: [],
1262
1263 “allocationPools”:[{
1264
1265 “start”: “192.168.199.2”,
1266
1267 “end”: “192.168.199.254”
1268
1269 }],
1270
1271 “hostRoutes”: []
1272
1273 }
1274
1275 1. \ **Virtual Port**
1276
1277    1. \ **Create Virtual Port**
1278
1279 +---------------------+------------------------------------------------------------------------------+
1280 | **IF Definition**   | **Description**                                                              |
1281 +=====================+==============================================================================+
1282 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports   |
1283 +---------------------+------------------------------------------------------------------------------+
1284 | Operation           | POST                                                                         |
1285 +---------------------+------------------------------------------------------------------------------+
1286 | Direction           | VNFLCM->MULTIVIM                                                             |
1287 +---------------------+------------------------------------------------------------------------------+
1288
1289 1. \ **Request**
1290
1291 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1292 | **Parameter**          | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                       |
1293 +========================+=================+===================+===============+=======================================================+
1294 | networkId              | M               | 1                 | string        | Network UUID                                          |
1295 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1296 | subnetId               | O               | 1                 | string        | Subnet UUID                                           |
1297 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1298 | name                   | M               | 1                 | string        | Port name                                             |
1299 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1300 | macAddress             | O               | 1                 | string        | Mac address                                           |
1301 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1302 | ip                     | O               | 1                 | string        | Ip address                                            |
1303 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1304 | vnicType               | O               | 1                 | string        | Virtual network card type,                            |
1305 |                        |                 |                   |               |                                                       |
1306 |                        |                 |                   |               | the value of three kinds of normal/direct/macvtap     |
1307 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1308 | \ **securityGroups**   | **O**           | **1**             | **string**    | **The IDs of security groups applied to the port.**   |
1309 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1310
1311 1. \ **Response**
1312
1313 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1314 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1315 +======================+=================+===================+===============+=====================================================+
1316 | returnCode           | M               | 1                 | int           | 0: Already exist 1: Newly created                   |
1317 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1318 | vimId                | M               | 1                 | String        | vim id                                              |
1319 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1320 | vimName              | O               | 1                 | string        | vim name                                            |
1321 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1322 | status               | M               | 1                 | string        | status                                              |
1323 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1324 | id                   | M               | 1                 | string        | Port Id                                             |
1325 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1326 | name                 | M               | 1                 | string        | Port name                                           |
1327 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1328 | tenantId             | M               | 1                 | String        | Tenant UUID                                         |
1329 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1330 | networkName          | M               | 1                 | string        | Network name                                        |
1331 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1332 | networkId            | M               | 1                 | string        | Network Id                                          |
1333 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1334 | subnetName           | M               | 1                 | string        | Subnet name                                         |
1335 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1336 | subnetId             | M               | 1                 | string        | SubnetId                                            |
1337 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1338 | macAddress           | O               | 1                 | string        | Mac address                                         |
1339 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1340 | ip                   | O               | 1                 | string        | Ip address                                          |
1341 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1342 | vnicType             | O               | 1                 | string        | Virtual network card type,                          |
1343 |                      |                 |                   |               |                                                     |
1344 |                      |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1345 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1346 | **securityGroups**   | **O**           | **1**             | **string**    | **List of security group names.**                   |
1347 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1348
1349 1. \ **Delete Virtual Port**
1350
1351 +---------------------+---------------------------------------------------------------------------------------+
1352 | **IF Definition**   | **Description**                                                                       |
1353 +=====================+=======================================================================================+
1354 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1355 +---------------------+---------------------------------------------------------------------------------------+
1356 | Operation           | DELETTE                                                                               |
1357 +---------------------+---------------------------------------------------------------------------------------+
1358 | Direction           | VNFLCM->MULTIVIM                                                                      |
1359 +---------------------+---------------------------------------------------------------------------------------+
1360
1361 1. \ **Request**
1362
1363 N/A
1364
1365 1. \ **Response**
1366
1367 204: no content
1368
1369 1. \ **List Virtual Port**
1370
1371 +---------------------+-----------------------------------------------------------------------------+
1372 | **IF Definition**   | **Description**                                                             |
1373 +=====================+=============================================================================+
1374 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports   |
1375 +---------------------+-----------------------------------------------------------------------------+
1376 | Operation           | GET                                                                         |
1377 +---------------------+-----------------------------------------------------------------------------+
1378 | Direction           | VNFLCM->MULTIVIM                                                            |
1379 +---------------------+-----------------------------------------------------------------------------+
1380
1381 1. \ **Query**
1382
1383 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1384 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                 |
1385 +=================+=================+===================+===============+=================================================+
1386 | name            | M               | 1                 | string        | Port name to filter out list of virtual ports   |
1387 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1388
1389 1. \ **Response**
1390
1391 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1392 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1393 +===================+=================+===================+===============+=====================================================+
1394 | vimId             | M               | 1                 | String        | vim id                                              |
1395 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1396 | vimName           | O               | 1                 | string        | vim name                                            |
1397 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1398 | tenantId          | M               | 1                 | String        | Tenant UUID                                         |
1399 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1400 | Ports             | M               | 0..N              | List          | ports                                               |
1401 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1402 | id                | M               | 1                 | string        | Port Id                                             |
1403 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1404 | name              | M               | 1                 | string        | Port name                                           |
1405 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1406 | status            | M               | 1                 | string        | status                                              |
1407 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1408 | **networkName**   | O               | 1                 | string        | Network name                                        |
1409 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1410 | networkId         | M               | 1                 | string        | Network Id                                          |
1411 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1412 | subnetName        | O               | 1                 | string        | Subnet name                                         |
1413 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1414 | subnetId          | M               | 1                 | string        | SubnetId                                            |
1415 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1416 | macAddress        | O               | 1                 | string        | Mac address                                         |
1417 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1418 | ip                | O               | 1                 | string        | Ip address                                          |
1419 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1420 | vnicType          | O               | 1                 | string        | Virtual network card type,                          |
1421 |                   |                 |                   |               |                                                     |
1422 |                   |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1423 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1424 | securityGroups    | O               | 1                 | string        | List of security group names.                       |
1425 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1426
1427 **200: ok**
1428
1429 **500: failed**
1430
1431 {
1432
1433 }
1434
1435 1. \ **Get Virtual Port**
1436
1437 +---------------------+---------------------------------------------------------------------------------------+
1438 | **IF Definition**   | **Description**                                                                       |
1439 +=====================+=======================================================================================+
1440 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1441 +---------------------+---------------------------------------------------------------------------------------+
1442 | Operation           | GET                                                                                   |
1443 +---------------------+---------------------------------------------------------------------------------------+
1444 | Direction           | VNFLCM->MULTIVIM                                                                      |
1445 +---------------------+---------------------------------------------------------------------------------------+
1446
1447 1. \ **Request**
1448
1449 N/A
1450
1451 1. \ **Response**
1452
1453 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1454 | **Parameter**    | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1455 +==================+=================+===================+===============+=====================================================+
1456 | vimId            | M               | 1                 | String        | vim id                                              |
1457 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1458 | vimName          | O               | 1                 | string        | vim name                                            |
1459 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1460 | status           | M               | 1                 | string        | status                                              |
1461 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1462 | id               | M               | 1                 | string        | Port Id                                             |
1463 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1464 | name             | M               | 1                 | string        | Port name                                           |
1465 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1466 | tenantId         | M               | 1                 | String        | Tenant UUID                                         |
1467 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1468 | networkName      | M               | 1                 | string        | Network name                                        |
1469 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1470 | networkId        | M               | 1                 | string        | Network Id                                          |
1471 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1472 | subnetName       | M               | 1                 | string        | Subnet name                                         |
1473 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1474 | subnetId         | M               | 1                 | string        | SubnetId                                            |
1475 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1476 | macAddress       | O               | 1                 | string        | Mac address                                         |
1477 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1478 | ip               | O               | 1                 | string        | Ip address                                          |
1479 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1480 | vnicType         | O               | 1                 | string        | Virtual network card type,                          |
1481 |                  |                 |                   |               |                                                     |
1482 |                  |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1483 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1484 | securityGroups   | O               | 1                 | string        | **List of security group names.**                   |
1485 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1486
1487 **200: ok**
1488
1489 **500: failed**
1490
1491 {
1492
1493 }
1494
1495 1. \ **Server Management**
1496
1497    1. \ **Create Server**
1498
1499 +---------------------+--------------------------------------------------------------------------------+
1500 | **IF Definition**   | **Description**                                                                |
1501 +=====================+================================================================================+
1502 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1503 +---------------------+--------------------------------------------------------------------------------+
1504 | Operation           | POST                                                                           |
1505 +---------------------+--------------------------------------------------------------------------------+
1506 | Direction           | VNFLCM->MULTIVIM                                                               |
1507 +---------------------+--------------------------------------------------------------------------------+
1508
1509 1. \ **Request**
1510
1511 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1512 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1513 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1514 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1515 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1516 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1517 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1518 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1519 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1520 | contextArray         | O               | 1..n              | list of context                       | list of context                                                                                                                                                                        |
1521 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1522 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1523 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1524 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1525 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1526 | flavorId             | M               | 1                 | String                                | server Flavor id                                                                                                                                                                       |
1527 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1528 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1529 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1530 | userdata             | O               | 1                 | string                                | Configuration information or scripts to use upon launch. Must be Base64 encoded.                                                                                                       |
1531 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1532 |                      |                 |                   |                                       | 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.                                                       |
1533 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1534 | **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.**   |
1535 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1536 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1537 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1538
1539 **boot**
1540
1541 +-----------------+-----------------+-------------------+---------------+---------------------------+
1542 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**           |
1543 +=================+=================+===================+===============+===========================+
1544 | type            | M               | 1                 | int           | Startup mode              |
1545 |                 |                 |                   |               |                           |
1546 |                 |                 |                   |               | 1. boot from the volume   |
1547 |                 |                 |                   |               |                           |
1548 |                 |                 |                   |               | 2. boot from image        |
1549 +-----------------+-----------------+-------------------+---------------+---------------------------+
1550 | volumeId        | O               | 1                 | string        | Volume Id(type=1)         |
1551 +-----------------+-----------------+-------------------+---------------+---------------------------+
1552 | imageId         | O               | 1                 | String        | ImageId（type=2）         |
1553 +-----------------+-----------------+-------------------+---------------+---------------------------+
1554
1555 **contextArray**
1556
1557 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1558 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                           |
1559 +=================+=================+===================+===============+===========================================================================================================================================================+
1560 | fileName        | M               | 1                 | String        | Injection file name                                                                                                                                       |
1561 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1562 | 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. )   |
1563 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1564
1565 volumeArray
1566
1567 +-----------------+-----------------+-------------------+---------------+-------------------+
1568 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1569 +=================+=================+===================+===============+===================+
1570 | volumeId        | M               | 1                 | String        | Volume Id         |
1571 +-----------------+-----------------+-------------------+---------------+-------------------+
1572
1573 nicArray
1574
1575 +-----------------+-----------------+-------------------+---------------+-------------------+
1576 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1577 +=================+=================+===================+===============+===================+
1578 | portId          | M               | 1                 | String        | Port Id           |
1579 +-----------------+-----------------+-------------------+---------------+-------------------+
1580
1581 **metadata**
1582
1583 +-----------------+-----------------+-------------------+---------------+-------------------+
1584 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1585 +=================+=================+===================+===============+===================+
1586 | keyName         | M               | 1                 | String        | Key name          |
1587 +-----------------+-----------------+-------------------+---------------+-------------------+
1588 | value           | M               | 1                 | string        | value             |
1589 +-----------------+-----------------+-------------------+---------------+-------------------+
1590
1591 {
1592
1593 "tenant": "tenant1",
1594
1595 "name": "vm1",
1596
1597 “availabilityZone”:”az1”,
1598
1599 “flavorName”:”vm\_large”,
1600
1601 "boot": {
1602
1603 "type": 1,
1604
1605 " volumeName": "volume1"
1606
1607 },
1608
1609 “flavorId”:”vm\_large\_134213”
1610
1611 "contextArray": [{
1612
1613 "fileName": "test.yaml",
1614
1615 "fileData": "….”
1616
1617 }],
1618
1619 "volumeArray": [{
1620
1621 "volumeName": "vol1",
1622
1623 }],
1624
1625 “nicArray”:[{
1626
1627     “portId”:”port\_a”
1628
1629 }]
1630
1631 “metada”: [{
1632
1633 "keyName": "foo",
1634
1635 "value": "foo value”
1636
1637 }],
1638
1639 “userdata”:”abcdedf”
1640
1641 }
1642
1643 1. \ **Response**
1644
1645 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1646 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                          | **Description**                                                                                                                                                                        |
1647 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1648 | vimId                | M               | 1                 | String                               | vim id                                                                                                                                                                                 |
1649 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1650 | vimName              | O               | 1                 | string                               | vim name                                                                                                                                                                               |
1651 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1652 | returnCode           |                 | 1                 | int                                  | 0: Already exist 1: Newly created                                                                                                                                                      |
1653 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1654 | id                   | M               | 1                 | string                               | server id                                                                                                                                                                              |
1655 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1656 | name                 |                 | 1                 | string                               | server name                                                                                                                                                                            |
1657 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1658 | tenantId             | M               | 1                 | String                               | Tenant UUID                                                                                                                                                                            |
1659 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1660 | boot                 | M               | 1                 | String                               | Start parameters                                                                                                                                                                       |
1661 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1662 | nicArray             | O               | 1..n              | List of nic                          | List of nic                                                                                                                                                                            |
1663 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1664 | volumeArray          | O               | 1..n              | list of volume                       | list of volume                                                                                                                                                                         |
1665 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1666 | availabilityZone     | O               | 1                 | string                               | Usable field                                                                                                                                                                           |
1667 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1668 | flavorId             | M               | 1                 | String                               | server Flavor                                                                                                                                                                          |
1669 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1670 | metadata             | O               | 1                 | List of metadata                     | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1671 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1672 | **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.**   |
1673 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1674 |                      |                 |                   |                                      | **[TBD]**                                                                                                                                                                              |
1675 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1676 | **serverGroup**      | **O**           | **1**             | **string**                           | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1677 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1678 |                      |                 |                   |                                      | [TBD]                                                                                                                                                                                  |
1679 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1680 | **status**           | **M**           | **1**             | **string**                           | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR                                                                                                                                             |
1681 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1682
1683 202: accepted
1684
1685 500: failed
1686
1687 {
1688
1689 "id": "3c9eebdbbfd345658269340b9ea6fb73",
1690
1691 "name": "vm1",
1692
1693 "returnCode": 1,
1694
1695 }
1696
1697 1. \ **Delete Server**
1698
1699 +---------------------+-------------------------------------------------------------------------------------------+
1700 | **IF Definition**   | **Description**                                                                           |
1701 +=====================+===========================================================================================+
1702 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1703 +---------------------+-------------------------------------------------------------------------------------------+
1704 | Operation           | DELETE                                                                                    |
1705 +---------------------+-------------------------------------------------------------------------------------------+
1706 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1707 +---------------------+-------------------------------------------------------------------------------------------+
1708
1709 1. \ **Request**
1710
1711 N/A
1712
1713 1. \ **Response**
1714
1715 204: no content
1716
1717 1. \ **List Server**
1718
1719 +---------------------+--------------------------------------------------------------------------------+
1720 | **IF Definition**   | **Description**                                                                |
1721 +=====================+================================================================================+
1722 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1723 +---------------------+--------------------------------------------------------------------------------+
1724 | Operation           | get                                                                            |
1725 +---------------------+--------------------------------------------------------------------------------+
1726 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1727 +---------------------+--------------------------------------------------------------------------------+
1728
1729 1. \ **Request**
1730
1731 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1732
1733 +-----------------+-----------------+-------------------+---------------+-------------------+
1734 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1735 +=================+=================+===================+===============+===================+
1736 | name            | M               | 1                 | string        | server name       |
1737 +-----------------+-----------------+-------------------+---------------+-------------------+
1738
1739 1. \ **Response**
1740
1741 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1742 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1743 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1744 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1745 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1746 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1747 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1748 | servers              | M               | 1                 | array                                 | server list                                                                                                                                                                            |
1749 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1750 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1751 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1752 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1753 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1754 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1755 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1756 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1757 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1758 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1759 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1760 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1761 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1762 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1763 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1764 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1765 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1766 | metada               | O               | 1                 | keypair                               | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1767 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1768 | **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.**   |
1769 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1770 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1771 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1772 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1773 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1774 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1775 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1776
1777 200: ok
1778
1779 500: failed
1780
1781 {
1782
1783 }
1784
1785 1. \ **Get Server**
1786
1787 +---------------------+-------------------------------------------------------------------------------------------+
1788 | **IF Definition**   | **Description**                                                                           |
1789 +=====================+===========================================================================================+
1790 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1791 +---------------------+-------------------------------------------------------------------------------------------+
1792 | Operation           | get                                                                                       |
1793 +---------------------+-------------------------------------------------------------------------------------------+
1794 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1795 +---------------------+-------------------------------------------------------------------------------------------+
1796
1797 1. \ **Request**
1798
1799 N/A
1800
1801 1. \ **Response**
1802
1803 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1804 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1805 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1806 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1807 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1808 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1809 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1810 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1811 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1812 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1813 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1814 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1815 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1816 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1817 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1818 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1819 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1820 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1821 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1822 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1823 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1824 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1825 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1826 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1827 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1828 | **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.**   |
1829 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1830 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1831 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1832 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1833 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1834 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1835 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1836
1837 200: ok
1838
1839 500: failed
1840
1841 {
1842
1843 }
1844
1845 1. \ **Flavor Management**
1846
1847    1. \ **Create Flavor**
1848
1849 +---------------------+--------------------------------------------------------------------------------+
1850 | **IF Definition**   | **Description**                                                                |
1851 +=====================+================================================================================+
1852 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors   |
1853 +---------------------+--------------------------------------------------------------------------------+
1854 | Operation           | POST                                                                           |
1855 +---------------------+--------------------------------------------------------------------------------+
1856 | Direction           | VNFLCM->MULTIVIM                                                               |
1857 +---------------------+--------------------------------------------------------------------------------+
1858
1859 1. \ **Request**
1860
1861 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1862 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1863 +=================+=================+===================+===============================+==============================================================================================================================+
1864 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1865 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1866 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1867 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1868 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1869 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1870 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1871 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1872 | ephemeral       | O               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1873 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1874 | swap            | O               | 1                 | int                           | The size of the swap disk                                                                                                    |
1875 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1876 | 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.   |
1877 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1878 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1879 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1880
1881 1. \ **Response**
1882
1883 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1884 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                                              |
1885 +=================+=================+===================+===========================+==============================================================================================================================+
1886 | id              | M               | 1                 | string                    | Flavor id                                                                                                                    |
1887 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1888 | name            | M               | 1                 | string                    | Flavor name                                                                                                                  |
1889 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1890 | returnCode      | M               | 1                 | int                       | 0: Already exist 1: Newly created                                                                                            |
1891 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1892 | tenantId        | M               | 1                 | String                    | Tenant UUID                                                                                                                  |
1893 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1894 | vcpu            | M               | 1                 | int                       | Virtual CPU number                                                                                                           |
1895 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1896 | memory          | M               | 1                 | int                       | Memory size                                                                                                                  |
1897 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1898 | disk            | M               | 1                 | int                       | The size of the root disk                                                                                                    |
1899 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1900 | ephemeral       | M               | 1                 | int                       | The size of the ephemeral disk                                                                                               |
1901 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1902 | swap            | M               | 1                 | int                       | The size of the swap disk                                                                                                    |
1903 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1904 | 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.   |
1905 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1906 | extraSpecs      | O               | 0..N              | List of Key-value pairs   | EPA parameter                                                                                                                |
1907 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1908 | vimId           | M               | 1                 | String                    | vim id                                                                                                                       |
1909 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1910 | vimName         | O               | 1                 | string                    | vim name                                                                                                                     |
1911 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1912
1913 1. \ **Delete Flavor**
1914
1915 +---------------------+--------------------------------------------------------------------------------------------+
1916 | **IF Definition**   | **Description**                                                                            |
1917 +=====================+============================================================================================+
1918 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid}   |
1919 +---------------------+--------------------------------------------------------------------------------------------+
1920 | Operation           | DELETE                                                                                     |
1921 +---------------------+--------------------------------------------------------------------------------------------+
1922 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                      |
1923 +---------------------+--------------------------------------------------------------------------------------------+
1924
1925 1. \ **Request**
1926
1927 N/A
1928
1929 1. \ **Response**
1930
1931 204: no content
1932
1933 1. \ **List Flavor**
1934
1935 +---------------------+---------------------------------------------------------------------------------+
1936 | **IF Definition**   | **Description**                                                                 |
1937 +=====================+=================================================================================+
1938 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors   |
1939 +---------------------+---------------------------------------------------------------------------------+
1940 | Operation           | get                                                                             |
1941 +---------------------+---------------------------------------------------------------------------------+
1942 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
1943 +---------------------+---------------------------------------------------------------------------------+
1944
1945 1. \ **Query**
1946
1947 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1948 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                  |
1949 +=================+=================+===================+===============+==================================+
1950 | name            | M               | 1                 | string        | Flavor name to filter out list   |
1951 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1952
1953 1. \ **Response**
1954
1955 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1956 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1957 +=================+=================+===================+===============================+==============================================================================================================================+
1958 | flavors         | M               | 0..N              | list                          | Vm list                                                                                                                      |
1959 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1960 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
1961 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1962 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1963 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1964 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1965 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1966 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1967 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1968 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1969 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1970 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1971 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1972 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
1973 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1974 | 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.   |
1975 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1976 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1977 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1978 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
1979 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1980 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
1981 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1982 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
1983 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1984
1985 200: ok
1986
1987 500: failed
1988
1989 1. \ **Get Flavor**
1990
1991 +---------------------+----------------------------------------------------------------------------------------------+
1992 | **IF Definition**   | **Description**                                                                              |
1993 +=====================+==============================================================================================+
1994 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid }   |
1995 +---------------------+----------------------------------------------------------------------------------------------+
1996 | Operation           | get                                                                                          |
1997 +---------------------+----------------------------------------------------------------------------------------------+
1998 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                        |
1999 +---------------------+----------------------------------------------------------------------------------------------+
2000
2001 1. \ **Request**
2002
2003 N/A
2004
2005 1. \ **Response**
2006
2007 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2008 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
2009 +=================+=================+===================+===============================+==============================================================================================================================+
2010 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
2011 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2012 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
2013 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2014 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
2015 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2016 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
2017 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2018 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
2019 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2020 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
2021 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2022 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
2023 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2024 | 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.   |
2025 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2026 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
2027 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2028 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
2029 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2030 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
2031 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2032 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
2033 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
2034
2035 200: ok
2036
2037 500: failed
2038
2039 1. \ **Volume Management**
2040
2041    1. \ **Create Volume**
2042
2043 +---------------------+--------------------------------------------------------------------------------+
2044 | **IF Definition**   | **Description**                                                                |
2045 +=====================+================================================================================+
2046 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2047 +---------------------+--------------------------------------------------------------------------------+
2048 | Operation           | POST                                                                           |
2049 +---------------------+--------------------------------------------------------------------------------+
2050 | Direction           | NSLCM->MULTIVIM                                                                |
2051 +---------------------+--------------------------------------------------------------------------------+
2052
2053 1. \ **Request**
2054
2055 +--------------------+-----------------+-------------------+---------------+-------------------+
2056 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2057 +====================+=================+===================+===============+===================+
2058 | name               | M               | 1                 | string        | Volume name       |
2059 +--------------------+-----------------+-------------------+---------------+-------------------+
2060 | volumeSize         | M               | 1                 | int           | Volume size       |
2061 +--------------------+-----------------+-------------------+---------------+-------------------+
2062 | imageId            | O               | 1                 | string        | Image UUID        |
2063 +--------------------+-----------------+-------------------+---------------+-------------------+
2064 | volumeType         | O               | 1                 | string        | Volume type       |
2065 +--------------------+-----------------+-------------------+---------------+-------------------+
2066 | availabilityZone   | O               | 1                 | string        | Usable field      |
2067 +--------------------+-----------------+-------------------+---------------+-------------------+
2068
2069     {
2070
2071     "tenant": "tenant1",
2072
2073     "volumeName": "volume1",
2074
2075     "volumeSize": 3,
2076
2077     "imageName": "cirros.qcow2",
2078
2079     "volumeType": "volumetype1",
2080
2081     "availabilityZone": "zone1"
2082
2083     }
2084
2085 1. \ **Response**
2086
2087 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2088 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2089 +====================+=================+===================+===============+=====================================+
2090 | returnCode         | M               | 1                 | int           | 0: Already exist 1: Newly created   |
2091 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2092 | vimId              | M               | 1                 | String        | vim id                              |
2093 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2094 | vimName            | O               | 1                 | string        | vim name                            |
2095 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2096 | tenantId           | M               | 1                 | String        | Tenant UUID                         |
2097 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2098 | status             | M               | 1                 | string        | Volume status                       |
2099 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2100 | id                 | M               | 1                 | string        | Volume id                           |
2101 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2102 | name               | M               | 1                 | string        | Volume name                         |
2103 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2104 | volumeType         | O               | 1                 | string        | Volume type                         |
2105 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2106 | availabilityZone   | O               | 1                 | string        | Availability Zone                   |
2107 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
2108
2109 202: accepted
2110
2111 500: failed
2112
2113     {
2114
2115     "id": "bc9eebdbbfd356458269340b9ea6fb73",
2116
2117     "name": "volume1",
2118
2119     "returnCode": 1,
2120
2121     }
2122
2123 1. \ **Delete Volume**
2124
2125 +---------------------+-------------------------------------------------------------------------------------------+
2126 | **IF Definition**   | **Description**                                                                           |
2127 +=====================+===========================================================================================+
2128 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId}   |
2129 +---------------------+-------------------------------------------------------------------------------------------+
2130 | Operation           | DELETE                                                                                    |
2131 +---------------------+-------------------------------------------------------------------------------------------+
2132 | Direction           | NSLCM->MULTIVIM                                                                           |
2133 +---------------------+-------------------------------------------------------------------------------------------+
2134
2135 1. \ **Request**
2136
2137     N/A
2138
2139 1. \ **Response**
2140
2141     204: no content
2142
2143 1. \ **List Volumes**
2144
2145 +---------------------+--------------------------------------------------------------------------------+
2146 | **IF Definition**   | **Description**                                                                |
2147 +=====================+================================================================================+
2148 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
2149 +---------------------+--------------------------------------------------------------------------------+
2150 | Operation           | GET                                                                            |
2151 +---------------------+--------------------------------------------------------------------------------+
2152 | Direction           | NSLCM-> MULTIVIM                                                               |
2153 +---------------------+--------------------------------------------------------------------------------+
2154
2155 1. \ **Request**
2156
2157     msb.onap.org:80/api/multicloud/v0/{cloud
2158     owner}\_{region}/volumes?{……}
2159
2160 +-----------------+-----------------+-------------------+---------------+-------------------+
2161 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2162 +=================+=================+===================+===============+===================+
2163 | name            | M               | 1                 | string        | Volume name       |
2164 +-----------------+-----------------+-------------------+---------------+-------------------+
2165
2166 1. \ **Response**
2167
2168 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2169 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2170 +====================+=================+===================+======================+====================================================+
2171 | vimId              | M               | 1                 | String               | vim id                                             |
2172 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2173 | vimName            | O               | 1                 | string               | vim name                                           |
2174 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2175 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2176 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2177 | volumes            | M               | 1                 | Array                |                                                    |
2178 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2179 | id                 | M               | 1                 | string               | Volume id                                          |
2180 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2181 | name               | M               | 1                 | string               | Volume name                                        |
2182 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2183 | createTime         | O               | 1                 | string               | Create time                                        |
2184 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2185 | status             | M               | 1                 | string               | Volume status                                      |
2186 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2187 | volumeSize         | M               | 1                 | int                  | Volume size                                        |
2188 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2189 | volumeType         | M               | 1                 | string               | Volume type                                        |
2190 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2191 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2192 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2193 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2194 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2195
2196 200: ok
2197
2198 500: failed
2199
2200     {
2201
2202     "volumes": [
2203
2204     {
2205
2206     "status": "available",
2207
2208     "name": "test",
2209
2210     "attachments": [],
2211
2212     "createTime": "2015-12-02T07:57:23.000000",
2213
2214     " volumeType ": "ws",
2215
2216     "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2217
2218     "size": 20
2219
2220     },
2221
2222     {
2223
2224     "status": "in-use",
2225
2226     "name": "wangsong",
2227
2228     "attachments": [
2229
2230     {
2231
2232     "device": "/dev/vdc",
2233
2234     "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2235
2236     "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2237
2238     "hostName": null,
2239
2240     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2241
2242     }
2243
2244     ],
2245
2246     "createTime": "2015-12-02T06:39:40.000000",
2247
2248     " volumeType ": null,
2249
2250     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2251
2252     "size": 40
2253
2254     }
2255
2256     ]
2257
2258     }
2259
2260 1. \ **Get Volumes**
2261
2262 +---------------------+-------------------------------------------------------------------------------------------+
2263 | **IF Definition**   | **Description**                                                                           |
2264 +=====================+===========================================================================================+
2265 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid}   |
2266 +---------------------+-------------------------------------------------------------------------------------------+
2267 | Operation           | GET                                                                                       |
2268 +---------------------+-------------------------------------------------------------------------------------------+
2269 | Direction           | NSLCM-> MULTIVIM                                                                          |
2270 +---------------------+-------------------------------------------------------------------------------------------+
2271
2272 1. \ **Request**
2273
2274     N/A
2275
2276 1. \ **Response**
2277
2278 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2279 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2280 +====================+=================+===================+======================+====================================================+
2281 | vimId              | M               | 1                 | String               | vim id                                             |
2282 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2283 | vimName            | O               | 1                 | string               | vim name                                           |
2284 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2285 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2286 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2287 | id                 |                 | 1                 | string               | Volume id                                          |
2288 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2289 | name               |                 | 1                 | string               | Volume name                                        |
2290 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2291 | createTime         |                 | 1                 | string               | Create time                                        |
2292 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2293 | status             |                 | 1                 | string               | Volume status                                      |
2294 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2295 | volumeType         |                 | 1                 | list of string       | Volume type                                        |
2296 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2297 | volumeSize         |                 | 1                 | int                  | Volume size                                        |
2298 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2299 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2300 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2301 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2302 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2303
2304 **attachment：**
2305
2306 +-----------------+-----------------+-------------------+---------------+-------------------+
2307 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2308 +=================+=================+===================+===============+===================+
2309 | device          |                 | 1                 | string        | Device name       |
2310 +-----------------+-----------------+-------------------+---------------+-------------------+
2311 | serverId        |                 | 1                 | string        | VM id             |
2312 +-----------------+-----------------+-------------------+---------------+-------------------+
2313 | volumeId        |                 | 1                 | string        | Volume id         |
2314 +-----------------+-----------------+-------------------+---------------+-------------------+
2315 | hostName        |                 | 1                 | string        | Host name         |
2316 +-----------------+-----------------+-------------------+---------------+-------------------+
2317 | id              |                 | 1                 | string        | Device id         |
2318 +-----------------+-----------------+-------------------+---------------+-------------------+
2319
2320 200: ok
2321
2322 500: failed
2323
2324     {
2325
2326     "status": "in-use",
2327
2328     "name": "wangsong",
2329
2330     "attachments": [
2331
2332     {
2333
2334     "device": "/dev/vdc",
2335
2336     "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2337
2338     "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2339
2340     "hostName": null,
2341
2342     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2343
2344     }
2345
2346     ],
2347
2348     "createTime": "2015-12-02T06:39:40.000000",
2349
2350     "volumeType ": null,
2351
2352     "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2353
2354     "volumeSize ": 40
2355
2356     }
2357
2358 1. \ **Tenant Management**
2359
2360    1. \ **List tenants**
2361
2362 +---------------------+---------------------------------------------------------------------+
2363 | **IF Definition**   | **Description**                                                     |
2364 +=====================+=====================================================================+
2365 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants   |
2366 +---------------------+---------------------------------------------------------------------+
2367 | Operation           | GET                                                                 |
2368 +---------------------+---------------------------------------------------------------------+
2369 | Direction           | NSLCM-> MULTIVIM                                                    |
2370 +---------------------+---------------------------------------------------------------------+
2371
2372 1. \ **Query**
2373
2374 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2375 | **Parameter**       | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2376 +=====================+=================+===================+===============+=====================================+
2377 | name={tenantname}   | O               | 1                 | string        | Tenant name to filter output list   |
2378 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2379
2380 1. \ **Response**
2381
2382 +-----------------+-----------------+-------------------+---------------+-------------------+
2383 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2384 +=================+=================+===================+===============+===================+
2385 | vimId           | M               | 1                 | String        | vim id            |
2386 +-----------------+-----------------+-------------------+---------------+-------------------+
2387 | vimName         | O               | 1                 | string        | vim name          |
2388 +-----------------+-----------------+-------------------+---------------+-------------------+
2389 | tenants         | M               | 1                 | Array         |                   |
2390 +-----------------+-----------------+-------------------+---------------+-------------------+
2391 | id              | M               | 1                 | string        | tenant UUID       |
2392 +-----------------+-----------------+-------------------+---------------+-------------------+
2393 | name            | M               | 1                 | string        | tenant name       |
2394 +-----------------+-----------------+-------------------+---------------+-------------------+
2395
2396 200: ok
2397
2398 500: failed
2399
2400     {
2401
2402     " tenants ": [
2403
2404     {
2405
2406     "id": "1",
2407
2408     "name": "test\_a"
2409
2410     }
2411
2412     ]
2413
2414     }
2415
2416 1. \ **Limits**
2417
2418    1. \ **List Limits of resouces: CPU&Memory, volume,network,etc**
2419
2420 +---------------------+-------------------------------------------------------------------------------+
2421 | **IF Definition**   | **Description**                                                               |
2422 +=====================+===============================================================================+
2423 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits   |
2424 +---------------------+-------------------------------------------------------------------------------+
2425 | Operation           | GET                                                                           |
2426 +---------------------+-------------------------------------------------------------------------------+
2427 | Direction           | NSLCM-> MULTIVIM                                                              |
2428 +---------------------+-------------------------------------------------------------------------------+
2429
2430 1. \ **Request**
2431
2432 2. \ **Response**
2433
2434 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2435 | **Parameter**             | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                  |
2436 +===========================+=================+===================+===============+==================================================================+
2437 | vimId                     | M               | 1                 | String        | vim id                                                           |
2438 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2439 | vimName                   | O               | 1                 | string        | vim name                                                         |
2440 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2441 | tenantId                  | M               | 1                 | string        | Tenant UUID                                                      |
2442 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2443 | maxPersonality            | O               | 1                 | int           | The number of allowed injected files for each tenant.            |
2444 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2445 | maxPersonalitySize        | O               | 1                 | int           | The number of allowed bytes of content for each injected file.   |
2446 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2447 | maxServerGroupMembers     | O               | 1                 | int           | The number of allowed members for each server group.             |
2448 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2449 | maxServerGroups           | O               | 1                 | int           | The number of allowed server groups for each tenant.             |
2450 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2451 | maxServerMeta             | O               | 1                 | int           | The number of allowed metadata items for each instance.          |
2452 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2453 | maxTotalCores             | O               | 1                 | int           | The number of allowed instance cores for each tenant.            |
2454 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2455 | maxTotalInstances         | O               | 1                 | int           | The number of allowed instances for each tenant.                 |
2456 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2457 | maxTotalKeypairs          | O               | 1                 | int           | The number of allowed key pairs for each user.                   |
2458 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2459 | maxTotalRAMSize           | O               | 1                 | int           | The amount of allowed instance RAM, in MB, for each tenant.      |
2460 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2461 | maxTotalVolumeGigabytes   | O               | 1                 | int           | The maximum total amount of volumes, in gibibytes (GiB).         |
2462 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2463 | maxTotalVolumes           | O               | 1                 | int           | The maximum number of volumes.                                   |
2464 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2465 | totalVolumesUsed          | O               | 1                 | int           | The total number of volumes used.                                |
2466 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2467 | totalGigabytesUsed        | O               | 1                 | int           | The total number of gibibytes (GiB) used.                        |
2468 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2469 | network                   | O               | 1                 | int           | The number of networks allowed for each project.                 |
2470 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2471 | subnet                    | O               | 1                 | int           | The number of subnets allowed for each project.                  |
2472 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2473 | subnetpool                | O               | 1                 | int           | The number of subnet pools allowed for each project.             |
2474 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2475 | security\_group\_rule     | O               | 1                 | int           | The number of security group rules allowed for each project.     |
2476 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2477 | security\_group           | O               | 1                 | int           | The number of security groups allowed for each project.          |
2478 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2479 | router                    | O               | 1                 | int           | The number of routers allowed for each project.                  |
2480 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2481 | port                      | O               | 1                 | int           | The number of ports allowed for each project.                    |
2482 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2483
2484 200: ok
2485
2486 500: failed
2487
2488     {
2489
2490     "maxPersonality": 5,
2491
2492     "maxPersonalitySize": 10240,
2493
2494     "maxServerMeta": 128,
2495
2496     "maxTotalCores": 20,
2497
2498     "maxTotalInstances": 10,
2499
2500     "maxTotalKeypairs": 100,
2501
2502     "maxTotalRAMSize": 51200,
2503
2504     "maxServerGroups": 10,
2505
2506     "maxServerGroupMembers": 10,
2507
2508     }
2509
2510 1. \ **Host Management**
2511
2512    1. \ **List hosts**
2513
2514 +---------------------+------------------------------------------------------------------------------+
2515 | **IF Definition**   | **Description**                                                              |
2516 +=====================+==============================================================================+
2517 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts   |
2518 +---------------------+------------------------------------------------------------------------------+
2519 | Operation           | GET                                                                          |
2520 +---------------------+------------------------------------------------------------------------------+
2521 | Direction           | NSLCM-> MULTIVIM                                                             |
2522 +---------------------+------------------------------------------------------------------------------+
2523
2524 1. \ **Request**
2525
2526 2. \ **Response**
2527
2528 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2529 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**     | **Description**                   |
2530 +=================+=================+===================+=================+===================================+
2531 | vimId           | M               | 1                 | String          | vim id                            |
2532 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2533 | vimName         | O               | 1                 | string          | vim name                          |
2534 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2535 | tenantId        | M               | 1                 | string          | Tenant Name                       |
2536 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2537 | hosts           | M               | 1                 | Array of host   | List of host information          |
2538 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2539 | service         | M               | 1                 | string          | The service running on the host   |
2540 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2541 | name            | M               | 1                 | string          | host name                         |
2542 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2543 | zone            | O               | 1                 | string          | Available zone for the host       |
2544 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2545
2546 200: ok
2547
2548 500: failed
2549
2550     {
2551
2552     "vimId": "123",
2553
2554     "vimName": "vimName",
2555
2556     "tenantId": "tenantId1"
2557
2558     "hosts": [
2559
2560     {
2561
2562     "name": "b6e4adbc193d428ea923899d07fb001e",
2563
2564     "service": "conductor",
2565
2566     "zone": "internal",
2567
2568     "vimId": "123",
2569
2570     "vimName": "vimName",
2571
2572     "tenantId": "tenantId1"
2573
2574     },
2575
2576     {
2577
2578     "name": "09c025b0efc64211bd23fc50fa974cdf",
2579
2580     "service": "compute",
2581
2582     "zone": "nova"
2583
2584     "vimId": "123",
2585
2586     "vimName": "vimName",
2587
2588     "tenantId": "tenantId1"
2589
2590     },
2591
2592     {
2593
2594     "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2595
2596     "service": "consoleauth",
2597
2598     "zone": "internal"
2599
2600     "vimId": "123",
2601
2602     "vimName": "vimName",
2603
2604     "tenantId": "tenantId1"
2605
2606     },
2607
2608     {
2609
2610     "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2611
2612     "service": "network",
2613
2614     "zone": "internal"
2615
2616     "vimId": "123",
2617
2618     "vimName": "vimName",
2619
2620     "tenantId": "tenantId1"
2621
2622     },
2623
2624     {
2625
2626     "name": "abffda96592c4eacaf4111c28fddee17",
2627
2628     "service": "scheduler",
2629
2630     "zone": "internal"
2631
2632     "vimId": "123",
2633
2634     "vimName": "vimName",
2635
2636     "tenantId": "tenantId1"
2637
2638     }
2639
2640     ]
2641
2642     }
2643
2644 1. \ **Get host**
2645
2646 +---------------------+-----------------------------------------------------------------------------------------+
2647 | **IF Definition**   | **Description**                                                                         |
2648 +=====================+=========================================================================================+
2649 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts/{hostname}   |
2650 +---------------------+-----------------------------------------------------------------------------------------+
2651 | Operation           | GET                                                                                     |
2652 +---------------------+-----------------------------------------------------------------------------------------+
2653 | Direction           | NSLCM-> MULTIVIM                                                                        |
2654 +---------------------+-----------------------------------------------------------------------------------------+
2655
2656 1. \ **Request**
2657
2658 2. \ **Response**
2659
2660 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2661 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**         | **Description**                                              |
2662 +=================+=================+===================+=====================+==============================================================+
2663 | vimId           | M               | 1                 | String              | vim id                                                       |
2664 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2665 | vimName         | O               | 1                 | string              | vim name                                                     |
2666 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2667 | tenantId        | M               | 1                 | string              | Tenant Name                                                  |
2668 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2669 | host            | M               | 1                 | List of resources   | Host resource info                                           |
2670 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2671 | resource        | M               | 1..N              | Object              | Resource description                                         |
2672 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2673 | cpu             | M               | 1                 | Int                 | The cpu info on the host.                                    |
2674 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2675 | memory\_mb      | M               | 1                 | int                 | The memory info on the host (in MB).                         |
2676 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2677 | name            | M               | 1                 | string              | host name                                                    |
2678 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2679 | project         | M               | 1                 | string              | Value: total, used\_now, used\_max or specific project\_id   |
2680 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2681 | disk\_gb        | M               | 1                 | int                 | The disk info on the host (in GB).                           |
2682 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2683
2684 200: ok
2685
2686 500: failed
2687
2688 {
2689
2690 "cpu": 1,
2691
2692 "disk\_gb": 1028,
2693
2694 "name": "c1a7de0ac9d94e4baceae031d05caae3",
2695
2696 "memory\_mb": 8192,
2697
2698 "vimId": "123",
2699
2700 "vimName": "vimName",
2701
2702 "tenantId": "tenantId1"
2703
2704 }
2705
2706     {
2707
2708     "host": [
2709
2710     {
2711
2712     "memory\_mb": 4960,
2713
2714     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2715
2716     "disk\_gb": 92,
2717
2718     "project": "(total)",
2719
2720     "cpu": 4
2721
2722     },
2723
2724     {
2725
2726     "memory\_mb": 1536,
2727
2728     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2729
2730     "disk\_gb": 2,
2731
2732     "project": "(used\_now)",
2733
2734     "cpu": 2
2735
2736     },
2737
2738     {
2739
2740     "memory\_mb": 1024,
2741
2742     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2743
2744     "disk\_gb": 2,
2745
2746     "project": "(used\_max)",
2747
2748     "cpu": 2
2749
2750     },
2751
2752     {
2753
2754     "memory\_mb": 1024,
2755
2756     "name": " c1a7de0ac9d94e4baceae031d05caae3",
2757
2758     "disk\_gb": 2,
2759
2760     "project": "568f7ec425db472ba348251bf1e7eebd",
2761
2762     "cpu": 2
2763
2764     }
2765
2766     ],
2767
2768     "vimName": "openstack\_newton",
2769
2770     "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2771
2772     "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2773
2774     }
2775
2776 1. \ **VIM Management**
2777
2778    1. \ **Update VIM Info**
2779
2780 +---------------------+----------------------------------------------------------------------------------------------+
2781 | **IF Definition**   | **Description**                                                                              |
2782 +=====================+==============================================================================================+
2783 | URI                 | http(s)://[hostname][:port]/onapapi/ multicloud /v1/{cloud-owner}\_{cloud-region}/registry   |
2784 +---------------------+----------------------------------------------------------------------------------------------+
2785 | Operation           | POST                                                                                         |
2786 +---------------------+----------------------------------------------------------------------------------------------+
2787 | Direction           | ESR-> MULTICLOUD                                                                             |
2788 +---------------------+----------------------------------------------------------------------------------------------+
2789
2790 1. \ **Request**
2791
2792 +-----------------+-----------------+-------------------+---------------+-----------------------+
2793 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**       |
2794 +=================+=================+===================+===============+=======================+
2795 | defaultTenant   | M               | 1                 | string        | default tenant name   |
2796 +-----------------+-----------------+-------------------+---------------+-----------------------+
2797
2798 1. \ **Response**
2799
2800 NA
2801
2802 202: accept
2803
2804 400: failed
2805
2806 1. \ **Unregistry VIM**
2807
2808 +---------------------+-----------------------------------------------------------------------------------------------+
2809 | **IF Definition**   | **Description**                                                                               |
2810 +=====================+===============================================================================================+
2811 | URI                 | http(s)://[hostname][:port]/onapapi/multicloud/v1 /{cloud-owner}\_{cloud-region}/unregistry   |
2812 +---------------------+-----------------------------------------------------------------------------------------------+
2813 | Operation           | DELETE                                                                                        |
2814 +---------------------+-----------------------------------------------------------------------------------------------+
2815 | Direction           | ESR-> MULTICLOUD                                                                              |
2816 +---------------------+-----------------------------------------------------------------------------------------------+
2817
2818 1. \ **Request**
2819
2820 NA
2821
2822 1. \ **Response**
2823
2824 NA
2825
2826 204: No content found
2827
2828 400: failed