docs/MultiCloud-APIv0-Specification.rst

   1 ..
   2  This work is licensed under a Creative Commons Attribution 4.0
   3  International License.
   4
   5 ================================
   6 MultiCloud API v0 Specification
   7 ================================
   8
   9 API Catalog
  10 ===========
  11
  12 1. **Scope**
  13 ^^^^^^^^^^^^
  14
  15 The scope of the present document is to describe the VIM Driver API
  16 specification.
  17
  18 2. **Terms, Definitions and Abbreviations**
  19 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  20
  21 For the purposes of the present document, the following abbreviations
  22 apply:
  23
  24 +--------------------+-------------------------------------------------------------+
  25 | **Abbreviation**   |                                                             |
  26 +====================+=============================================================+
  27 | NFVO               | Network Functions Virtualization Orchestrator               |
  28 +--------------------+-------------------------------------------------------------+
  29 | VNFM               | Virtual Network Function Management                         |
  30 +--------------------+-------------------------------------------------------------+
  31 | VIM                | Virtualized Infrastructure Manager                          |
  32 +--------------------+-------------------------------------------------------------+
  33 | MultiVIM           | MultVIM driver services for OPEN-O to drive VIM instances   |
  34 +--------------------+-------------------------------------------------------------+
  35
  36 3. **Image Management**
  37 ^^^^^^^^^^^^^^^^^^^^^^^
  38
  39 3.1. **Create Image**
  40 ---------------------
  41
  42 +---------------------+-------------------------------------------------------------------------------+
  43 | **IF Definition**   | **Description**                                                               |
  44 +=====================+===============================================================================+
  45 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images    |
  46 +---------------------+-------------------------------------------------------------------------------+
  47 | Operation           | POST                                                                          |
  48 +---------------------+-------------------------------------------------------------------------------+
  49 | Direction           | NSLCM->MULTIVIM                                                               |
  50 +---------------------+-------------------------------------------------------------------------------+
  51 | Description         | Create Image and Upload the image file to the VIM                             |
  52 +---------------------+-------------------------------------------------------------------------------+
  53
  54 3.1.1. **Request**
  55 >>>>>>>>>>>>>>>>>>
  56
  57 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
  58 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                  |
  59 +===================+=================+===================+===========================+==================================================================================================+
  60 | name              | M               | 1                 | String                    | Image Name                                                                                       |
  61 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
  62 | imagePath         | M               | 1                 | String                    | Image Local Path from catalog                                                                    |
  63 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
  64 | imageType         | M               | 1                 | String                    | Image Type                                                                                       |
  65 |                   |                 |                   |                           |                                                                                                  |
  66 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso                                             |
  67 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
  68 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                                                           |
  69 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
  70 | visibility        | O               | 1                 | string                    | Visibility for this image.                                                                       |
  71 |                   |                 |                   |                           |                                                                                                  |
  72 |                   |                 |                   |                           | public, private, shared, or community                                                            |
  73 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
  74 | properties        | O               | 0..N              | List of key-value pairs   | Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic"     |
  75 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
  76
  77 ::
  78
  79     {
  80
  81     "imageName": "cirros",
  82
  83     "imagePath": "/home/cirros.qcow2",
  84
  85     "imageType": "qcow2"
  86
  87     "containerFormat":"bare"
  88
  89     }
  90
  91 3.1.2. **Response**
  92 >>>>>>>>>>>>>>>>>>>
  93
  94 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
  95 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                        |
  96 +===================+=================+===================+===========================+========================================================+
  97 | id                | M               | 1                 | String                    | Image UUID in the VIM                                  |
  98 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
  99 | name              | M               | 1                 | String                    | Image Name                                             |
 100 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 101 | returnCode        | M               | 1                 | Int                       | 0: Already exist 1: Newly created                      |
 102 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 103 | imageType         | M               | 1                 | String                    | Image Type                                             |
 104 |                   |                 |                   |                           |                                                        |
 105 |                   |                 |                   |                           | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 106 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 107 | containerFormat   | M               | 1                 | string                    | ami, ari, aki, bare, ovf, ova,  docker                 |
 108 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 109 | visibility        | O               | 1                 | string                    | Visibility for this image.                             |
 110 |                   |                 |                   |                           |                                                        |
 111 |                   |                 |                   |                           | public, private, shared, or community                  |
 112 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 113 | properties        | O               | 0..N              | List of key-value pairs   |                                                        |
 114 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 115 | vimid             | M               | 1                 | String                    | vim id                                                 |
 116 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 117 | vimName           | O               | 1                 | string                    | vim name                                               |
 118 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 119 | tenantId          | M               | 1                 | String                    | Tenant UUID                                            |
 120 +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
 121
 122 *202*: accepted
 123
 124 500: failed
 125
 126 ::
 127
 128     {
 129         "id": "3c9eebdbbfd345658269340b9ea6fb73",
 130         "name": "cirros",
 131         "returnCode": 1
 132     }
 133
 134 3.2. **Delete Image**
 135 ---------------------
 136
 137 +---------------------+-----------------------------------------------------------------------------------------+
 138 | **IF Definition**   | **Description**                                                                         |
 139 +=====================+=========================================================================================+
 140 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images/{imageId}    |
 141 +---------------------+-----------------------------------------------------------------------------------------+
 142 | Operation           | Delete                                                                                  |
 143 +---------------------+-----------------------------------------------------------------------------------------+
 144 | Direction           | NSLCM->MULTIVIM                                                                         |
 145 +---------------------+-----------------------------------------------------------------------------------------+
 146 | Description         | Delete Image                                                                            |
 147 +---------------------+-----------------------------------------------------------------------------------------+
 148
 149 3.2.1. **Request**
 150 >>>>>>>>>>>>>>>>>>
 151
 152 N/A
 153
 154 3.2.2. **Response**
 155 >>>>>>>>>>>>>>>>>>>
 156
 157 204: no content
 158
 159 3.3. **List Images**
 160 --------------------
 161
 162 +---------------------+-------------------------------------------------------------------------------+
 163 | **IF Definition**   | **Description**                                                               |
 164 +=====================+===============================================================================+
 165 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud_owner}\_{region}/{tenantid}/images   |
 166 +---------------------+-------------------------------------------------------------------------------+
 167 | Operation           | GET                                                                           |
 168 +---------------------+-------------------------------------------------------------------------------+
 169 | Direction           | NSLCM->MULTIVIM                                                               |
 170 +---------------------+-------------------------------------------------------------------------------+
 171 | Description         | Query Image list                                                              |
 172 +---------------------+-------------------------------------------------------------------------------+
 173
 174 3.3.1. **Request**
 175 >>>>>>>>>>>>>>>>>>
 176
 177 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 178 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                  |
 179 +=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
 180 | 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.   |
 181 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 182 | 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.                                                   |
 183 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 184 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of an image                                                                                                                                                                               |
 185 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 186
 187 3.3.2. **Response**
 188 >>>>>>>>>>>>>>>>>>>
 189
 190 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 191 | \ **Parameter**                                 | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 192 +=================================================+=================+===================+===============+========================================================+
 193 | images                                          | M               | 0..N              | List          | Image List                                             |
 194 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 195 | id                                              | M               | 1                 | String        | Image ID                                               |
 196 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 197 | size                                            | M               | 1                 | int           | Image Size                                             |
 198 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 199 | name                                            | M               | 1                 | String        | Image Name                                             |
 200 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 201 | status                                          | M               | 1                 | String        | Image Status                                           |
 202 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 203 | imageType                                       | M               | 1                 | String        | Image Type                                             |
 204 |                                                 |                 |                   |               |                                                        |
 205 |                                                 |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 206 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 207 | containerFormat                                 | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 208 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 209 | visibility                                      | O               | 1                 | string        | Visibility for this image.                             |
 210 |                                                 |                 |                   |               |                                                        |
 211 |                                                 |                 |                   |               | public, private, shared, or community                  |
 212 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 213 | vimId                                           | M               | 1                 | String        | vim id                                                 |
 214 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 215 | vimName                                         | O               | 1                 | string        | vim name                                               |
 216 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 217 | tenantId                                        | M               | 1                 | String        | Tenant UUID                                            |
 218 +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 219
 220 200: ok
 221
 222 500: failed
 223
 224 ::
 225
 226     {
 227         "vimid": "",
 228         "vimname": "",
 229         "imageList": [{
 230             "status": "active",
 231             "id": "5e2757c1-f846-4727-915c-9a872553ed75",
 232             "size": 862016,
 233             "name": "vim-plus-cgsl40g-z.qcow2"
 234         }]
 235     }
 236
 237
 238 3.4. **Get Image**
 239 ------------------
 240
 241 +---------------------+-----------------------------------------------------------------------------------------+
 242 | **IF Definition**   | **Description**                                                                         |
 243 +=====================+=========================================================================================+
 244 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid}   |
 245 +---------------------+-----------------------------------------------------------------------------------------+
 246 | Operation           | GET                                                                                     |
 247 +---------------------+-----------------------------------------------------------------------------------------+
 248 | Direction           | NSLCM->MULTIVIM                                                                         |
 249 +---------------------+-----------------------------------------------------------------------------------------+
 250 | Description         | Query Image Information                                                                 |
 251 +---------------------+-----------------------------------------------------------------------------------------+
 252
 253 3.4.1. **Request**
 254 >>>>>>>>>>>>>>>>>>
 255
 256 N/A
 257
 258 3.4.2. **Response**
 259 >>>>>>>>>>>>>>>>>>>
 260
 261 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 262 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                        |
 263 +===================+=================+===================+===============+========================================================+
 264 | id                | M               | 1                 | String        | Image ID                                               |
 265 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 266 | size              | M               | 1                 | int           | Image Size                                             |
 267 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 268 | name              | M               | 1                 | String        | Image Name                                             |
 269 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 270 | status            | M               | 1                 | String        | Image Status                                           |
 271 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 272 | imageType         | M               | 1                 | String        | Image Type                                             |
 273 |                   |                 |                   |               |                                                        |
 274 |                   |                 |                   |               | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso   |
 275 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 276 | containerFormat   | M               | 1                 | string        | ami, ari, aki, bare, ovf, ova,  docker                 |
 277 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 278 | visibility        | O               | 1                 | string        | Visibility for this image.                             |
 279 |                   |                 |                   |               |                                                        |
 280 |                   |                 |                   |               | public, private, shared, or community                  |
 281 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 282 | vimId             | M               | 1                 | String        | vim id                                                 |
 283 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 284 | vimName           | M               | 1                 | string        | vim name                                               |
 285 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 286 | tenantId          | M               | 1                 | String        | Tenant UUID                                            |
 287 +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
 288
 289 200: ok
 290
 291 500: failed
 292
 293 ::
 294
 295     {
 296         "vimid": "",
 297         "vimname": "",
 298         "status": "active",
 299         "id": "5e2757c1-f846-4727-915c-9a872553ed75",
 300         "size": 862016,
 301         "name": "vim-plus-cgsl40g-z.qcow2"
 302     }
 303
 304 4. **Network Management**
 305 ^^^^^^^^^^^^^^^^^^^^^^^^^
 306
 307 4.1. **Create Network**
 308 -----------------------
 309
 310 +---------------------+---------------------------------------------------------------------------------+
 311 | **IF Definition**   | **Description**                                                                 |
 312 +=====================+=================================================================================+
 313 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 314 +---------------------+---------------------------------------------------------------------------------+
 315 | Operation           | POST                                                                            |
 316 +---------------------+---------------------------------------------------------------------------------+
 317 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                          |
 318 +---------------------+---------------------------------------------------------------------------------+
 319 | Description         | Create network and subnetwork on the VIM                                        |
 320 +---------------------+---------------------------------------------------------------------------------+
 321
 322 4.1.1. **Request**
 323 >>>>>>>>>>>>>>>>>>
 324
 325 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 326 | **Parameter**               | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 327 +=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 328 | name                        | M               | 1                 | String        | Logical network name                                                                                                                                                                                                                                                                      |
 329 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 330 | shared                      | M               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 331 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 332 | vlanTransparent             | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 333 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 334 | networkType                 | O               | 1                 | String        | Network type                                                                                                                                                                                                                                                                              |
 335 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 336 |                             |                 |                   |               | flat, vlan, vxlan, gre,                                                                                                                                                                                                                                                                   |
 337 |                             |                 |                   |               |                                                                                                                                                                                                                                                                                           |
 338 |                             |                 |                   |               | portgroup                                                                                                                                                                                                                                                                                 |
 339 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 340 | segmentationId              | O               | 1                 | Int           | id of paragraph                                                                                                                                                                                                                                                                           |
 341 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 342 | 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.   |
 343 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 344 | routerExternal              | O               | 1                 | boolean       |Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                      |
 345 +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 346
 347 ::
 348
 349     {
 350         "tenant": "tenant1",
 351         "networkName": "ommnet",
 352         "shared": 1,
 353         "vlanTransparent": 1,
 354         "networkType": "vlan",
 355         "segmentationId": 202,
 356         "physicalNetwork": "ctrl",
 357         "routerExternal": 0
 358     }
 359
 360 4.1.2. **Response**
 361 >>>>>>>>>>>>>>>>>>>
 362
 363 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 364 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 365 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 366 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 367 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 368 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 369 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 370 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 371 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 372 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 373 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 374 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 375 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 376 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 377 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 378 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 379 | 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.   |
 380 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 381 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 382 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 383 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 384 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 385 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 386 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 387 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 388 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 389 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 390 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 391 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 392 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 393
 394 202: accepted
 395
 396 500: failed
 397
 398 ::
 399
 400     {
 401         "returnCode": 0,
 402         "vimId": "11111",
 403         "vimName": "11111",
 404         "status": "ACTIVE",
 405         "id": "3c9eebdbbfd345658269340b9ea6fb73",
 406         "name": "net1",
 407         "tenant": "tenant1",
 408         "networkName": "ommnet",
 409         "shared": 1,
 410         "vlanTransparent": 1,
 411         "networkType": "vlan",
 412         "segmentationId": 202,
 413         "physicalNetwork": "ctrl",
 414         "routerExternal": 0
 415     }
 416
 417 4.2. **Delete Network**
 418 -----------------------
 419
 420 +---------------------+---------------------------------------------------------------------------------------------+
 421 | **IF Definition**   | **Description**                                                                             |
 422 +=====================+=============================================================================================+
 423 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 424 +---------------------+---------------------------------------------------------------------------------------------+
 425 | Operation           | Delete                                                                                      |
 426 +---------------------+---------------------------------------------------------------------------------------------+
 427 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 428 +---------------------+---------------------------------------------------------------------------------------------+
 429
 430 4.2.1. **Request**
 431 >>>>>>>>>>>>>>>>>>
 432
 433 N/A
 434
 435 4.2.2. **Response**
 436 >>>>>>>>>>>>>>>>>>>
 437
 438 204: no content
 439
 440 4.3. **List Network**
 441 ---------------------
 442
 443 +---------------------+---------------------------------------------------------------------------------+
 444 | **IF Definition**   | **Description**                                                                 |
 445 +=====================+=================================================================================+
 446 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks   |
 447 +---------------------+---------------------------------------------------------------------------------+
 448 | Operation           | get                                                                             |
 449 +---------------------+---------------------------------------------------------------------------------+
 450 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
 451 +---------------------+---------------------------------------------------------------------------------+
 452
 453 4.3.1. **Query**
 454 >>>>>>>>>>>>>>>>
 455
 456 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 457 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                       |
 458 +=================+=================+===================+===============+=======================================================================================+
 459 | name            | O               | 1                 | String        | Filters the response by a name, as a string. A valid value is the name of a network   |
 460 +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
 461
 462 4.3.2. **Response**
 463 >>>>>>>>>>>>>>>>>>>
 464
 465 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 466 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 467 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 468 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 469 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 470 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 471 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 472 | networks          |                 | 0..N              | List          | Network list                                                                                                                                                                                                                                                                              |
 473 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 474 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 475 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 476 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 477 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 478 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 479 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 480 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 481 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 482 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 483 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 484 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 485 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 486 | 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.   |
 487 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 488 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 489 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 490 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 491 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 492 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 493 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 494
 495 200: ok
 496
 497 500: failed
 498
 499 ::
 500
 501     {
 502
 503         "vimId": "11111",
 504
 505         "vimName": "111",
 506
 507         "networks":
 508
 509             [{
 510
 511                 "status": "ACTIVE",
 512
 513                 "id": "3c9eebdbbfd345658269340b9ea6fb73",
 514
 515                 "name": "net1",
 516
 517                 "tenant": "tenant1",
 518
 519                 "networkName": "ommnet",
 520
 521                 "shared": 1,
 522
 523                 "vlanTransparent": 1,
 524
 525                 "networkType": "vlan",
 526
 527                 "segmentationId": 202,
 528
 529                 "physicalNetwork ": "ctrl",
 530
 531                 "routerExternal ": 0
 532
 533             }]
 534
 535     }
 536
 537 4.4. **Get Network**
 538 --------------------
 539
 540 +---------------------+---------------------------------------------------------------------------------------------+
 541 | **IF Definition**   | **Description**                                                                             |
 542 +=====================+=============================================================================================+
 543 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId}   |
 544 +---------------------+---------------------------------------------------------------------------------------------+
 545 | Operation           | get                                                                                         |
 546 +---------------------+---------------------------------------------------------------------------------------------+
 547 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                       |
 548 +---------------------+---------------------------------------------------------------------------------------------+
 549
 550 4.4.1. **Request**
 551 >>>>>>>>>>>>>>>>>>
 552
 553 N/A
 554
 555 4.4.2. **Response**
 556 >>>>>>>>>>>>>>>>>>>
 557
 558 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 559 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                                                                                                                                                           |
 560 +===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
 561 | status            | M               | 1                 | string        | Network status                                                                                                                                                                                                                                                                            |
 562 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 563 | id                | M               | 1                 | string        | Network id                                                                                                                                                                                                                                                                                |
 564 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 565 | name              | M               | 1                 | string        | Network name                                                                                                                                                                                                                                                                              |
 566 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 567 | tenantId          | M               | 1                 | String        | Tenant UUID                                                                                                                                                                                                                                                                               |
 568 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 569 | segmentationId    | O               | 1                 | int           | Segmentation id                                                                                                                                                                                                                                                                           |
 570 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 571 | networkType       | O               | 1                 | string        | Network type                                                                                                                                                                                                                                                                              |
 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 | vlanTransparent   | O               | 1                 | boolean       | Whether to support VLAN pass through(1:true;0:false)                                                                                                                                                                                                                                      |
 576 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 577 | shared            | O               | 1                 | boolean       | Whether to share(1:sharing;0:private)                                                                                                                                                                                                                                                     |
 578 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 579 | routerExternal    | O               | 1                 | boolean       | Indicates whether this network can provide floating IPs via a router.                                                                                                                                                                                                                     |
 580 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 581 | returnCode        | M               | 1                 | int           | 0: Already exist 1: Newly created                                                                                                                                                                                                                                                         |
 582 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 583 | vimId             | M               | 1                 | String        | vim id                                                                                                                                                                                                                                                                                    |
 584 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 585 | vimName           | O               | 1                 | string        | vim name                                                                                                                                                                                                                                                                                  |
 586 +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 587
 588 200: ok
 589
 590 500: failed
 591
 592 ::
 593
 594     {
 595
 596         "vimId":"11111",
 597
 598         "vimName":"11111",
 599
 600         "status": "ACTIVE",
 601
 602         "id": "3c9eebdbbfd345658269340b9ea6fb73",
 603
 604         "name": "net1",
 605
 606         "tenant": "tenant1",
 607
 608         "networkName": "ommnet",
 609
 610         "shared": 1,
 611
 612         "vlanTransparent": 1,
 613
 614         "networkType":"vlan",
 615
 616         "segmentationId":202,
 617
 618         "physicalNetwork ":"ctrl",
 619
 620         "routerExternal ":0
 621
 622     }
 623
 624 5. **Subnetwork Management**
 625 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 626
 627 5.1. **Create Subnets**
 628 -----------------------
 629
 630 +---------------------+--------------------------------------------------------------------------------+
 631 | **IF Definition**   | **Description**                                                                |
 632 +=====================+================================================================================+
 633 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
 634 +---------------------+--------------------------------------------------------------------------------+
 635 | Operation           | POST                                                                           |
 636 +---------------------+--------------------------------------------------------------------------------+
 637 | Direction           | VNFLCM,NSLCM->MULTIVIM                                                         |
 638 +---------------------+--------------------------------------------------------------------------------+
 639 | Description         | Create network and subnetwork on the VIM                                       |
 640 +---------------------+--------------------------------------------------------------------------------+
 641
 642 5.1.1. **Request**
 643 >>>>>>>>>>>>>>>>>>
 644
 645 +-------------------+-----------------+-------------------+------------------------+----------------------+
 646 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
 647 +===================+=================+===================+========================+======================+
 648 | networkId         | M               | 1                 | String                 | Network Id           |
 649 +-------------------+-----------------+-------------------+------------------------+----------------------+
 650 | name              | M               | 1                 | String                 | SubnetName           |
 651 +-------------------+-----------------+-------------------+------------------------+----------------------+
 652 | cidr              | M               | 1                 | String                 | Subnet cidr          |
 653 +-------------------+-----------------+-------------------+------------------------+----------------------+
 654 | ipVersion         | M               | 1                 | Int                    | Ip type              |
 655 |                   |                 |                   |                        |                      |
 656 |                   |                 |                   |                        | 4,6                  |
 657 +-------------------+-----------------+-------------------+------------------------+----------------------+
 658 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
 659 |                   |                 |                   |                        |                      |
 660 |                   |                 |                   |                        | 1: yes;0: no         |
 661 +-------------------+-----------------+-------------------+------------------------+----------------------+
 662 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
 663 +-------------------+-----------------+-------------------+------------------------+----------------------+
 664 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
 665 +-------------------+-----------------+-------------------+------------------------+----------------------+
 666 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
 667 +-------------------+-----------------+-------------------+------------------------+----------------------+
 668 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
 669 +-------------------+-----------------+-------------------+------------------------+----------------------+
 670 | -->allocation     |                 |                   |                        |                      |
 671 +-------------------+-----------------+-------------------+------------------------+----------------------+
 672 | -->start          | O               | 1                 | String                 | Start ip             |
 673 +-------------------+-----------------+-------------------+------------------------+----------------------+
 674 | -->end            | O               | 1                 | String                 | End ip               |
 675 +-------------------+-----------------+-------------------+------------------------+----------------------+
 676
 677 ::
 678
 679     {
 680
 681         "tenant": "tenant1",
 682
 683         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
 684
 685         "subnetName": "subnet1",
 686
 687         "cidr": "10.43.35.0/24",
 688
 689         "ipVersion": 4,
 690
 691         "enableDhcp": 1,
 692
 693         "gatewayIp": "10.43.35.1",
 694
 695         "dnsNameservers": [],
 696
 697         "allocationPools": [{
 698
 699             "start": "192.168.199.2",
 700
 701             "end": "192.168.199.254"
 702
 703         }],
 704
 705         "hostRoutes": []
 706
 707     }
 708
 709 5.1.2. **Response**
 710 >>>>>>>>>>>>>>>>>>>
 711
 712 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 713 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**                     |
 714 +===================+=================+===================+========================+=====================================+
 715 | returnCode        | M               | 1                 | int                    | 0: Already exist 1: Newly created   |
 716 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 717 | vimId             | M               | 1                 | String                 | vim id                              |
 718 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 719 | vimName           | O               | 1                 | string                 | vim name                            |
 720 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 721 | status            | M               | 1                 | string                 | subnetwork status                   |
 722 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 723 | id                | M               | 1                 | string                 | subNetwork id                       |
 724 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 725 | tenantId          | M               | 1                 | String                 | Tenant UUID                         |
 726 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 727 | networkId         | O               | 1                 | String                 | Network Id                          |
 728 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 729 | networkName       | O               | 1                 | String                 | Network Name                        |
 730 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 731 | name              | M               | 1                 | String                 | SubnetName                          |
 732 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 733 | cidr              | M               | 1                 | String                 | Subnet cidr                         |
 734 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 735 | ipVersion         | M               | 1                 | Int                    | Ip type                             |
 736 |                   |                 |                   |                        |                                     |
 737 |                   |                 |                   |                        | 4,6                                 |
 738 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 739 | enableDhcp        | O               | 1                 | boolean                | Whether to allow                    |
 740 |                   |                 |                   |                        |                                     |
 741 |                   |                 |                   |                        | 1: yes;0: no                        |
 742 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 743 | gatewayIp         | O               | 1                 | String                 | Gateway ip                          |
 744 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 745 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers                     |
 746 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 747 | hostRoutes        | O               | 1..n              | List of routes         | List of routes                      |
 748 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 749 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation                  |
 750 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 751 | -->allocation     |                 |                   |                        |                                     |
 752 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 753 | -->start          | O               | 1                 | String                 | Start ip                            |
 754 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 755 | -->end            | O               | 1                 | String                 | End ip                              |
 756 +-------------------+-----------------+-------------------+------------------------+-------------------------------------+
 757
 758 202: accepted
 759
 760 500: failed
 761
 762 ::
 763
 764     {
 765
 766         "returnCode": 0,
 767
 768         "vimId": "11111",
 769
 770         "vimName": "11111",
 771
 772         "status": " ACTIVE",
 773
 774         "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
 775
 776         "tenant": "tenant1",
 777
 778         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
 779
 780         "name": "subnet1",
 781
 782         "cidr": "10.43.35.0/24",
 783
 784         "ipVersion": 4,
 785
 786         "enableDhcp": 1,
 787
 788         "gatewayIp": "10.43.35.1",
 789
 790         "dnsNameservers": [],
 791
 792         "allocationPools": [{
 793
 794             "start": "192.168.199.2",
 795
 796             "end": "192.168.199.254"
 797
 798         }],
 799
 800         "hostRoutes": []
 801
 802     }
 803
 804 5.2. **Delete Subnets**
 805 -----------------------
 806
 807 +---------------------+-------------------------------------------------------------------------------------------+
 808 | **IF Definition**   | **Description**                                                                           |
 809 +=====================+===========================================================================================+
 810 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId}   |
 811 +---------------------+-------------------------------------------------------------------------------------------+
 812 | Operation           | Delete                                                                                    |
 813 +---------------------+-------------------------------------------------------------------------------------------+
 814 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
 815 +---------------------+-------------------------------------------------------------------------------------------+
 816
 817 5.2.1. **Request**
 818 >>>>>>>>>>>>>>>>>>
 819
 820 N/A
 821
 822 5.2.2. **Response**
 823 >>>>>>>>>>>>>>>>>>>
 824
 825 204: no content
 826
 827 5.3. **List Subnets**
 828 ---------------------
 829
 830 +---------------------+--------------------------------------------------------------------------------+
 831 | **IF Definition**   | **Description**                                                                |
 832 +=====================+================================================================================+
 833 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets   |
 834 +---------------------+--------------------------------------------------------------------------------+
 835 | Operation           | get                                                                            |
 836 +---------------------+--------------------------------------------------------------------------------+
 837 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
 838 +---------------------+--------------------------------------------------------------------------------+
 839
 840 5.3.1. **Query**
 841 >>>>>>>>>>>>>>>>
 842
 843 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
 844
 845 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
 846 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                |
 847 +=================+=================+===================+===============+================================================================================================+
 848 | name            | O               | 1                 | String        | Filters fields of the response by a name, as a string. A valid value is the name of a subnet   |
 849 +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
 850
 851 5.3.2. **Response**
 852 >>>>>>>>>>>>>>>>>>>
 853
 854 +-------------------+-----------------+-------------------+------------------------+----------------------+
 855 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
 856 +===================+=================+===================+========================+======================+
 857 | vimId             | M               | 1                 | String                 | vim id               |
 858 +-------------------+-----------------+-------------------+------------------------+----------------------+
 859 | vimName           | O               | 1                 | string                 | vim name             |
 860 +-------------------+-----------------+-------------------+------------------------+----------------------+
 861 | subnets           | M               | 0..N              | List                   | Network list         |
 862 +-------------------+-----------------+-------------------+------------------------+----------------------+
 863 | status            |                 | 1                 | string                 | subnetwork status    |
 864 +-------------------+-----------------+-------------------+------------------------+----------------------+
 865 | id                |                 | 1                 | string                 | subNetwork id        |
 866 +-------------------+-----------------+-------------------+------------------------+----------------------+
 867 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
 868 +-------------------+-----------------+-------------------+------------------------+----------------------+
 869 | networkId         | O               | 1                 | String                 | Network Id           |
 870 +-------------------+-----------------+-------------------+------------------------+----------------------+
 871 | networkName       | O               | 1                 | String                 | Network Name         |
 872 +-------------------+-----------------+-------------------+------------------------+----------------------+
 873 | name              | M               | 1                 | String                 | SubnetName           |
 874 +-------------------+-----------------+-------------------+------------------------+----------------------+
 875 | cidr              | M               | 1                 | String                 | Subnet cidr          |
 876 +-------------------+-----------------+-------------------+------------------------+----------------------+
 877 | ipVersion         | M               | 1                 | Int                    | Ip type              |
 878 |                   |                 |                   |                        |                      |
 879 |                   |                 |                   |                        | 4,6                  |
 880 +-------------------+-----------------+-------------------+------------------------+----------------------+
 881 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
 882 |                   |                 |                   |                        |                      |
 883 |                   |                 |                   |                        | 1: yes;0: no         |
 884 +-------------------+-----------------+-------------------+------------------------+----------------------+
 885 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
 886 +-------------------+-----------------+-------------------+------------------------+----------------------+
 887 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
 888 +-------------------+-----------------+-------------------+------------------------+----------------------+
 889 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
 890 +-------------------+-----------------+-------------------+------------------------+----------------------+
 891 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
 892 +-------------------+-----------------+-------------------+------------------------+----------------------+
 893 | -->allocation     |                 |                   |                        |                      |
 894 +-------------------+-----------------+-------------------+------------------------+----------------------+
 895 | -->start          | O               | 1                 | String                 | Start ip             |
 896 +-------------------+-----------------+-------------------+------------------------+----------------------+
 897 | -->end            | O               | 1                 | String                 | End ip               |
 898 +-------------------+-----------------+-------------------+------------------------+----------------------+
 899
 900 **200: ok**
 901
 902 **500: failed**
 903
 904 ::
 905
 906     {
 907
 908         "vimId": "11111",
 909
 910         "vimName": "11111",
 911
 912         "subnets": [
 913
 914             {
 915
 916                 "status": " ACTIVE",
 917
 918                 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
 919
 920                 "tenant": "tenant1",
 921
 922                 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
 923
 924                 "name": "subnet1",
 925
 926                 "cidr": "10.43.35.0/24",
 927
 928                 "ipVersion": 4,
 929
 930                 "enableDhcp": 1,
 931
 932                 "gatewayIp": "10.43.35.1",
 933
 934                 "dnsNameservers": [],
 935
 936                 "allocationPools": [{
 937
 938                     "start": "192.168.199.2",
 939
 940                     "end": "192.168.199.254"
 941
 942                 }],
 943
 944                 "hostRoutes": []
 945
 946             }
 947
 948         ]
 949
 950     }
 951
 952 5.4. **Get Subnets**
 953 --------------------
 954
 955 +---------------------+-------------------------------------------------------------------------------------------+
 956 | **IF Definition**   | **Description**                                                                           |
 957 +=====================+===========================================================================================+
 958 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid}   |
 959 +---------------------+-------------------------------------------------------------------------------------------+
 960 | Operation           | get                                                                                       |
 961 +---------------------+-------------------------------------------------------------------------------------------+
 962 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
 963 +---------------------+-------------------------------------------------------------------------------------------+
 964
 965 5.4.1. **Request**
 966 >>>>>>>>>>>>>>>>>>
 967
 968 N/A
 969
 970 5.4.2. **Response**
 971 >>>>>>>>>>>>>>>>>>>
 972
 973 +-------------------+-----------------+-------------------+------------------------+----------------------+
 974 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**            | **Description**      |
 975 +===================+=================+===================+========================+======================+
 976 | vimId             | M               | 1                 | String                 | vim id               |
 977 +-------------------+-----------------+-------------------+------------------------+----------------------+
 978 | vimName           | O               | 1                 | string                 | vim name             |
 979 +-------------------+-----------------+-------------------+------------------------+----------------------+
 980 | status            |                 | 1                 | string                 | subnetwork status    |
 981 +-------------------+-----------------+-------------------+------------------------+----------------------+
 982 | id                |                 | 1                 | string                 | subNetwork id        |
 983 +-------------------+-----------------+-------------------+------------------------+----------------------+
 984 | tenantId          | M               | 1                 | String                 | Tenant UUID          |
 985 +-------------------+-----------------+-------------------+------------------------+----------------------+
 986 | networkId         | O               | 1                 | String                 | Network Id           |
 987 +-------------------+-----------------+-------------------+------------------------+----------------------+
 988 | networkName       | O               | 1                 | String                 | Network Name         |
 989 +-------------------+-----------------+-------------------+------------------------+----------------------+
 990 | name              | M               | 1                 | String                 | SubnetName           |
 991 +-------------------+-----------------+-------------------+------------------------+----------------------+
 992 | cidr              | M               | 1                 | String                 | Subnet cidr          |
 993 +-------------------+-----------------+-------------------+------------------------+----------------------+
 994 | ipVersion         | M               | 1                 | Int                    | Ip type              |
 995 |                   |                 |                   |                        |                      |
 996 |                   |                 |                   |                        | 4,6                  |
 997 +-------------------+-----------------+-------------------+------------------------+----------------------+
 998 | enableDhcp        | O               | 1                 | boolean                | Whether to allow     |
 999 |                   |                 |                   |                        |                      |
1000 |                   |                 |                   |                        | 1: yes;0: no         |
1001 +-------------------+-----------------+-------------------+------------------------+----------------------+
1002 | gatewayIp         | O               | 1                 | String                 | Gateway ip           |
1003 +-------------------+-----------------+-------------------+------------------------+----------------------+
1004 | dnsNameservers    | O               | 1..n              | List of servers        | List of servers      |
1005 +-------------------+-----------------+-------------------+------------------------+----------------------+
1006 | hostRoutes        | O               | 1..n              | List of routes         | List of routes       |
1007 +-------------------+-----------------+-------------------+------------------------+----------------------+
1008 | allocationPools   | O               | 1..n              | list of "allocation"   | list of allocation   |
1009 +-------------------+-----------------+-------------------+------------------------+----------------------+
1010 | -->allocation     |                 |                   |                        |                      |
1011 +-------------------+-----------------+-------------------+------------------------+----------------------+
1012 | -->start          | O               | 1                 | String                 | Start ip             |
1013 +-------------------+-----------------+-------------------+------------------------+----------------------+
1014 | -->end            | O               | 1                 | String                 | End ip               |
1015 +-------------------+-----------------+-------------------+------------------------+----------------------+
1016
1017 202: accepted
1018
1019 500: failed
1020
1021 ::
1022
1023     {
1024
1025         "status": " ACTIVE",
1026
1027         "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
1028
1029         "tenant": "tenant1",
1030
1031         "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
1032
1033         "name": "subnet1",
1034
1035         "cidr": "10.43.35.0/24",
1036
1037         "ipVersion": 4,
1038
1039         "enableDhcp": 1,
1040
1041         "gatewayIp": "10.43.35.1",
1042
1043         "dnsNameservers": [],
1044
1045         "allocationPools": [{
1046
1047             "start": "192.168.199.2",
1048
1049             "end": "192.168.199.254"
1050
1051         }],
1052
1053         "hostRoutes": []
1054
1055     }
1056
1057 6. **Virtual Port**
1058 ^^^^^^^^^^^^^^^^^^^
1059
1060 6.1. **Create Virtual Port**
1061 ----------------------------
1062
1063 +---------------------+------------------------------------------------------------------------------+
1064 | **IF Definition**   | **Description**                                                              |
1065 +=====================+==============================================================================+
1066 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports   |
1067 +---------------------+------------------------------------------------------------------------------+
1068 | Operation           | POST                                                                         |
1069 +---------------------+------------------------------------------------------------------------------+
1070 | Direction           | VNFLCM->MULTIVIM                                                             |
1071 +---------------------+------------------------------------------------------------------------------+
1072
1073 6.1.1. **Request**
1074 >>>>>>>>>>>>>>>>>>
1075
1076 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1077 | **Parameter**          | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                       |
1078 +========================+=================+===================+===============+=======================================================+
1079 | networkId              | M               | 1                 | string        | Network UUID                                          |
1080 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1081 | subnetId               | O               | 1                 | string        | Subnet UUID                                           |
1082 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1083 | name                   | M               | 1                 | string        | Port name                                             |
1084 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1085 | macAddress             | O               | 1                 | string        | Mac address                                           |
1086 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1087 | ip                     | O               | 1                 | string        | Ip address                                            |
1088 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1089 | vnicType               | O               | 1                 | string        | Virtual network card type,                            |
1090 |                        |                 |                   |               |                                                       |
1091 |                        |                 |                   |               | the value of three kinds of normal/direct/macvtap     |
1092 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1093 | \ **securityGroups**   | **O**           | **1**             | **string**    | **The IDs of security groups applied to the port.**   |
1094 +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1095
1096 6.1.2. **Response**
1097 >>>>>>>>>>>>>>>>>>>
1098
1099 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1100 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1101 +======================+=================+===================+===============+=====================================================+
1102 | returnCode           | M               | 1                 | int           | 0: Already exist 1: Newly created                   |
1103 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1104 | vimId                | M               | 1                 | String        | vim id                                              |
1105 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1106 | vimName              | O               | 1                 | string        | vim name                                            |
1107 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1108 | status               | M               | 1                 | string        | status                                              |
1109 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1110 | id                   | M               | 1                 | string        | Port Id                                             |
1111 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1112 | name                 | M               | 1                 | string        | Port name                                           |
1113 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1114 | tenantId             | M               | 1                 | String        | Tenant UUID                                         |
1115 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1116 | networkName          | M               | 1                 | string        | Network name                                        |
1117 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1118 | networkId            | M               | 1                 | string        | Network Id                                          |
1119 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1120 | subnetName           | M               | 1                 | string        | Subnet name                                         |
1121 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1122 | subnetId             | M               | 1                 | string        | SubnetId                                            |
1123 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1124 | macAddress           | O               | 1                 | string        | Mac address                                         |
1125 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1126 | ip                   | O               | 1                 | string        | Ip address                                          |
1127 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1128 | vnicType             | O               | 1                 | string        | Virtual network card type,                          |
1129 |                      |                 |                   |               |                                                     |
1130 |                      |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1131 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1132 | **securityGroups**   | **O**           | **1**             | **string**    | **List of security group names.**                   |
1133 +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1134
1135 6.2. **Delete Virtual Port**
1136 ----------------------------
1137
1138 +---------------------+---------------------------------------------------------------------------------------+
1139 | **IF Definition**   | **Description**                                                                       |
1140 +=====================+=======================================================================================+
1141 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1142 +---------------------+---------------------------------------------------------------------------------------+
1143 | Operation           | DELETTE                                                                               |
1144 +---------------------+---------------------------------------------------------------------------------------+
1145 | Direction           | VNFLCM->MULTIVIM                                                                      |
1146 +---------------------+---------------------------------------------------------------------------------------+
1147
1148 6.2.1. **Request**
1149 >>>>>>>>>>>>>>>>>>
1150
1151 N/A
1152
1153 6.2.2. **Response**
1154 >>>>>>>>>>>>>>>>>>>
1155
1156 204: no content
1157
1158 6.3. **List Virtual Port**
1159 --------------------------
1160
1161 +---------------------+-----------------------------------------------------------------------------+
1162 | **IF Definition**   | **Description**                                                             |
1163 +=====================+=============================================================================+
1164 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports   |
1165 +---------------------+-----------------------------------------------------------------------------+
1166 | Operation           | GET                                                                         |
1167 +---------------------+-----------------------------------------------------------------------------+
1168 | Direction           | VNFLCM->MULTIVIM                                                            |
1169 +---------------------+-----------------------------------------------------------------------------+
1170
1171 6.3.1. **Query**
1172 >>>>>>>>>>>>>>>>
1173
1174 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1175 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                 |
1176 +=================+=================+===================+===============+=================================================+
1177 | name            | M               | 1                 | string        | Port name to filter out list of virtual ports   |
1178 +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1179
1180 6.3.2. **Response**
1181 >>>>>>>>>>>>>>>>>>>
1182
1183 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1184 | **Parameter**     | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1185 +===================+=================+===================+===============+=====================================================+
1186 | vimId             | M               | 1                 | String        | vim id                                              |
1187 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1188 | vimName           | O               | 1                 | string        | vim name                                            |
1189 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1190 | tenantId          | M               | 1                 | String        | Tenant UUID                                         |
1191 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1192 | Ports             | M               | 0..N              | List          | ports                                               |
1193 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1194 | id                | M               | 1                 | string        | Port Id                                             |
1195 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1196 | name              | M               | 1                 | string        | Port name                                           |
1197 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1198 | status            | M               | 1                 | string        | status                                              |
1199 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1200 | **networkName**   | O               | 1                 | string        | Network name                                        |
1201 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1202 | networkId         | M               | 1                 | string        | Network Id                                          |
1203 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1204 | subnetName        | O               | 1                 | string        | Subnet name                                         |
1205 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1206 | subnetId          | M               | 1                 | string        | SubnetId                                            |
1207 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1208 | macAddress        | O               | 1                 | string        | Mac address                                         |
1209 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1210 | ip                | O               | 1                 | string        | Ip address                                          |
1211 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1212 | vnicType          | O               | 1                 | string        | Virtual network card type,                          |
1213 |                   |                 |                   |               |                                                     |
1214 |                   |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1215 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1216 | securityGroups    | O               | 1                 | string        | List of security group names.                       |
1217 +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1218
1219 **200: ok**
1220
1221 **500: failed**
1222
1223
1224 6.4. **Get Virtual Port**
1225 -------------------------
1226
1227 +---------------------+---------------------------------------------------------------------------------------+
1228 | **IF Definition**   | **Description**                                                                       |
1229 +=====================+=======================================================================================+
1230 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid}   |
1231 +---------------------+---------------------------------------------------------------------------------------+
1232 | Operation           | GET                                                                                   |
1233 +---------------------+---------------------------------------------------------------------------------------+
1234 | Direction           | VNFLCM->MULTIVIM                                                                      |
1235 +---------------------+---------------------------------------------------------------------------------------+
1236
1237 6.4.1. **Request**
1238 >>>>>>>>>>>>>>>>>>
1239
1240 N/A
1241
1242 6.4.2. **Response**
1243 >>>>>>>>>>>>>>>>>>>
1244
1245 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1246 | **Parameter**    | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
1247 +==================+=================+===================+===============+=====================================================+
1248 | vimId            | M               | 1                 | String        | vim id                                              |
1249 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1250 | vimName          | O               | 1                 | string        | vim name                                            |
1251 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1252 | status           | M               | 1                 | string        | status                                              |
1253 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1254 | id               | M               | 1                 | string        | Port Id                                             |
1255 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1256 | name             | M               | 1                 | string        | Port name                                           |
1257 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1258 | tenantId         | M               | 1                 | String        | Tenant UUID                                         |
1259 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1260 | networkName      | M               | 1                 | string        | Network name                                        |
1261 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1262 | networkId        | M               | 1                 | string        | Network Id                                          |
1263 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1264 | subnetName       | M               | 1                 | string        | Subnet name                                         |
1265 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1266 | subnetId         | M               | 1                 | string        | SubnetId                                            |
1267 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1268 | macAddress       | O               | 1                 | string        | Mac address                                         |
1269 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1270 | ip               | O               | 1                 | string        | Ip address                                          |
1271 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1272 | vnicType         | O               | 1                 | string        | Virtual network card type,                          |
1273 |                  |                 |                   |               |                                                     |
1274 |                  |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
1275 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1276 | securityGroups   | O               | 1                 | string        | **List of security group names.**                   |
1277 +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1278
1279 **200: ok**
1280
1281 **500: failed**
1282
1283
1284 7. **Server Management**
1285 ^^^^^^^^^^^^^^^^^^^^^^^^
1286
1287 7.1. **Create Server**
1288 ----------------------
1289
1290 +---------------------+--------------------------------------------------------------------------------+
1291 | **IF Definition**   | **Description**                                                                |
1292 +=====================+================================================================================+
1293 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1294 +---------------------+--------------------------------------------------------------------------------+
1295 | Operation           | POST                                                                           |
1296 +---------------------+--------------------------------------------------------------------------------+
1297 | Direction           | VNFLCM->MULTIVIM                                                               |
1298 +---------------------+--------------------------------------------------------------------------------+
1299
1300 7.1.1. **Request**
1301 >>>>>>>>>>>>>>>>>>
1302
1303 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1304 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1305 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1306 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1307 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1308 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1309 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1310 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1311 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1312 | contextArray         | O               | 1..n              | list of context                       | list of context                                                                                                                                                                        |
1313 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1314 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1315 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1316 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1317 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1318 | flavorId             | M               | 1                 | String                                | server Flavor id                                                                                                                                                                       |
1319 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1320 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1321 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1322 | userdata             | O               | 1                 | string                                | Configuration information or scripts to use upon launch. Must be Base64 encoded.                                                                                                       |
1323 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1324 |                      |                 |                   |                                       | 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.                                                       |
1325 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1326 | 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.       |
1327 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1328 | serverGroup          | O               | 1                 | string                                | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1329 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1330
1331 **boot**
1332
1333 +-----------------+-----------------+-------------------+---------------+---------------------------+
1334 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**           |
1335 +=================+=================+===================+===============+===========================+
1336 | type            | M               | 1                 | int           | Startup mode              |
1337 |                 |                 |                   |               |                           |
1338 |                 |                 |                   |               | 1. boot from the volume   |
1339 |                 |                 |                   |               |                           |
1340 |                 |                 |                   |               | 2. boot from image        |
1341 +-----------------+-----------------+-------------------+---------------+---------------------------+
1342 | volumeId        | O               | 1                 | string        | Volume Id(type=1)         |
1343 +-----------------+-----------------+-------------------+---------------+---------------------------+
1344 | imageId         | O               | 1                 | String        | ImageId（type=2）         |
1345 +-----------------+-----------------+-------------------+---------------+---------------------------+
1346
1347 **contextArray**
1348
1349 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1350 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                                                                                                                           |
1351 +=================+=================+===================+===============+===========================================================================================================================================================+
1352 | fileName        | M               | 1                 | String        | Injection file name                                                                                                                                       |
1353 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1354 | 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. )   |
1355 +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1356
1357 **volumeArray**
1358
1359 +-----------------+-----------------+-------------------+---------------+-------------------+
1360 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1361 +=================+=================+===================+===============+===================+
1362 | volumeId        | M               | 1                 | String        | Volume Id         |
1363 +-----------------+-----------------+-------------------+---------------+-------------------+
1364
1365 **nicArray**
1366
1367 +-----------------+-----------------+-------------------+---------------+-------------------+
1368 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1369 +=================+=================+===================+===============+===================+
1370 | portId          | M               | 1                 | String        | Port Id           |
1371 +-----------------+-----------------+-------------------+---------------+-------------------+
1372
1373 **metadata**
1374
1375 +-----------------+-----------------+-------------------+---------------+-------------------+
1376 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1377 +=================+=================+===================+===============+===================+
1378 | keyName         | M               | 1                 | String        | Key name          |
1379 +-----------------+-----------------+-------------------+---------------+-------------------+
1380 | value           | M               | 1                 | string        | value             |
1381 +-----------------+-----------------+-------------------+---------------+-------------------+
1382
1383 ::
1384
1385     {
1386
1387         "tenant": "tenant1",
1388
1389         "name": "vm1",
1390
1391         "availabilityZone": "az1",
1392
1393         "flavorName": "vm_large",
1394
1395         "boot": {
1396
1397             "type": 1,
1398
1399             " volumeName": "volume1"
1400
1401         },
1402
1403         "flavorId": "vm_large_134213",
1404
1405         "contextArray": [{
1406
1407             "fileName": "test.yaml",
1408
1409             "fileData": "…."
1410
1411         }],
1412
1413         "volumeArray": [{
1414
1415             "volumeName": "vol1",
1416
1417         }],
1418
1419         "nicArray": [{
1420
1421             "portId": "port_a"
1422
1423         }],
1424
1425         "metada": [{
1426
1427             "keyName": "foo",
1428
1429             "value": "foo value"
1430
1431         }],
1432
1433         "userdata": "abcdedf"
1434
1435     }
1436
1437 7.1.2. **Response**
1438 >>>>>>>>>>>>>>>>>>>
1439
1440 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1441 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                          | **Description**                                                                                                                                                                        |
1442 +======================+=================+===================+======================================+========================================================================================================================================================================================+
1443 | vimId                | M               | 1                 | String                               | vim id                                                                                                                                                                                 |
1444 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1445 | vimName              | O               | 1                 | string                               | vim name                                                                                                                                                                               |
1446 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1447 | returnCode           |                 | 1                 | int                                  | 0: Already exist 1: Newly created                                                                                                                                                      |
1448 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1449 | id                   | M               | 1                 | string                               | server id                                                                                                                                                                              |
1450 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1451 | name                 |                 | 1                 | string                               | server name                                                                                                                                                                            |
1452 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1453 | tenantId             | M               | 1                 | String                               | Tenant UUID                                                                                                                                                                            |
1454 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1455 | boot                 | M               | 1                 | String                               | Start parameters                                                                                                                                                                       |
1456 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1457 | nicArray             | O               | 1..n              | List of nic                          | List of nic                                                                                                                                                                            |
1458 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1459 | volumeArray          | O               | 1..n              | list of volume                       | list of volume                                                                                                                                                                         |
1460 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1461 | availabilityZone     | O               | 1                 | string                               | Usable field                                                                                                                                                                           |
1462 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1463 | flavorId             | M               | 1                 | String                               | server Flavor                                                                                                                                                                          |
1464 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1465 | metadata             | O               | 1                 | List of metadata                     | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1466 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1467 | **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.**   |
1468 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1469 |                      |                 |                   |                                      | **[TBD]**                                                                                                                                                                              |
1470 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1471 | **serverGroup**      | **O**           | **1**             | **string**                           | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1472 |                      |                 |                   |                                      |                                                                                                                                                                                        |
1473 |                      |                 |                   |                                      | [TBD]                                                                                                                                                                                  |
1474 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1475 | **status**           | **M**           | **1**             | **string**                           | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR                                                                                                                                             |
1476 +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1477
1478 202: accepted
1479
1480 500: failed
1481
1482 ::
1483
1484     {
1485
1486     "id": "3c9eebdbbfd345658269340b9ea6fb73",
1487
1488     "name": "vm1",
1489
1490     "returnCode": 1,
1491
1492     }
1493
1494 7.2. **Delete Server**
1495 ----------------------
1496
1497 +---------------------+-------------------------------------------------------------------------------------------+
1498 | **IF Definition**   | **Description**                                                                           |
1499 +=====================+===========================================================================================+
1500 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1501 +---------------------+-------------------------------------------------------------------------------------------+
1502 | Operation           | DELETE                                                                                    |
1503 +---------------------+-------------------------------------------------------------------------------------------+
1504 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1505 +---------------------+-------------------------------------------------------------------------------------------+
1506
1507 7.2.1. **Request**
1508 >>>>>>>>>>>>>>>>>>
1509
1510 N/A
1511
1512 7.2.2. **Response**
1513 >>>>>>>>>>>>>>>>>>>
1514
1515 204: no content
1516
1517 7.3. **List Server**
1518 --------------------
1519
1520 +---------------------+--------------------------------------------------------------------------------+
1521 | **IF Definition**   | **Description**                                                                |
1522 +=====================+================================================================================+
1523 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers   |
1524 +---------------------+--------------------------------------------------------------------------------+
1525 | Operation           | get                                                                            |
1526 +---------------------+--------------------------------------------------------------------------------+
1527 | Direction           | NFLCM,NSLCM->MULTIVIM                                                          |
1528 +---------------------+--------------------------------------------------------------------------------+
1529
1530 7.3.1. **Request**
1531 >>>>>>>>>>>>>>>>>>
1532
1533 msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1534
1535 +-----------------+-----------------+-------------------+---------------+-------------------+
1536 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1537 +=================+=================+===================+===============+===================+
1538 | name            | M               | 1                 | string        | server name       |
1539 +-----------------+-----------------+-------------------+---------------+-------------------+
1540
1541 7.3.2. **Response**
1542 >>>>>>>>>>>>>>>>>>>
1543
1544 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1545 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1546 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1547 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1548 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1549 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1550 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1551 | servers              | M               | 1                 | array                                 | server list                                                                                                                                                                            |
1552 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1553 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1554 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1555 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1556 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1557 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1558 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1559 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1560 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1561 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1562 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1563 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1564 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1565 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1566 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1567 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1568 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1569 | metada               | O               | 1                 | keypair                               | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1570 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1571 | **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.**   |
1572 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1573 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1574 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1575 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1576 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1577 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1578 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1579
1580 200: ok
1581
1582 500: failed
1583
1584 7.4. **Get Server**
1585 -------------------
1586
1587 +---------------------+-------------------------------------------------------------------------------------------+
1588 | **IF Definition**   | **Description**                                                                           |
1589 +=====================+===========================================================================================+
1590 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid}   |
1591 +---------------------+-------------------------------------------------------------------------------------------+
1592 | Operation           | get                                                                                       |
1593 +---------------------+-------------------------------------------------------------------------------------------+
1594 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                     |
1595 +---------------------+-------------------------------------------------------------------------------------------+
1596
1597 7.4.1. **Request**
1598 >>>>>>>>>>>>>>>>>>
1599
1600 N/A
1601
1602 7.4.2. **Response**
1603 >>>>>>>>>>>>>>>>>>>
1604
1605 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1606 | **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                           | **Description**                                                                                                                                                                        |
1607 +======================+=================+===================+=======================================+========================================================================================================================================================================================+
1608 | vimId                | M               | 1                 | String                                | vim id                                                                                                                                                                                 |
1609 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1610 | vimName              | O               | 1                 | string                                | vim name                                                                                                                                                                               |
1611 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1612 | id                   | M               | 1                 | string                                | server id                                                                                                                                                                              |
1613 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1614 | name                 | M               | 1                 | string                                | server name                                                                                                                                                                            |
1615 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1616 | tenantId             | M               | 1                 | String                                | Tenant UUID                                                                                                                                                                            |
1617 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1618 | boot                 | M               | 1                 | String                                | Start parameters                                                                                                                                                                       |
1619 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1620 | nicArray             | O               | 1..n              | List of nic                           | List of nic                                                                                                                                                                            |
1621 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1622 | volumeArray          | O               | 1..n              | list of volume                        | list of volume                                                                                                                                                                         |
1623 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1624 | availabilityZone     | O               | 1                 | string                                | Usable field                                                                                                                                                                           |
1625 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1626 | flavorId             | M               | 1                 | String                                | server Flavor                                                                                                                                                                          |
1627 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1628 | metadata             | O               | 1                 | List of metadata                      | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
1629 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1630 | **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.**   |
1631 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1632 |                      |                 |                   |                                       | **[TBD]**                                                                                                                                                                              |
1633 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1634 | **serverGroup**      | **O**           | **1**             | **string**                            | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
1635 |                      |                 |                   |                                       |                                                                                                                                                                                        |
1636 |                      |                 |                   |                                       | [TBD]                                                                                                                                                                                  |
1637 +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1638
1639 200: ok
1640
1641 500: failed
1642
1643 8. **Flavor Management**
1644 ^^^^^^^^^^^^^^^^^^^^^^^^
1645
1646 8.1. **Create Flavor**
1647 ----------------------
1648
1649 +---------------------+--------------------------------------------------------------------------------+
1650 | **IF Definition**   | **Description**                                                                |
1651 +=====================+================================================================================+
1652 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors   |
1653 +---------------------+--------------------------------------------------------------------------------+
1654 | Operation           | POST                                                                           |
1655 +---------------------+--------------------------------------------------------------------------------+
1656 | Direction           | VNFLCM->MULTIVIM                                                               |
1657 +---------------------+--------------------------------------------------------------------------------+
1658
1659 8.1.1. **Request**
1660 >>>>>>>>>>>>>>>>>>
1661
1662 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1663 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1664 +=================+=================+===================+===============================+==============================================================================================================================+
1665 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1666 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1667 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1668 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1669 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1670 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1671 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1672 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1673 | ephemeral       | O               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1674 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1675 | swap            | O               | 1                 | int                           | The size of the swap disk                                                                                                    |
1676 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1677 | 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.   |
1678 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1679 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1680 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1681
1682 8.1.2. **Response**
1683 >>>>>>>>>>>>>>>>>>>
1684
1685 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1686 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**               | **Description**                                                                                                              |
1687 +=================+=================+===================+===========================+==============================================================================================================================+
1688 | id              | M               | 1                 | string                    | Flavor id                                                                                                                    |
1689 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1690 | name            | M               | 1                 | string                    | Flavor name                                                                                                                  |
1691 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1692 | returnCode      | M               | 1                 | int                       | 0: Already exist 1: Newly created                                                                                            |
1693 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1694 | tenantId        | M               | 1                 | String                    | Tenant UUID                                                                                                                  |
1695 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1696 | vcpu            | M               | 1                 | int                       | Virtual CPU number                                                                                                           |
1697 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1698 | memory          | M               | 1                 | int                       | Memory size                                                                                                                  |
1699 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1700 | disk            | M               | 1                 | int                       | The size of the root disk                                                                                                    |
1701 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1702 | ephemeral       | M               | 1                 | int                       | The size of the ephemeral disk                                                                                               |
1703 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1704 | swap            | M               | 1                 | int                       | The size of the swap disk                                                                                                    |
1705 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1706 | 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.   |
1707 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1708 | extraSpecs      | O               | 0..N              | List of Key-value pairs   | EPA parameter                                                                                                                |
1709 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1710 | vimId           | M               | 1                 | String                    | vim id                                                                                                                       |
1711 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1712 | vimName         | O               | 1                 | string                    | vim name                                                                                                                     |
1713 +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1714
1715 8.2. **Delete Flavor**
1716 ----------------------
1717
1718 +---------------------+--------------------------------------------------------------------------------------------+
1719 | **IF Definition**   | **Description**                                                                            |
1720 +=====================+============================================================================================+
1721 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid}   |
1722 +---------------------+--------------------------------------------------------------------------------------------+
1723 | Operation           | DELETE                                                                                     |
1724 +---------------------+--------------------------------------------------------------------------------------------+
1725 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                      |
1726 +---------------------+--------------------------------------------------------------------------------------------+
1727
1728 8.2.1. **Request**
1729 >>>>>>>>>>>>>>>>>>
1730
1731 N/A
1732
1733 8.2.2. **Response**
1734 >>>>>>>>>>>>>>>>>>>
1735
1736 204: no content
1737
1738 8.3. **List Flavor**
1739 --------------------
1740
1741 +---------------------+---------------------------------------------------------------------------------+
1742 | **IF Definition**   | **Description**                                                                 |
1743 +=====================+=================================================================================+
1744 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors   |
1745 +---------------------+---------------------------------------------------------------------------------+
1746 | Operation           | get                                                                             |
1747 +---------------------+---------------------------------------------------------------------------------+
1748 | Direction           | NFLCM,NSLCM->MULTIVIM                                                           |
1749 +---------------------+---------------------------------------------------------------------------------+
1750
1751 8.3.1. **Query**
1752 >>>>>>>>>>>>>>>>
1753
1754 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1755 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                  |
1756 +=================+=================+===================+===============+==================================+
1757 | name            | M               | 1                 | string        | Flavor name to filter out list   |
1758 +-----------------+-----------------+-------------------+---------------+----------------------------------+
1759
1760 8.3.2. **Response**
1761 >>>>>>>>>>>>>>>>>>>
1762
1763 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1764 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1765 +=================+=================+===================+===============================+==============================================================================================================================+
1766 | flavors         | M               | 0..N              | list                          | Vm list                                                                                                                      |
1767 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1768 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
1769 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1770 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1771 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1772 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1773 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1774 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1775 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1776 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1777 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1778 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1779 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1780 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
1781 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1782 | 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.   |
1783 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1784 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1785 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1786 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
1787 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1788 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
1789 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1790 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
1791 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1792
1793 200: ok
1794
1795 500: failed
1796
1797 8.4. **Get Flavor**
1798 -------------------
1799
1800 +---------------------+----------------------------------------------------------------------------------------------+
1801 | **IF Definition**   | **Description**                                                                              |
1802 +=====================+==============================================================================================+
1803 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid }   |
1804 +---------------------+----------------------------------------------------------------------------------------------+
1805 | Operation           | get                                                                                          |
1806 +---------------------+----------------------------------------------------------------------------------------------+
1807 | Direction           | NFLCM,NSLCM->MULTIVIM                                                                        |
1808 +---------------------+----------------------------------------------------------------------------------------------+
1809
1810 8.4.1. **Request**
1811 >>>>>>>>>>>>>>>>>>
1812
1813 N/A
1814
1815 8.4.2. **Response**
1816 >>>>>>>>>>>>>>>>>>>
1817
1818 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1819 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**                   | **Description**                                                                                                              |
1820 +=================+=================+===================+===============================+==============================================================================================================================+
1821 | id              | M               | 1                 | string                        | Flavor id                                                                                                                    |
1822 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1823 | name            | M               | 1                 | string                        | Flavor Name                                                                                                                  |
1824 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1825 | vcpu            | M               | 1                 | int                           | Virtual CPU number                                                                                                           |
1826 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1827 | memory          | M               | 1                 | int                           | Memory size                                                                                                                  |
1828 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1829 | disk            | M               | 1                 | int                           | The size of the root disk                                                                                                    |
1830 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1831 | ephemeral       | M               | 1                 | int                           | The size of the ephemeral disk                                                                                               |
1832 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1833 | swap            | M               | 1                 | int                           | The size of the swap disk                                                                                                    |
1834 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1835 | 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.   |
1836 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1837 | extraSpecs      | O               | 0..N              | List of keyname-value pairs   | EPA parameter                                                                                                                |
1838 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1839 | vimId           | M               | 1                 | String                        | vim id                                                                                                                       |
1840 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1841 | vimName         | O               | 1                 | string                        | vim name                                                                                                                     |
1842 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1843 | tenantId        | M               | 1                 | String                        | Tenant UUID                                                                                                                  |
1844 +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1845
1846 200: ok
1847
1848 500: failed
1849
1850 9. **Volume Management**
1851 ^^^^^^^^^^^^^^^^^^^^^^^^
1852
1853 9.1. **Create Volume**
1854 ----------------------
1855
1856 +---------------------+--------------------------------------------------------------------------------+
1857 | **IF Definition**   | **Description**                                                                |
1858 +=====================+================================================================================+
1859 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
1860 +---------------------+--------------------------------------------------------------------------------+
1861 | Operation           | POST                                                                           |
1862 +---------------------+--------------------------------------------------------------------------------+
1863 | Direction           | NSLCM->MULTIVIM                                                                |
1864 +---------------------+--------------------------------------------------------------------------------+
1865
1866 9.1.1. **Request**
1867 >>>>>>>>>>>>>>>>>>
1868
1869 +--------------------+-----------------+-------------------+---------------+-------------------+
1870 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1871 +====================+=================+===================+===============+===================+
1872 | name               | M               | 1                 | string        | Volume name       |
1873 +--------------------+-----------------+-------------------+---------------+-------------------+
1874 | volumeSize         | M               | 1                 | int           | Volume size       |
1875 +--------------------+-----------------+-------------------+---------------+-------------------+
1876 | imageId            | O               | 1                 | string        | Image UUID        |
1877 +--------------------+-----------------+-------------------+---------------+-------------------+
1878 | volumeType         | O               | 1                 | string        | Volume type       |
1879 +--------------------+-----------------+-------------------+---------------+-------------------+
1880 | availabilityZone   | O               | 1                 | string        | Usable field      |
1881 +--------------------+-----------------+-------------------+---------------+-------------------+
1882
1883 ::
1884
1885     {
1886
1887     "tenant": "tenant1",
1888
1889     "volumeName": "volume1",
1890
1891     "volumeSize": 3,
1892
1893     "imageName": "cirros.qcow2",
1894
1895     "volumeType": "volumetype1",
1896
1897     "availabilityZone": "zone1"
1898
1899     }
1900
1901 9.1.2. **Response**
1902 >>>>>>>>>>>>>>>>>>>
1903
1904 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1905 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
1906 +====================+=================+===================+===============+=====================================+
1907 | returnCode         | M               | 1                 | int           | 0: Already exist 1: Newly created   |
1908 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1909 | vimId              | M               | 1                 | String        | vim id                              |
1910 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1911 | vimName            | O               | 1                 | string        | vim name                            |
1912 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1913 | tenantId           | M               | 1                 | String        | Tenant UUID                         |
1914 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1915 | status             | M               | 1                 | string        | Volume status                       |
1916 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1917 | id                 | M               | 1                 | string        | Volume id                           |
1918 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1919 | name               | M               | 1                 | string        | Volume name                         |
1920 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1921 | volumeType         | O               | 1                 | string        | Volume type                         |
1922 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1923 | availabilityZone   | O               | 1                 | string        | Availability Zone                   |
1924 +--------------------+-----------------+-------------------+---------------+-------------------------------------+
1925
1926 202: accepted
1927
1928 500: failed
1929
1930 ::
1931
1932     {
1933
1934     "id": "bc9eebdbbfd356458269340b9ea6fb73",
1935
1936     "name": "volume1",
1937
1938     "returnCode": 1,
1939
1940     }
1941
1942 9.2. **Delete Volume**
1943 ----------------------
1944
1945 +---------------------+-------------------------------------------------------------------------------------------+
1946 | **IF Definition**   | **Description**                                                                           |
1947 +=====================+===========================================================================================+
1948 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId}   |
1949 +---------------------+-------------------------------------------------------------------------------------------+
1950 | Operation           | DELETE                                                                                    |
1951 +---------------------+-------------------------------------------------------------------------------------------+
1952 | Direction           | NSLCM->MULTIVIM                                                                           |
1953 +---------------------+-------------------------------------------------------------------------------------------+
1954
1955 9.2.1. **Request**
1956 >>>>>>>>>>>>>>>>>>
1957
1958     N/A
1959
1960 9.2.2. **Response**
1961 >>>>>>>>>>>>>>>>>>>
1962
1963     204: no content
1964
1965 9.3. **List Volumes**
1966 ---------------------
1967
1968 +---------------------+--------------------------------------------------------------------------------+
1969 | **IF Definition**   | **Description**                                                                |
1970 +=====================+================================================================================+
1971 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes   |
1972 +---------------------+--------------------------------------------------------------------------------+
1973 | Operation           | GET                                                                            |
1974 +---------------------+--------------------------------------------------------------------------------+
1975 | Direction           | NSLCM-> MULTIVIM                                                               |
1976 +---------------------+--------------------------------------------------------------------------------+
1977
1978 9.3.1. **Request**
1979 >>>>>>>>>>>>>>>>>>
1980
1981     msb.onap.org:80/api/multicloud/v0/{cloud
1982     owner}\_{region}/volumes?{……}
1983
1984 +-----------------+-----------------+-------------------+---------------+-------------------+
1985 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
1986 +=================+=================+===================+===============+===================+
1987 | name            | M               | 1                 | string        | Volume name       |
1988 +-----------------+-----------------+-------------------+---------------+-------------------+
1989
1990 9.3.2. **Response**
1991 >>>>>>>>>>>>>>>>>>>
1992
1993 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1994 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
1995 +====================+=================+===================+======================+====================================================+
1996 | vimId              | M               | 1                 | String               | vim id                                             |
1997 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1998 | vimName            | O               | 1                 | string               | vim name                                           |
1999 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2000 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2001 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2002 | volumes            | M               | 1                 | Array                |                                                    |
2003 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2004 | id                 | M               | 1                 | string               | Volume id                                          |
2005 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2006 | name               | M               | 1                 | string               | Volume name                                        |
2007 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2008 | createTime         | O               | 1                 | string               | Create time                                        |
2009 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2010 | status             | M               | 1                 | string               | Volume status                                      |
2011 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2012 | volumeSize         | M               | 1                 | int                  | Volume size                                        |
2013 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2014 | volumeType         | M               | 1                 | string               | Volume type                                        |
2015 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2016 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2017 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2018 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2019 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2020
2021 200: ok
2022
2023 500: failed
2024
2025 ::
2026
2027     {
2028
2029         "volumes": [
2030
2031             {
2032
2033                 "status": "available",
2034
2035                 "name": "test",
2036
2037                 "attachments": [],
2038
2039                 "createTime": "2015-12-02T07:57:23.000000",
2040
2041                 " volumeType ": "ws",
2042
2043                 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
2044
2045                 "size": 20
2046
2047             },
2048
2049             {
2050
2051                 "status": "in-use",
2052
2053                 "name": "wangsong",
2054
2055                 "attachments": [
2056
2057                     {
2058
2059                         "device": "/dev/vdc",
2060
2061                         "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2062
2063                         "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2064
2065                         "hostName": null,
2066
2067                         "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2068
2069                     }
2070
2071                 ],
2072
2073                 "createTime": "2015-12-02T06:39:40.000000",
2074
2075                 " volumeType ": null,
2076
2077                 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2078
2079                 "size": 40
2080
2081             }
2082
2083         ]
2084
2085     }
2086
2087 9.4. **Get Volumes**
2088 --------------------
2089
2090 +---------------------+-------------------------------------------------------------------------------------------+
2091 | **IF Definition**   | **Description**                                                                           |
2092 +=====================+===========================================================================================+
2093 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid}   |
2094 +---------------------+-------------------------------------------------------------------------------------------+
2095 | Operation           | GET                                                                                       |
2096 +---------------------+-------------------------------------------------------------------------------------------+
2097 | Direction           | NSLCM-> MULTIVIM                                                                          |
2098 +---------------------+-------------------------------------------------------------------------------------------+
2099
2100 9.4.1. **Request**
2101 >>>>>>>>>>>>>>>>>>
2102
2103     N/A
2104
2105 9.4.2. **Response**
2106 >>>>>>>>>>>>>>>>>>>
2107
2108 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2109 | **Parameter**      | **Qualifier**   | **Cardinality**   | **Content**          | **Description**                                    |
2110 +====================+=================+===================+======================+====================================================+
2111 | vimId              | M               | 1                 | String               | vim id                                             |
2112 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2113 | vimName            | O               | 1                 | string               | vim name                                           |
2114 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2115 | tenantId           | M               | 1                 | String               | Tenant UUID                                        |
2116 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2117 | id                 |                 | 1                 | string               | Volume id                                          |
2118 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2119 | name               |                 | 1                 | string               | Volume name                                        |
2120 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2121 | createTime         |                 | 1                 | string               | Create time                                        |
2122 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2123 | status             |                 | 1                 | string               | Volume status                                      |
2124 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2125 | volumeType         |                 | 1                 | list of string       | Volume type                                        |
2126 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2127 | volumeSize         |                 | 1                 | int                  | Volume size                                        |
2128 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2129 | availabilityZone   | M               | 1                 | string               | Availability Zone                                  |
2130 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2131 | attachments        | M               | 1..n              | list of attachment   | List of additional information on the cloud disk   |
2132 +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2133
2134 **attachment：**
2135
2136 +-----------------+-----------------+-------------------+---------------+-------------------+
2137 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2138 +=================+=================+===================+===============+===================+
2139 | device          |                 | 1                 | string        | Device name       |
2140 +-----------------+-----------------+-------------------+---------------+-------------------+
2141 | serverId        |                 | 1                 | string        | VM id             |
2142 +-----------------+-----------------+-------------------+---------------+-------------------+
2143 | volumeId        |                 | 1                 | string        | Volume id         |
2144 +-----------------+-----------------+-------------------+---------------+-------------------+
2145 | hostName        |                 | 1                 | string        | Host name         |
2146 +-----------------+-----------------+-------------------+---------------+-------------------+
2147 | id              |                 | 1                 | string        | Device id         |
2148 +-----------------+-----------------+-------------------+---------------+-------------------+
2149
2150 200: ok
2151
2152 500: failed
2153
2154 ::
2155
2156     {
2157
2158         "status": "in-use",
2159
2160         "name": "wangsong",
2161
2162         "attachments": [
2163
2164             {
2165
2166                 "device": "/dev/vdc",
2167
2168                 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2169
2170                 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2171
2172                 "hostName": null,
2173
2174                 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2175
2176             }
2177
2178         ],
2179
2180         "createTime": "2015-12-02T06:39:40.000000",
2181
2182         "volumeType ": null,
2183
2184         "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2185
2186         "volumeSize ": 40
2187
2188     }
2189
2190 10. **Tenant Management**
2191 ^^^^^^^^^^^^^^^^^^^^^^^^^
2192
2193 10.1. **List tenants**
2194 ----------------------
2195
2196 +---------------------+---------------------------------------------------------------------+
2197 | **IF Definition**   | **Description**                                                     |
2198 +=====================+=====================================================================+
2199 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants   |
2200 +---------------------+---------------------------------------------------------------------+
2201 | Operation           | GET                                                                 |
2202 +---------------------+---------------------------------------------------------------------+
2203 | Direction           | NSLCM-> MULTIVIM                                                    |
2204 +---------------------+---------------------------------------------------------------------+
2205
2206 10.1.1. **Query**
2207 >>>>>>>>>>>>>>>>>
2208
2209 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2210 | **Parameter**       | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                     |
2211 +=====================+=================+===================+===============+=====================================+
2212 | name={tenantname}   | O               | 1                 | string        | Tenant name to filter output list   |
2213 +---------------------+-----------------+-------------------+---------------+-------------------------------------+
2214
2215 10.1.2. **Response**
2216 >>>>>>>>>>>>>>>>>>>>
2217
2218 +-----------------+-----------------+-------------------+---------------+-------------------+
2219 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**   |
2220 +=================+=================+===================+===============+===================+
2221 | vimId           | M               | 1                 | String        | vim id            |
2222 +-----------------+-----------------+-------------------+---------------+-------------------+
2223 | vimName         | O               | 1                 | string        | vim name          |
2224 +-----------------+-----------------+-------------------+---------------+-------------------+
2225 | tenants         | M               | 1                 | Array         |                   |
2226 +-----------------+-----------------+-------------------+---------------+-------------------+
2227 | id              | M               | 1                 | string        | tenant UUID       |
2228 +-----------------+-----------------+-------------------+---------------+-------------------+
2229 | name            | M               | 1                 | string        | tenant name       |
2230 +-----------------+-----------------+-------------------+---------------+-------------------+
2231
2232 200: ok
2233
2234 500: failed
2235
2236 ::
2237
2238     {
2239
2240         " tenants ": [
2241
2242             {
2243
2244                 "id": "1",
2245
2246                 "name": "test\_a"
2247
2248             }
2249
2250         ]
2251
2252     }
2253
2254 11. **Limits**
2255 ^^^^^^^^^^^^^^
2256
2257 11.1. **List Limits of resouces**
2258 ---------------------------------
2259
2260 +---------------------+-------------------------------------------------------------------------------+
2261 | **IF Definition**   | **Description**                                                               |
2262 +=====================+===============================================================================+
2263 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits   |
2264 +---------------------+-------------------------------------------------------------------------------+
2265 | Operation           | GET                                                                           |
2266 +---------------------+-------------------------------------------------------------------------------+
2267 | Direction           | NSLCM-> MULTIVIM                                                              |
2268 +---------------------+-------------------------------------------------------------------------------+
2269
2270 11.1.1. **Request**
2271 >>>>>>>>>>>>>>>>>>>
2272
2273 N/A
2274
2275 11.1.2. **Response**
2276 >>>>>>>>>>>>>>>>>>>>
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 | maxPersonality            | O               | 1                 | int           | The number of allowed injected files for each tenant.            |
2288 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2289 | maxPersonalitySize        | O               | 1                 | int           | The number of allowed bytes of content for each injected file.   |
2290 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2291 | maxServerGroupMembers     | O               | 1                 | int           | The number of allowed members for each server group.             |
2292 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2293 | maxServerGroups           | O               | 1                 | int           | The number of allowed server groups for each tenant.             |
2294 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2295 | maxServerMeta             | O               | 1                 | int           | The number of allowed metadata items for each instance.          |
2296 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2297 | maxTotalCores             | O               | 1                 | int           | The number of allowed instance cores for each tenant.            |
2298 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2299 | maxTotalInstances         | O               | 1                 | int           | The number of allowed instances for each tenant.                 |
2300 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2301 | maxTotalKeypairs          | O               | 1                 | int           | The number of allowed key pairs for each user.                   |
2302 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2303 | maxTotalRAMSize           | O               | 1                 | int           | The amount of allowed instance RAM, in MB, for each tenant.      |
2304 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2305 | maxTotalVolumeGigabytes   | O               | 1                 | int           | The maximum total amount of volumes, in gibibytes (GiB).         |
2306 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2307 | maxTotalVolumes           | O               | 1                 | int           | The maximum number of volumes.                                   |
2308 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2309 | totalVolumesUsed          | O               | 1                 | int           | The total number of volumes used.                                |
2310 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2311 | totalGigabytesUsed        | O               | 1                 | int           | The total number of gibibytes (GiB) used.                        |
2312 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2313 | network                   | O               | 1                 | int           | The number of networks allowed for each project.                 |
2314 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2315 | subnet                    | O               | 1                 | int           | The number of subnets allowed for each project.                  |
2316 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2317 | subnetpool                | O               | 1                 | int           | The number of subnet pools allowed for each project.             |
2318 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2319 | security\_group\_rule     | O               | 1                 | int           | The number of security group rules allowed for each project.     |
2320 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2321 | security\_group           | O               | 1                 | int           | The number of security groups allowed for each project.          |
2322 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2323 | router                    | O               | 1                 | int           | The number of routers allowed for each project.                  |
2324 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2325 | port                      | O               | 1                 | int           | The number of ports allowed for each project.                    |
2326 +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2327
2328 200: ok
2329
2330 500: failed
2331
2332 ::
2333
2334     {
2335
2336     "maxPersonality": 5,
2337
2338     "maxPersonalitySize": 10240,
2339
2340     "maxServerMeta": 128,
2341
2342     "maxTotalCores": 20,
2343
2344     "maxTotalInstances": 10,
2345
2346     "maxTotalKeypairs": 100,
2347
2348     "maxTotalRAMSize": 51200,
2349
2350     "maxServerGroups": 10,
2351
2352     "maxServerGroupMembers": 10,
2353
2354     }
2355
2356 12. **Host Management**
2357 ^^^^^^^^^^^^^^^^^^^^^^^
2358
2359 12.1. **List hosts**
2360 --------------------
2361
2362 +---------------------+------------------------------------------------------------------------------+
2363 | **IF Definition**   | **Description**                                                              |
2364 +=====================+==============================================================================+
2365 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts   |
2366 +---------------------+------------------------------------------------------------------------------+
2367 | Operation           | GET                                                                          |
2368 +---------------------+------------------------------------------------------------------------------+
2369 | Direction           | NSLCM-> MULTIVIM                                                             |
2370 +---------------------+------------------------------------------------------------------------------+
2371
2372 12.1.1. **Request**
2373 >>>>>>>>>>>>>>>>>>>
2374
2375 N/A
2376
2377 12.1.2. **Response**
2378 >>>>>>>>>>>>>>>>>>>>
2379
2380 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2381 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**     | **Description**                   |
2382 +=================+=================+===================+=================+===================================+
2383 | vimId           | M               | 1                 | String          | vim id                            |
2384 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2385 | vimName         | O               | 1                 | string          | vim name                          |
2386 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2387 | tenantId        | M               | 1                 | string          | Tenant Name                       |
2388 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2389 | hosts           | M               | 1                 | Array of host   | List of host information          |
2390 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2391 | service         | M               | 1                 | string          | The service running on the host   |
2392 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2393 | name            | M               | 1                 | string          | host name                         |
2394 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2395 | zone            | O               | 1                 | string          | Available zone for the host       |
2396 +-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2397
2398 200: ok
2399
2400 500: failed
2401
2402 ::
2403
2404     {
2405
2406         "vimId": "123",
2407
2408         "vimName": "vimName",
2409
2410         "tenantId": "tenantId1"
2411
2412         "hosts": [
2413
2414             {
2415
2416                 "name": "b6e4adbc193d428ea923899d07fb001e",
2417
2418                 "service": "conductor",
2419
2420                 "zone": "internal",
2421
2422                 "vimId": "123",
2423
2424                 "vimName": "vimName",
2425
2426                 "tenantId": "tenantId1"
2427
2428             },
2429
2430             {
2431
2432                 "name": "09c025b0efc64211bd23fc50fa974cdf",
2433
2434                 "service": "compute",
2435
2436                 "zone": "nova"
2437
2438                 "vimId": "123",
2439
2440                 "vimName": "vimName",
2441
2442                 "tenantId": "tenantId1"
2443
2444             },
2445
2446             {
2447
2448                 "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
2449
2450                 "service": "consoleauth",
2451
2452                 "zone": "internal"
2453
2454                 "vimId": "123",
2455
2456                 "vimName": "vimName",
2457
2458                 "tenantId": "tenantId1"
2459
2460             },
2461
2462             {
2463
2464                 "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
2465
2466                 "service": "network",
2467
2468                 "zone": "internal"
2469
2470                 "vimId": "123",
2471
2472                 "vimName": "vimName",
2473
2474                 "tenantId": "tenantId1"
2475
2476             },
2477
2478             {
2479
2480                 "name": "abffda96592c4eacaf4111c28fddee17",
2481
2482                 "service": "scheduler",
2483
2484                 "zone": "internal"
2485
2486                 "vimId": "123",
2487
2488                 "vimName": "vimName",
2489
2490                 "tenantId": "tenantId1"
2491
2492             }
2493
2494         ]
2495
2496     }
2497
2498 12.2. **Get host**
2499 ------------------
2500
2501 +---------------------+-----------------------------------------------------------------------------------------+
2502 | **IF Definition**   | **Description**                                                                         |
2503 +=====================+=========================================================================================+
2504 | URI                 | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/hosts/{hostname}    |
2505 +---------------------+-----------------------------------------------------------------------------------------+
2506 | Operation           | GET                                                                                     |
2507 +---------------------+-----------------------------------------------------------------------------------------+
2508 | Direction           | NSLCM-> MULTIVIM                                                                        |
2509 +---------------------+-----------------------------------------------------------------------------------------+
2510
2511 12.2.1. **Request**
2512 >>>>>>>>>>>>>>>>>>>
2513
2514 12.2.2. **Response**
2515 >>>>>>>>>>>>>>>>>>>>
2516
2517 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2518 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**         | **Description**                                              |
2519 +=================+=================+===================+=====================+==============================================================+
2520 | vimId           | M               | 1                 | String              | vim id                                                       |
2521 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2522 | vimName         | O               | 1                 | string              | vim name                                                     |
2523 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2524 | tenantId        | M               | 1                 | string              | Tenant Name                                                  |
2525 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2526 | host            | M               | 1                 | List of resources   | Host resource info                                           |
2527 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2528 | resource        | M               | 1..N              | Object              | Resource description                                         |
2529 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2530 | cpu             | M               | 1                 | Int                 | The cpu info on the host.                                    |
2531 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2532 | memory_mb       | M               | 1                 | int                 | The memory info on the host (in MB).                         |
2533 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2534 | name            | M               | 1                 | string              | host name                                                    |
2535 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2536 | project         | M               | 1                 | string              | Value: total, used_now, used_max or specific project_id      |
2537 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2538 | disk_gb         | M               | 1                 | int                 | The disk info on the host (in GB).                           |
2539 +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2540
2541 200: ok
2542
2543 500: failed
2544
2545 ::
2546
2547     {
2548
2549         "cpu": 1,
2550
2551         "disk\_gb": 1028,
2552
2553         "name": "c1a7de0ac9d94e4baceae031d05caae3",
2554
2555         "memory\_mb": 8192,
2556
2557         "vimId": "123",
2558
2559         "vimName": "vimName",
2560
2561         "tenantId": "tenantId1",
2562
2563         "host": [
2564
2565             {
2566
2567                 "memory\_mb": 4960,
2568
2569                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2570
2571                 "disk\_gb": 92,
2572
2573                 "project": "(total)",
2574
2575                 "cpu": 4
2576
2577             },
2578
2579             {
2580
2581                 "memory\_mb": 1536,
2582
2583                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2584
2585                 "disk\_gb": 2,
2586
2587                 "project": "(used\_now)",
2588
2589                 "cpu": 2
2590
2591             },
2592
2593             {
2594
2595                 "memory\_mb": 1024,
2596
2597                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2598
2599                 "disk\_gb": 2,
2600
2601                 "project": "(used\_max)",
2602
2603                 "cpu": 2
2604
2605             },
2606
2607             {
2608
2609                 "memory\_mb": 1024,
2610
2611                 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2612
2613                 "disk\_gb": 2,
2614
2615                 "project": "568f7ec425db472ba348251bf1e7eebd",
2616
2617                 "cpu": 2
2618
2619             }
2620
2621         ],
2622
2623         "vimName": "openstack\_newton",
2624
2625         "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2626
2627         "tenantId": "568f7ec425db472ba348251bf1e7eebd"
2628
2629     }
2630
2631 13. **VIM Management**
2632 ^^^^^^^^^^^^^^^^^^^^^^
2633
2634 13.1. **Update VIM Info**
2635 -------------------------
2636
2637 +---------------------+----------------------------------------------------------------------------------------------+
2638 | **IF Definition**   | **Description**                                                                              |
2639 +=====================+==============================================================================================+
2640 | URI                 | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region}/registry               |
2641 +---------------------+----------------------------------------------------------------------------------------------+
2642 | Operation           | POST                                                                                         |
2643 +---------------------+----------------------------------------------------------------------------------------------+
2644 | Direction           | ESR-> MULTICLOUD                                                                             |
2645 +---------------------+----------------------------------------------------------------------------------------------+
2646
2647 13.1.1. **Request**
2648 >>>>>>>>>>>>>>>>>>>
2649
2650 +-----------------+-----------------+-------------------+---------------+-----------------------+
2651 | **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**       |
2652 +=================+=================+===================+===============+=======================+
2653 | defaultTenant   | M               | 1                 | string        | default tenant name   |
2654 +-----------------+-----------------+-------------------+---------------+-----------------------+
2655
2656 13.1.2. **Response**
2657 >>>>>>>>>>>>>>>>>>>>
2658
2659 NA
2660
2661 202: accept
2662
2663 400: failed
2664
2665 13.2. **Unregistry VIM**
2666 ------------------------
2667
2668 +---------------------+-----------------------------------------------------------------------------------------------+
2669 | **IF Definition**   | **Description**                                                                               |
2670 +=====================+===============================================================================================+
2671 | URI                 | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region}                         |
2672 +---------------------+-----------------------------------------------------------------------------------------------+
2673 | Operation           | DELETE                                                                                        |
2674 +---------------------+-----------------------------------------------------------------------------------------------+
2675 | Direction           | ESR-> MULTICLOUD                                                                              |
2676 +---------------------+-----------------------------------------------------------------------------------------------+
2677
2678 13.2.1. **Request**
2679 >>>>>>>>>>>>>>>>>>>
2680
2681 NA
2682
2683 13.2.2. **Response**
2684 >>>>>>>>>>>>>>>>>>>>
2685
2686 NA
2687
2688 204: No content found
2689
2690 400: failed