X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2FMultiCloud-API-Specification-V1.rst;h=8283077b49d8d8b5ea8ba4fd066ed94b1e851c0f;hb=59362c42f10c4df0a303572a4b6fb8ac790c7b69;hp=cb3b32c5474b1a3952b88e5424b9416fce185b89;hpb=42fbfdc598d852e24c17edf2dfa89f73bdbf217e;p=multicloud%2Fframework.git diff --git a/docs/MultiCloud-API-Specification-V1.rst b/docs/MultiCloud-API-Specification-V1.rst index cb3b32c..8283077 100644 --- a/docs/MultiCloud-API-Specification-V1.rst +++ b/docs/MultiCloud-API-Specification-V1.rst @@ -1,3 +1,7 @@ +.. + This work is licensed under a Creative Commons Attribution 4.0 + International License. + ================================ MultiCloud API Specification V1 ================================ @@ -5,246 +9,14 @@ MultiCloud API Specification V1 API Catalog =========== -`1. Scope 5 <#_Toc490851650>`__ - -`2. Terms, Definitions and Abbreviations 5 <#_Toc490851651>`__ - -`3. Image Management 5 <#_Toc490851652>`__ - -`3.1 Create Image 5 <#_Toc490851653>`__ - -`3.1.1 Request 5 <#_Toc490851654>`__ - -`3.1.2 Response 6 <#_Toc490851655>`__ - -`3.2 Delete Image 7 <#_Toc490851656>`__ - -`3.2.1 Request 7 <#_Toc490851657>`__ - -`3.2.2 Response 7 <#_Toc490851658>`__ - -`3.3 List Images 7 <#_Toc490851659>`__ - -`3.3.1 Request 7 <#_Toc490851660>`__ - -`3.3.2 Response 8 <#_Toc490851661>`__ - -`3.4 Get Image 9 <#_Toc490851662>`__ - -`3.4.1 Request 9 <#_Toc490851663>`__ - -`3.4.2 Response 9 <#_Toc490851664>`__ - -`4. Network Management 10 <#_Toc490851665>`__ - -`4.1 Create Network 10 <#_Toc490851666>`__ - -`4.1.1 Request 10 <#_Toc490851667>`__ - -`4.1.2 Response 11 <#_Toc490851668>`__ - -`4.2 Delete Network 12 <#_Toc490851669>`__ - -`4.2.1 Request 12 <#_Toc490851670>`__ - -`4.2.2 Response 12 <#_Toc490851671>`__ - -`4.3 List Network 12 <#_Toc490851672>`__ - -`4.3.1 Query 12 <#_Toc490851673>`__ - -`4.3.2 Response 13 <#_Toc490851674>`__ - -`4.4 Get Network 14 <#_Toc490851675>`__ - -`4.4.1 Request 14 <#_Toc490851676>`__ - -`4.4.2 Response 14 <#_Toc490851677>`__ - -`5. Subnetwork Management 16 <#_Toc490851678>`__ - -`5.1 Create Subnets 16 <#_Toc490851679>`__ - -`5.1.1 Request 16 <#_Toc490851680>`__ - -`5.1.2 Response 17 <#_Toc490851681>`__ - -`5.2 Delete Subnets 18 <#_Toc490851682>`__ - -`5.2.1 Request 18 <#_Toc490851683>`__ - -`5.2.2 Response 18 <#_Toc490851684>`__ - -`5.3 List Subnets 18 <#_Toc490851685>`__ - -`5.3.1 Query 18 <#_Toc490851686>`__ - -`5.3.2 Response 19 <#_Toc490851687>`__ - -`5.4 Get Subnets 20 <#_Toc490851688>`__ - -`5.4.1 Request 20 <#_Toc490851689>`__ - -`5.4.2 Response 20 <#_Toc490851690>`__ - -`6. Virtual Port 21 <#_Toc490851691>`__ - -`6.1 Create Virtual Port 21 <#_Toc490851692>`__ - -`6.1.1 Request 21 <#_Toc490851693>`__ - -`6.1.2 Response 22 <#_Toc490851694>`__ - -`6.2 Delete Virtual Port 22 <#_Toc490851695>`__ - -`6.2.1 Request 23 <#_Toc490851696>`__ - -`6.2.2 Response 23 <#_Toc490851697>`__ - -`6.3 List Virtual Port 23 <#_Toc490851698>`__ - -`6.3.1 Query 23 <#_Toc490851699>`__ - -`6.3.2 Response 23 <#_Toc490851700>`__ - -`6.4 Get Virtual Port 24 <#_Toc490851701>`__ - -`6.4.1 Request 24 <#_Toc490851702>`__ - -`6.4.2 Response 24 <#_Toc490851703>`__ - -`7. Server Management 25 <#_Toc490851704>`__ - -`7.1 Create Server 25 <#_Toc490851705>`__ - -`7.1.1 Request 25 <#_Toc490851706>`__ - -`7.1.2 Response 27 <#_Toc490851707>`__ - -`7.2 Delete Server 28 <#_Toc490851708>`__ - -`7.2.1 Request 28 <#_Toc490851709>`__ - -`7.2.2 Response 28 <#_Toc490851710>`__ - -`7.3 List Server 28 <#_Toc490851711>`__ - -`7.3.1 Request 28 <#_Toc490851712>`__ - -`7.3.2 Response 29 <#_Toc490851713>`__ - -`7.4 Get Server 29 <#_Toc490851714>`__ - -`7.4.1 Request 30 <#_Toc490851715>`__ - -`7.4.2 Response 30 <#_Toc490851716>`__ - -`8. Flavor Management 30 <#_Toc490851717>`__ - -`8.1 Create Flavor 31 <#_Toc490851718>`__ - -`8.1.1 Request 31 <#_Toc490851719>`__ - -`8.1.2 Response 31 <#_Toc490851720>`__ - -`8.2 Delete Flavor 32 <#_Toc490851721>`__ - -`8.2.1 Request 32 <#_Toc490851722>`__ - -`8.2.2 Response 32 <#_Toc490851723>`__ - -`8.3 List Flavor 32 <#_Toc490851724>`__ - -`8.3.1 Query 32 <#_Toc490851725>`__ - -`8.3.2 Response 32 <#_Toc490851726>`__ - -`8.4 Get Flavor 33 <#_Toc490851727>`__ - -`8.4.1 Request 33 <#_Toc490851728>`__ - -`8.4.2 Response 33 <#_Toc490851729>`__ - -`9. Volume Management 34 <#_Toc490851730>`__ - -`9.1 Create Volume 34 <#_Toc490851731>`__ - -`9.1.1 Request 34 <#_Toc490851732>`__ - -`9.1.2 Response 34 <#_Toc490851733>`__ - -`9.2 Delete Volume 35 <#_Toc490851734>`__ - -`9.2.1 Request 35 <#_Toc490851735>`__ - -`9.2.2 Response 35 <#_Toc490851736>`__ - -`9.3 List Volumes 35 <#_Toc490851737>`__ - -`9.3.1 Request 35 <#_Toc490851738>`__ - -`9.3.2 Response 36 <#_Toc490851739>`__ - -`9.4 Get Volumes 37 <#_Toc490851740>`__ - -`9.4.1 Request 37 <#_Toc490851741>`__ - -`9.4.2 Response 37 <#_Toc490851742>`__ - -`10. Tenant Management 38 <#_Toc490851743>`__ - -`10.1 List tenants 38 <#_Toc490851744>`__ - -`10.1.1 Query 38 <#_Toc490851745>`__ - -`10.1.2 Response 38 <#_Toc490851746>`__ - -`11. Limits 39 <#_Toc490851747>`__ - -`11.1 List Limits of resouces: CPU&Memory, volume,network,etc -39 <#_Toc490851748>`__ - -`11.1.1 Request 39 <#_Toc490851749>`__ - -`11.1.2 Response 39 <#_Toc490851750>`__ - -`12. Host Management 41 <#_Toc490851751>`__ - -`12.1 List hosts 41 <#_Toc490851752>`__ - -`12.1.1 Request 41 <#_Toc490851753>`__ - -`12.1.2 Response 41 <#_Toc490851754>`__ - -`12.2 Get host 43 <#_Toc490851755>`__ - -`12.2.1 Request 43 <#_Toc490851756>`__ - -`12.2.2 Response 43 <#_Toc490851757>`__ - -`13. VIM Management 45 <#_Toc490851758>`__ - -`13.1 Update VIM Info 45 <#_Toc490851759>`__ - -`13.1.1 Request 45 <#_Toc490851760>`__ - -`13.1.2 Response 45 <#_Toc490851761>`__ - -`13.2 Unregistry VIM 45 <#_Toc490851762>`__ - -`13.2.1 Request 45 <#_Toc490851763>`__ - -`13.2.2 Response 46 <#_Toc490851764>`__ - -* -* - -1. \ **Scope** +1. **Scope** +^^^^^^^^^^^^ The scope of the present document is to describe the VIM Driver API specification. -1. \ **Terms, Definitions and Abbreviations** +2. **Terms, Definitions and Abbreviations** +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For the purposes of the present document, the following abbreviations apply: @@ -261,16 +33,16 @@ apply: | MultiVIM | MultVIM driver services for OPEN-O to drive VIM instances | +--------------------+-------------------------------------------------------------+ -Table 2-1 abbreviations - -1. \ **Image Management** +3. **Image Management** +^^^^^^^^^^^^^^^^^^^^^^^ - 1. \ **Create Image** +3.1. **Create Image** +--------------------- +---------------------+-------------------------------------------------------------------------------+ | **IF Definition** | **Description** | +=====================+===============================================================================+ -| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images | +| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images | +---------------------+-------------------------------------------------------------------------------+ | Operation | POST | +---------------------+-------------------------------------------------------------------------------+ @@ -279,7 +51,8 @@ Table 2-1 abbreviations | Description | Create Image and Upload the image file to the VIM | +---------------------+-------------------------------------------------------------------------------+ -1. \ **Request** +3.1.1. **Request** +>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -298,22 +71,25 @@ Table 2-1 abbreviations | | | | | | | | | | | public, private, shared, or community | +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+ -| properties | O | 0..N | List of key-value pairs | Examples:--property vmware\_disktype=streamOptimized --property vmware\_adaptertype="lsiLogic" | +| properties | O | 0..N | List of key-value pairs | Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic" | +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+ -{ +:: + + { -"imageName": "cirros", + "imageName": "cirros", -"imagePath": "/home/cirros.qcow2", + "imagePath": "/home/cirros.qcow2", -"imageType": "qcow2" + "imageType": "qcow2" -“containerFormat”:”bare” + "containerFormat":"bare" -} + } -1. \ **Response** +3.1.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -347,22 +123,21 @@ Table 2-1 abbreviations 500: failed -{ - - “id”:” 3c9eebdbbfd345658269340b9ea6fb73”, - - "name": "cirros", - - "returnCode": 1 +:: -} + { + "id": "3c9eebdbbfd345658269340b9ea6fb73", + "name": "cirros", + "returnCode": 1 + } -1. \ **Delete Image** +3.2. **Delete Image** +--------------------- +---------------------+-----------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | +=====================+=========================================================================================+ -| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageId} | +| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images/{imageId} | +---------------------+-----------------------------------------------------------------------------------------+ | Operation | Delete | +---------------------+-----------------------------------------------------------------------------------------+ @@ -371,20 +146,23 @@ Table 2-1 abbreviations | Description | Delete Image | +---------------------+-----------------------------------------------------------------------------------------+ -1. \ **Request** +3.2.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +3.2.2. **Response** +>>>>>>>>>>>>>>>>>>> 204: no content -1. \ **List Images** +3.3. **List Images** +-------------------- +---------------------+-------------------------------------------------------------------------------+ | **IF Definition** | **Description** | +=====================+===============================================================================+ -| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images | +| URI | msb.onap.org:80/api/multicloud/v0/{cloud_owner}\_{region}/{tenantid}/images | +---------------------+-------------------------------------------------------------------------------+ | Operation | GET | +---------------------+-------------------------------------------------------------------------------+ @@ -393,9 +171,8 @@ N/A | Description | Query Image list | +---------------------+-------------------------------------------------------------------------------+ -1. \ **Request** - -msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……} +3.3.1. **Request** +>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -407,7 +184,8 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……} | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of an image | +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -1. \ **Response** +3.3.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ | \ **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -438,36 +216,27 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……} +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ | tenantId | M | 1 | String | Tenant UUID | +-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| 200: ok | | | | | -| | | | | | -| 500: failed | | | | | -| | | | | | -| { | | | | | -| | | | | | -| “vimid”:”” | | | | | -| | | | | | -| “vimname”:”” | | | | | -| | | | | | -| "imageList": [ | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| { | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "status": "active", | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "id": "5e2757c1-f846-4727-915c-9a872553ed75", | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "size": 862016, | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| "name": "vim-plus-cgsl40g-z.qcow2" | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| } | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -| ] | | | | | -| | | | | | -| } | | | | | -+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ -1. \ **Get Image** +200: ok + +500: failed + +:: + + { + "vimid": "", + "vimname": "", + "imageList": [{ + "status": "active", + "id": "5e2757c1-f846-4727-915c-9a872553ed75", + "size": 862016, + "name": "vim-plus-cgsl40g-z.qcow2" + }] + } + + +3.4. **Get Image** +------------------ +---------------------+-----------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -481,11 +250,13 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/images?{……} | Description | Query Image Information | +---------------------+-----------------------------------------------------------------------------------------+ -1. \ **Request** +3.4.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +3.4.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -519,25 +290,22 @@ N/A 500: failed -{ - -“vimid”:”” - -“vimname”:”” +:: -"status": "active", - -"id": "5e2757c1-f846-4727-915c-9a872553ed75", - -"size": 862016, - -"name": "vim-plus-cgsl40g-z.qcow2" - -a} + { + "vimid": "", + "vimname": "", + "status": "active", + "id": "5e2757c1-f846-4727-915c-9a872553ed75", + "size": 862016, + "name": "vim-plus-cgsl40g-z.qcow2" + } -1. \ **Network Management** +4. **Network Management** +^^^^^^^^^^^^^^^^^^^^^^^^^ - 1. \ **Create Network** +4.1. **Create Network** +----------------------- +---------------------+---------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -551,7 +319,8 @@ a} | Description | Create network and subnetwork on the VIM | +---------------------+---------------------------------------------------------------------------------+ -1. \ **Request** +4.1.1. **Request** +>>>>>>>>>>>>>>>>>> +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -572,30 +341,24 @@ a} +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| { | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “tenant”: “tenant1”, | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “networkName”: “ommnet”, | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “shared”: 1, | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “vlanTransparent”: 1, | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “networkType”:”vlan”, | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “segmentationId”:202, | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| “physicalNetwork”:”ctrl”, | | | | | -| | | | | | -| “routerExternal”:0 | | | | | -+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| } | | | | | +| routerExternal | O | 1 | boolean |Indicates whether this network can provide floating IPs via a router. | +-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -1. \ **Response** +:: + + { + "tenant": "tenant1", + "networkName": "ommnet", + "shared": 1, + "vlanTransparent": 1, + "networkType": "vlan", + "segmentationId": 202, + "physicalNetwork": "ctrl", + "routerExternal": 0 + } + +4.1.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -632,39 +395,27 @@ a} 500: failed -{ - -“returnCode”:0, - -“vimId”:”11111”, - -“vimName”:”11111”, - -“status”: “ACTIVE”, +:: -“id”: “3c9eebdbbfd345658269340b9ea6fb73”, - -“name”: “net1”, - -“tenant”: “tenant1”, - -“networkName”: “ommnet”, - -“shared”: 1, - -“vlanTransparent”: 1, - -“networkType”:”vlan”, - -“segmentationId”:202, - -“physicalNetwork ”:”ctrl”, - -“routerExternal ”:0 - -} + { + "returnCode": 0, + "vimId": "11111", + "vimName": "11111", + "status": "ACTIVE", + "id": "3c9eebdbbfd345658269340b9ea6fb73", + "name": "net1", + "tenant": "tenant1", + "networkName": "ommnet", + "shared": 1, + "vlanTransparent": 1, + "networkType": "vlan", + "segmentationId": 202, + "physicalNetwork": "ctrl", + "routerExternal": 0 + } -1. \ **Delete Network** +4.2. **Delete Network** +----------------------- +---------------------+---------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -676,15 +427,18 @@ a} | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+---------------------------------------------------------------------------------------------+ -1. \ **Request** +4.2.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +4.2.2. **Response** +>>>>>>>>>>>>>>>>>>> 204: no content -1. \ **List Network** +4.3. **List Network** +--------------------- +---------------------+---------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -696,7 +450,8 @@ N/A | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+---------------------------------------------------------------------------------+ -1. \ **Query** +4.3.1. **Query** +>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -704,7 +459,8 @@ N/A | name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of a network | +-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+ -1. \ **Response** +4.3.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -740,45 +496,46 @@ N/A 500: failed -{ +:: -“vimId”:”11111”, + { -“vimName”:”111”, + "vimId": "11111", -“networks”: + "vimName": "111", -[{ + "networks": -“status”: “ACTIVE”, + [{ -“id”: “3c9eebdbbfd345658269340b9ea6fb73”, + "status": "ACTIVE", -“name”: “net1”, + "id": "3c9eebdbbfd345658269340b9ea6fb73", -“tenant”: “tenant1”, + "name": "net1", -“networkName”: “ommnet”, + "tenant": "tenant1", -“shared”: 1, + "networkName": "ommnet", -“vlanTransparent”: 1, + "shared": 1, -“networkType”:”vlan”, + "vlanTransparent": 1, -“segmentationId”:202, + "networkType": "vlan", -“physicalNetwork ”:”ctrl”, + "segmentationId": 202, -“routerExternal ”:0 + "physicalNetwork ": "ctrl", -}] + "routerExternal ": 0 -} + }] -PHYSICALNETWORK  + } -1. \ **Get Network** +4.4. **Get Network** +-------------------- +---------------------+---------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -790,11 +547,13 @@ PHYSICALNETWORK  | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+---------------------------------------------------------------------------------------------+ -1. \ **Request** +4.4.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +4.4.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -830,39 +589,43 @@ N/A 500: failed -{ +:: + + { - “vimId”:”11111”, + "vimId":"11111", - “vimName”:”11111”, + "vimName":"11111", - “status”: “ACTIVE”, + "status": "ACTIVE", - “id”: “3c9eebdbbfd345658269340b9ea6fb73”, + "id": "3c9eebdbbfd345658269340b9ea6fb73", - “name”: “net1”, + "name": "net1", - “tenant”: “tenant1”, + "tenant": "tenant1", - “networkName”: “ommnet”, + "networkName": "ommnet", - “shared”: 1, + "shared": 1, - “vlanTransparent”: 1, + "vlanTransparent": 1, - “networkType”:”vlan”, + "networkType":"vlan", - “segmentationId”:202, + "segmentationId":202, - “physicalNetwork ”:”ctrl”, + "physicalNetwork ":"ctrl", - “routerExternal ”:0 + "routerExternal ":0 -} + } -1. \ **Subnetwork Management** +5. **Subnetwork Management** +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - 1. \ **Create Subnets** +5.1. **Create Subnets** +----------------------- +---------------------+--------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -876,7 +639,8 @@ N/A | Description | Create network and subnetwork on the VIM | +---------------------+--------------------------------------------------------------------------------+ -1. \ **Request** +5.1.1. **Request** +>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+------------------------+----------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -901,7 +665,7 @@ N/A +-------------------+-----------------+-------------------+------------------------+----------------------+ | hostRoutes | O | 1..n | List of routes | List of routes | +-------------------+-----------------+-------------------+------------------------+----------------------+ -| allocationPools | O | 1..n | list of “allocation” | list of allocation | +| allocationPools | O | 1..n | list of "allocation" | list of allocation | +-------------------+-----------------+-------------------+------------------------+----------------------+ | -->allocation | | | | | +-------------------+-----------------+-------------------+------------------------+----------------------+ @@ -910,37 +674,40 @@ N/A | -->end | O | 1 | String | End ip | +-------------------+-----------------+-------------------+------------------------+----------------------+ -{ +:: + + { -“tenant”: “tenant1”, + "tenant": "tenant1", -“network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”, + "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22", -“subnetName”: “subnet1”, + "subnetName": "subnet1", -“cidr”: “10.43.35.0/24”, + "cidr": "10.43.35.0/24", -“ipVersion”: 4, + "ipVersion": 4, -“enableDhcp”: 1, + "enableDhcp": 1, -“gatewayIp”: “10.43.35.1”, + "gatewayIp": "10.43.35.1", -“dnsNameservers”: [], + "dnsNameservers": [], -“allocationPools”:[{ + "allocationPools": [{ -“start”: “192.168.199.2”, + "start": "192.168.199.2", -“end”: “192.168.199.254” + "end": "192.168.199.254" -}], + }], -“hostRoutes”: [] + "hostRoutes": [] -} + } -1. \ **Response** +5.1.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+------------------------+-------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -979,7 +746,7 @@ N/A +-------------------+-----------------+-------------------+------------------------+-------------------------------------+ | hostRoutes | O | 1..n | List of routes | List of routes | +-------------------+-----------------+-------------------+------------------------+-------------------------------------+ -| allocationPools | O | 1..n | list of “allocation” | list of allocation | +| allocationPools | O | 1..n | list of "allocation" | list of allocation | +-------------------+-----------------+-------------------+------------------------+-------------------------------------+ | -->allocation | | | | | +-------------------+-----------------+-------------------+------------------------+-------------------------------------+ @@ -992,47 +759,50 @@ N/A 500: failed -{ +:: - “returnCode”:0, + { + + "returnCode": 0, - “vimId”:”11111”, + "vimId": "11111", - “vimName”:”11111”, + "vimName": "11111", -“status”:” ACTIVE” + "status": " ACTIVE", -“id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23” + "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23", -“tenant”: “tenant1”, + "tenant": "tenant1", -“network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”, + "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22", -“name”: “subnet1”, + "name": "subnet1", -“cidr”: “10.43.35.0/24”, + "cidr": "10.43.35.0/24", -“ipVersion”: 4, + "ipVersion": 4, -“enableDhcp”: 1, + "enableDhcp": 1, -“gatewayIp”: “10.43.35.1”, + "gatewayIp": "10.43.35.1", -“dnsNameservers”: [], + "dnsNameservers": [], -“allocationPools”:[{ + "allocationPools": [{ -“start”: “192.168.199.2”, + "start": "192.168.199.2", -“end”: “192.168.199.254” + "end": "192.168.199.254" -}], + }], -“hostRoutes”: [] + "hostRoutes": [] -} + } -1. \ **Delete Subnets** +5.2. **Delete Subnets** +----------------------- +---------------------+-------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1044,15 +814,18 @@ N/A | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+-------------------------------------------------------------------------------------------+ -1. \ **Request** +5.2.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +5.2.2. **Response** +>>>>>>>>>>>>>>>>>>> 204: no content -1. \ **List Subnets** +5.3. **List Subnets** +--------------------- +---------------------+--------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1064,7 +837,8 @@ N/A | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+--------------------------------------------------------------------------------+ -1. \ **Query** +5.3.1. **Query** +>>>>>>>>>>>>>>>> msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……} @@ -1074,7 +848,8 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……} | name | O | 1 | String | Filters fields of the response by a name, as a string. A valid value is the name of a subnet | +-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+ -1. \ **Response** +5.3.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+------------------------+----------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1113,7 +888,7 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……} +-------------------+-----------------+-------------------+------------------------+----------------------+ | hostRoutes | O | 1..n | List of routes | List of routes | +-------------------+-----------------+-------------------+------------------------+----------------------+ -| allocationPools | O | 1..n | list of “allocation” | list of allocation | +| allocationPools | O | 1..n | list of "allocation" | list of allocation | +-------------------+-----------------+-------------------+------------------------+----------------------+ | -->allocation | | | | | +-------------------+-----------------+-------------------+------------------------+----------------------+ @@ -1126,53 +901,56 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……} **500: failed** -{ +:: + + { -“vimId”:”11111”, + "vimId": "11111", -“vimName”:”11111”, + "vimName": "11111", -"subnets":[ + "subnets": [ - { + { -“status”:” ACTIVE” + "status": " ACTIVE", -“id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23” + "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23", -“tenant”: “tenant1”, + "tenant": "tenant1", -“network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”, + "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22", -“name”: “subnet1”, + "name": "subnet1", -“cidr”: “10.43.35.0/24”, + "cidr": "10.43.35.0/24", -“ipVersion”: 4, + "ipVersion": 4, -“enableDhcp”: 1, + "enableDhcp": 1, -“gatewayIp”: “10.43.35.1”, + "gatewayIp": "10.43.35.1", -“dnsNameservers”: [], + "dnsNameservers": [], -“allocationPools”:[{ + "allocationPools": [{ -“start”: “192.168.199.2”, + "start": "192.168.199.2", -“end”: “192.168.199.254” + "end": "192.168.199.254" -}], + }], -“hostRoutes”: [] + "hostRoutes": [] - } + } -] + ] -} + } -1. \ **Get Subnets** +5.4. **Get Subnets** +-------------------- +---------------------+-------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1184,11 +962,13 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……} | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+-------------------------------------------------------------------------------------------+ -1. \ **Request** +5.4.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +5.4.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+------------------------+----------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1225,7 +1005,7 @@ N/A +-------------------+-----------------+-------------------+------------------------+----------------------+ | hostRoutes | O | 1..n | List of routes | List of routes | +-------------------+-----------------+-------------------+------------------------+----------------------+ -| allocationPools | O | 1..n | list of “allocation” | list of allocation | +| allocationPools | O | 1..n | list of "allocation" | list of allocation | +-------------------+-----------------+-------------------+------------------------+----------------------+ | -->allocation | | | | | +-------------------+-----------------+-------------------+------------------------+----------------------+ @@ -1238,43 +1018,47 @@ N/A 500: failed -{ +:: -“status”:” ACTIVE” + { + + "status": " ACTIVE", -“id”:” d62019d3-bc6e-4319-9c1d-6722fc136a23” + "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23", -“tenant”: “tenant1”, + "tenant": "tenant1", -“network\_id”:“d32019d3-bc6e-4319-9c1d-6722fc136a22”, + "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22", -“name”: “subnet1”, + "name": "subnet1", -“cidr”: “10.43.35.0/24”, + "cidr": "10.43.35.0/24", -“ipVersion”: 4, + "ipVersion": 4, -“enableDhcp”: 1, + "enableDhcp": 1, -“gatewayIp”: “10.43.35.1”, + "gatewayIp": "10.43.35.1", -“dnsNameservers”: [], + "dnsNameservers": [], -“allocationPools”:[{ + "allocationPools": [{ -“start”: “192.168.199.2”, + "start": "192.168.199.2", -“end”: “192.168.199.254” + "end": "192.168.199.254" -}], + }], -“hostRoutes”: [] + "hostRoutes": [] -} + } -1. \ **Virtual Port** +6. **Virtual Port** +^^^^^^^^^^^^^^^^^^^ - 1. \ **Create Virtual Port** +6.1. **Create Virtual Port** +---------------------------- +---------------------+------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1286,7 +1070,8 @@ N/A | Direction | VNFLCM->MULTIVIM | +---------------------+------------------------------------------------------------------------------+ -1. \ **Request** +6.1.1. **Request** +>>>>>>>>>>>>>>>>>> +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1308,7 +1093,8 @@ N/A | \ **securityGroups** | **O** | **1** | **string** | **The IDs of security groups applied to the port.** | +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+ -1. \ **Response** +6.1.2. **Response** +>>>>>>>>>>>>>>>>>>> +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1346,7 +1132,8 @@ N/A | **securityGroups** | **O** | **1** | **string** | **List of security group names.** | +----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+ -1. \ **Delete Virtual Port** +6.2. **Delete Virtual Port** +---------------------------- +---------------------+---------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1358,15 +1145,18 @@ N/A | Direction | VNFLCM->MULTIVIM | +---------------------+---------------------------------------------------------------------------------------+ -1. \ **Request** +6.2.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +6.2.2. **Response** +>>>>>>>>>>>>>>>>>>> 204: no content -1. \ **List Virtual Port** +6.3. **List Virtual Port** +-------------------------- +---------------------+-----------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1378,7 +1168,8 @@ N/A | Direction | VNFLCM->MULTIVIM | +---------------------+-----------------------------------------------------------------------------+ -1. \ **Query** +6.3.1. **Query** +>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1386,7 +1177,8 @@ N/A | name | M | 1 | string | Port name to filter out list of virtual ports | +-----------------+-----------------+-------------------+---------------+-------------------------------------------------+ -1. \ **Response** +6.3.2. **Response** +>>>>>>>>>>>>>>>>>>> +-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1428,11 +1220,9 @@ N/A **500: failed** -{ - -} -1. \ **Get Virtual Port** +6.4. **Get Virtual Port** +------------------------- +---------------------+---------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1444,11 +1234,13 @@ N/A | Direction | VNFLCM->MULTIVIM | +---------------------+---------------------------------------------------------------------------------------+ -1. \ **Request** +6.4.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +6.4.2. **Response** +>>>>>>>>>>>>>>>>>>> +------------------+-----------------+-------------------+---------------+-----------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1488,13 +1280,12 @@ N/A **500: failed** -{ -} +7. **Server Management** +^^^^^^^^^^^^^^^^^^^^^^^^ -1. \ **Server Management** - - 1. \ **Create Server** +7.1. **Create Server** +---------------------- +---------------------+--------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1506,7 +1297,8 @@ N/A | Direction | VNFLCM->MULTIVIM | +---------------------+--------------------------------------------------------------------------------+ -1. \ **Request** +7.1.1. **Request** +>>>>>>>>>>>>>>>>>> +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1531,9 +1323,9 @@ N/A | | | | | | | | | | | 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. | +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **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.** | +| 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. | +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity | +| serverGroup | O | 1 | string | the ServerGroup for anti-affinity and affinity | +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **boot** @@ -1562,7 +1354,7 @@ N/A | fileData | M | 1 | string | Injection file content (injection file content inside the $MAC\_1 $MAC\_1 need to be replaced by the MAC address, of which 1 is NIC index. ) | +-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -volumeArray +**volumeArray** +-----------------+-----------------+-------------------+---------------+-------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1570,7 +1362,7 @@ volumeArray | volumeId | M | 1 | String | Volume Id | +-----------------+-----------------+-------------------+---------------+-------------------+ -nicArray +**nicArray** +-----------------+-----------------+-------------------+---------------+-------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1588,59 +1380,62 @@ nicArray | value | M | 1 | string | value | +-----------------+-----------------+-------------------+---------------+-------------------+ -{ +:: + + { -"tenant": "tenant1", + "tenant": "tenant1", -"name": "vm1", + "name": "vm1", -“availabilityZone”:”az1”, + "availabilityZone": "az1", -“flavorName”:”vm\_large”, + "flavorName": "vm_large", -"boot": { + "boot": { -"type": 1, + "type": 1, -" volumeName": "volume1" + " volumeName": "volume1" -}, + }, -“flavorId”:”vm\_large\_134213” + "flavorId": "vm_large_134213", -"contextArray": [{ + "contextArray": [{ -"fileName": "test.yaml", + "fileName": "test.yaml", -"fileData": "….” + "fileData": "…." -}], + }], -"volumeArray": [{ + "volumeArray": [{ -"volumeName": "vol1", + "volumeName": "vol1", -}], + }], -“nicArray”:[{ + "nicArray": [{ - “portId”:”port\_a” + "portId": "port_a" -}] + }], -“metada”: [{ + "metada": [{ -"keyName": "foo", + "keyName": "foo", -"value": "foo value” + "value": "foo value" -}], + }], -“userdata”:”abcdedf” + "userdata": "abcdedf" -} + } -1. \ **Response** +7.1.2. **Response** +>>>>>>>>>>>>>>>>>>> +----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1684,17 +1479,20 @@ nicArray 500: failed -{ +:: + + { -"id": "3c9eebdbbfd345658269340b9ea6fb73", + "id": "3c9eebdbbfd345658269340b9ea6fb73", -"name": "vm1", + "name": "vm1", -"returnCode": 1, + "returnCode": 1, -} + } -1. \ **Delete Server** +7.2. **Delete Server** +---------------------- +---------------------+-------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1706,15 +1504,18 @@ nicArray | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+-------------------------------------------------------------------------------------------+ -1. \ **Request** +7.2.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +7.2.2. **Response** +>>>>>>>>>>>>>>>>>>> 204: no content -1. \ **List Server** +7.3. **List Server** +-------------------- +---------------------+--------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1726,7 +1527,8 @@ N/A | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+--------------------------------------------------------------------------------+ -1. \ **Request** +7.3.1. **Request** +>>>>>>>>>>>>>>>>>> msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……} @@ -1736,7 +1538,8 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……} | name | M | 1 | string | server name | +-----------------+-----------------+-------------------+---------------+-------------------+ -1. \ **Response** +7.3.2. **Response** +>>>>>>>>>>>>>>>>>>> +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1778,11 +1581,8 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……} 500: failed -{ - -} - -1. \ **Get Server** +7.4. **Get Server** +------------------- +---------------------+-------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1794,11 +1594,13 @@ msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……} | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+-------------------------------------------------------------------------------------------+ -1. \ **Request** +7.4.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +7.4.2. **Response** +>>>>>>>>>>>>>>>>>>> +----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1838,13 +1640,11 @@ N/A 500: failed -{ +8. **Flavor Management** +^^^^^^^^^^^^^^^^^^^^^^^^ -} - -1. \ **Flavor Management** - - 1. \ **Create Flavor** +8.1. **Create Flavor** +---------------------- +---------------------+--------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1856,7 +1656,8 @@ N/A | Direction | VNFLCM->MULTIVIM | +---------------------+--------------------------------------------------------------------------------+ -1. \ **Request** +8.1.1. **Request** +>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1878,7 +1679,8 @@ N/A | extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter | +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -1. \ **Response** +8.1.2. **Response** +>>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1910,7 +1712,8 @@ N/A | vimName | O | 1 | string | vim name | +-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+ -1. \ **Delete Flavor** +8.2. **Delete Flavor** +---------------------- +---------------------+--------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1922,15 +1725,18 @@ N/A | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+--------------------------------------------------------------------------------------------+ -1. \ **Request** +8.2.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +8.2.2. **Response** +>>>>>>>>>>>>>>>>>>> 204: no content -1. \ **List Flavor** +8.3. **List Flavor** +-------------------- +---------------------+---------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1942,7 +1748,8 @@ N/A | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+---------------------------------------------------------------------------------+ -1. \ **Query** +8.3.1. **Query** +>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------+----------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1950,7 +1757,8 @@ N/A | name | M | 1 | string | Flavor name to filter out list | +-----------------+-----------------+-------------------+---------------+----------------------------------+ -1. \ **Response** +8.3.2. **Response** +>>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -1986,7 +1794,8 @@ N/A 500: failed -1. \ **Get Flavor** +8.4. **Get Flavor** +------------------- +---------------------+----------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -1998,11 +1807,13 @@ N/A | Direction | NFLCM,NSLCM->MULTIVIM | +---------------------+----------------------------------------------------------------------------------------------+ -1. \ **Request** +8.4.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +8.4.2. **Response** +>>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2036,9 +1847,11 @@ N/A 500: failed -1. \ **Volume Management** +9. **Volume Management** +^^^^^^^^^^^^^^^^^^^^^^^^ - 1. \ **Create Volume** +9.1. **Create Volume** +---------------------- +---------------------+--------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -2050,7 +1863,8 @@ N/A | Direction | NSLCM->MULTIVIM | +---------------------+--------------------------------------------------------------------------------+ -1. \ **Request** +9.1.1. **Request** +>>>>>>>>>>>>>>>>>> +--------------------+-----------------+-------------------+---------------+-------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2066,6 +1880,8 @@ N/A | availabilityZone | O | 1 | string | Usable field | +--------------------+-----------------+-------------------+---------------+-------------------+ +:: + { "tenant": "tenant1", @@ -2082,7 +1898,8 @@ N/A } -1. \ **Response** +9.1.2. **Response** +>>>>>>>>>>>>>>>>>>> +--------------------+-----------------+-------------------+---------------+-------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2110,6 +1927,8 @@ N/A 500: failed +:: + { "id": "bc9eebdbbfd356458269340b9ea6fb73", @@ -2120,7 +1939,8 @@ N/A } -1. \ **Delete Volume** +9.2. **Delete Volume** +---------------------- +---------------------+-------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -2132,15 +1952,18 @@ N/A | Direction | NSLCM->MULTIVIM | +---------------------+-------------------------------------------------------------------------------------------+ -1. \ **Request** +9.2.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +9.2.2. **Response** +>>>>>>>>>>>>>>>>>>> 204: no content -1. \ **List Volumes** +9.3. **List Volumes** +--------------------- +---------------------+--------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -2152,7 +1975,8 @@ N/A | Direction | NSLCM-> MULTIVIM | +---------------------+--------------------------------------------------------------------------------+ -1. \ **Request** +9.3.1. **Request** +>>>>>>>>>>>>>>>>>> msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/volumes?{……} @@ -2163,7 +1987,8 @@ N/A | name | M | 1 | string | Volume name | +-----------------+-----------------+-------------------+---------------+-------------------+ -1. \ **Response** +9.3.2. **Response** +>>>>>>>>>>>>>>>>>>> +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2197,67 +2022,70 @@ N/A 500: failed +:: + { - "volumes": [ + "volumes": [ - { + { - "status": "available", + "status": "available", - "name": "test", + "name": "test", - "attachments": [], + "attachments": [], - "createTime": "2015-12-02T07:57:23.000000", + "createTime": "2015-12-02T07:57:23.000000", - " volumeType ": "ws", + " volumeType ": "ws", - "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55", + "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55", - "size": 20 + "size": 20 - }, + }, - { + { - "status": "in-use", + "status": "in-use", - "name": "wangsong", + "name": "wangsong", - "attachments": [ + "attachments": [ - { + { - "device": "/dev/vdc", + "device": "/dev/vdc", - "serverId": "3030e666-528e-4954-88f5-cc21dab1262b", + "serverId": "3030e666-528e-4954-88f5-cc21dab1262b", - "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", + "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", - "hostName": null, + "hostName": null, - "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31" + "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31" - } + } - ], + ], - "createTime": "2015-12-02T06:39:40.000000", + "createTime": "2015-12-02T06:39:40.000000", - " volumeType ": null, + " volumeType ": null, - "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", + "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", - "size": 40 + "size": 40 - } + } - ] + ] } -1. \ **Get Volumes** +9.4. **Get Volumes** +-------------------- +---------------------+-------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -2269,11 +2097,13 @@ N/A | Direction | NSLCM-> MULTIVIM | +---------------------+-------------------------------------------------------------------------------------------+ -1. \ **Request** +9.4.1. **Request** +>>>>>>>>>>>>>>>>>> N/A -1. \ **Response** +9.4.2. **Response** +>>>>>>>>>>>>>>>>>>> +--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2321,43 +2151,47 @@ N/A 500: failed +:: + { - "status": "in-use", + "status": "in-use", - "name": "wangsong", + "name": "wangsong", - "attachments": [ + "attachments": [ - { + { - "device": "/dev/vdc", + "device": "/dev/vdc", - "serverId": "3030e666-528e-4954-88f5-cc21dab1262b", + "serverId": "3030e666-528e-4954-88f5-cc21dab1262b", - "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", + "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", - "hostName": null, + "hostName": null, - "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31" + "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31" - } + } - ], + ], - "createTime": "2015-12-02T06:39:40.000000", + "createTime": "2015-12-02T06:39:40.000000", - "volumeType ": null, + "volumeType ": null, - "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", + "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31", - "volumeSize ": 40 + "volumeSize ": 40 } -1. \ **Tenant Management** +10. **Tenant Management** +^^^^^^^^^^^^^^^^^^^^^^^^^ - 1. \ **List tenants** +10.1. **List tenants** +---------------------- +---------------------+---------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -2369,7 +2203,8 @@ N/A | Direction | NSLCM-> MULTIVIM | +---------------------+---------------------------------------------------------------------+ -1. \ **Query** +10.1.1. **Query** +>>>>>>>>>>>>>>>>> +---------------------+-----------------+-------------------+---------------+-------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2377,7 +2212,8 @@ N/A | name={tenantname} | O | 1 | string | Tenant name to filter output list | +---------------------+-----------------+-------------------+---------------+-------------------------------------+ -1. \ **Response** +10.1.2. **Response** +>>>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------+-------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2397,25 +2233,29 @@ N/A 500: failed +:: + { - " tenants ": [ + " tenants ": [ - { + { - "id": "1", + "id": "1", - "name": "test\_a" + "name": "test\_a" - } + } - ] + ] } -1. \ **Limits** +11. **Limits** +^^^^^^^^^^^^^^ - 1. \ **List Limits of resouces: CPU&Memory, volume,network,etc** +11.1. **List Limits of resouces** +--------------------------------- +---------------------+-------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -2427,9 +2267,13 @@ N/A | Direction | NSLCM-> MULTIVIM | +---------------------+-------------------------------------------------------------------------------+ -1. \ **Request** +11.1.1. **Request** +>>>>>>>>>>>>>>>>>>> -2. \ **Response** +N/A + +11.1.2. **Response** +>>>>>>>>>>>>>>>>>>>> +---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2485,6 +2329,8 @@ N/A 500: failed +:: + { "maxPersonality": 5, @@ -2507,9 +2353,11 @@ N/A } -1. \ **Host Management** +12. **Host Management** +^^^^^^^^^^^^^^^^^^^^^^^ - 1. \ **List hosts** +12.1. **List hosts** +-------------------- +---------------------+------------------------------------------------------------------------------+ | **IF Definition** | **Description** | @@ -2521,9 +2369,13 @@ N/A | Direction | NSLCM-> MULTIVIM | +---------------------+------------------------------------------------------------------------------+ -1. \ **Request** +12.1.1. **Request** +>>>>>>>>>>>>>>>>>>> + +N/A -2. \ **Response** +12.1.2. **Response** +>>>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+-----------------+-----------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2547,115 +2399,120 @@ N/A 500: failed +:: + { - "vimId": "123", + "vimId": "123", - "vimName": "vimName", + "vimName": "vimName", - "tenantId": "tenantId1" + "tenantId": "tenantId1" - "hosts": [ + "hosts": [ - { + { - "name": "b6e4adbc193d428ea923899d07fb001e", + "name": "b6e4adbc193d428ea923899d07fb001e", - "service": "conductor", + "service": "conductor", - "zone": "internal", + "zone": "internal", - "vimId": "123", + "vimId": "123", - "vimName": "vimName", + "vimName": "vimName", - "tenantId": "tenantId1" + "tenantId": "tenantId1" - }, + }, - { + { - "name": "09c025b0efc64211bd23fc50fa974cdf", + "name": "09c025b0efc64211bd23fc50fa974cdf", - "service": "compute", + "service": "compute", - "zone": "nova" + "zone": "nova" - "vimId": "123", + "vimId": "123", - "vimName": "vimName", + "vimName": "vimName", - "tenantId": "tenantId1" + "tenantId": "tenantId1" - }, + }, - { + { - "name": "e73ec0bd35c64de4a1adfa8b8969a1f6", + "name": "e73ec0bd35c64de4a1adfa8b8969a1f6", - "service": "consoleauth", + "service": "consoleauth", - "zone": "internal" + "zone": "internal" - "vimId": "123", + "vimId": "123", - "vimName": "vimName", + "vimName": "vimName", - "tenantId": "tenantId1" + "tenantId": "tenantId1" - }, + }, - { + { - "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7", + "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7", - "service": "network", + "service": "network", - "zone": "internal" + "zone": "internal" - "vimId": "123", + "vimId": "123", - "vimName": "vimName", + "vimName": "vimName", - "tenantId": "tenantId1" + "tenantId": "tenantId1" - }, + }, - { + { - "name": "abffda96592c4eacaf4111c28fddee17", + "name": "abffda96592c4eacaf4111c28fddee17", - "service": "scheduler", + "service": "scheduler", - "zone": "internal" + "zone": "internal" - "vimId": "123", + "vimId": "123", - "vimName": "vimName", + "vimName": "vimName", - "tenantId": "tenantId1" + "tenantId": "tenantId1" - } + } - ] + ] } -1. \ **Get host** +12.2. **Get host** +------------------ +---------------------+-----------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | +=====================+=========================================================================================+ -| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts/{hostname} | +| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/hosts/{hostname} | +---------------------+-----------------------------------------------------------------------------------------+ | Operation | GET | +---------------------+-----------------------------------------------------------------------------------------+ | Direction | NSLCM-> MULTIVIM | +---------------------+-----------------------------------------------------------------------------------------+ -1. \ **Request** +12.2.1. **Request** +>>>>>>>>>>>>>>>>>>> -2. \ **Response** +12.2.2. **Response** +>>>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2672,122 +2529,123 @@ N/A +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+ | cpu | M | 1 | Int | The cpu info on the host. | +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+ -| memory\_mb | M | 1 | int | The memory info on the host (in MB). | +| memory_mb | M | 1 | int | The memory info on the host (in MB). | +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+ | name | M | 1 | string | host name | +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+ -| project | M | 1 | string | Value: total, used\_now, used\_max or specific project\_id | +| project | M | 1 | string | Value: total, used_now, used_max or specific project_id | +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+ -| disk\_gb | M | 1 | int | The disk info on the host (in GB). | +| disk_gb | M | 1 | int | The disk info on the host (in GB). | +-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+ 200: ok 500: failed -{ +:: -"cpu": 1, - -"disk\_gb": 1028, + { -"name": "c1a7de0ac9d94e4baceae031d05caae3", + "cpu": 1, -"memory\_mb": 8192, + "disk\_gb": 1028, -"vimId": "123", + "name": "c1a7de0ac9d94e4baceae031d05caae3", -"vimName": "vimName", + "memory\_mb": 8192, -"tenantId": "tenantId1" + "vimId": "123", -} + "vimName": "vimName", - { + "tenantId": "tenantId1", - "host": [ + "host": [ - { + { - "memory\_mb": 4960, + "memory\_mb": 4960, - "name": " c1a7de0ac9d94e4baceae031d05caae3", + "name": " c1a7de0ac9d94e4baceae031d05caae3", - "disk\_gb": 92, + "disk\_gb": 92, - "project": "(total)", + "project": "(total)", - "cpu": 4 + "cpu": 4 - }, + }, - { + { - "memory\_mb": 1536, + "memory\_mb": 1536, - "name": " c1a7de0ac9d94e4baceae031d05caae3", + "name": " c1a7de0ac9d94e4baceae031d05caae3", - "disk\_gb": 2, + "disk\_gb": 2, - "project": "(used\_now)", + "project": "(used\_now)", - "cpu": 2 + "cpu": 2 - }, + }, - { + { - "memory\_mb": 1024, + "memory\_mb": 1024, - "name": " c1a7de0ac9d94e4baceae031d05caae3", + "name": " c1a7de0ac9d94e4baceae031d05caae3", - "disk\_gb": 2, + "disk\_gb": 2, - "project": "(used\_max)", + "project": "(used\_max)", - "cpu": 2 + "cpu": 2 - }, + }, - { + { - "memory\_mb": 1024, + "memory\_mb": 1024, - "name": " c1a7de0ac9d94e4baceae031d05caae3", + "name": " c1a7de0ac9d94e4baceae031d05caae3", - "disk\_gb": 2, + "disk\_gb": 2, - "project": "568f7ec425db472ba348251bf1e7eebd", + "project": "568f7ec425db472ba348251bf1e7eebd", - "cpu": 2 + "cpu": 2 - } + } - ], + ], - "vimName": "openstack\_newton", + "vimName": "openstack\_newton", - "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73", + "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73", - "tenantId": "568f7ec425db472ba348251bf1e7eebd" + "tenantId": "568f7ec425db472ba348251bf1e7eebd" } -1. \ **VIM Management** +13. **VIM Management** +^^^^^^^^^^^^^^^^^^^^^^ - 1. \ **Update VIM Info** +13.1. **Update VIM Info** +------------------------- +---------------------+----------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | +=====================+==============================================================================================+ -| URI | http(s)://[hostname][:port]/onapapi/ multicloud /v1/{cloud-owner}\_{cloud-region}/registry | +| URI | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region}/registry | +---------------------+----------------------------------------------------------------------------------------------+ | Operation | POST | +---------------------+----------------------------------------------------------------------------------------------+ | Direction | ESR-> MULTICLOUD | +---------------------+----------------------------------------------------------------------------------------------+ -1. \ **Request** +13.1.1. **Request** +>>>>>>>>>>>>>>>>>>> +-----------------+-----------------+-------------------+---------------+-----------------------+ | **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** | @@ -2795,7 +2653,8 @@ N/A | defaultTenant | M | 1 | string | default tenant name | +-----------------+-----------------+-------------------+---------------+-----------------------+ -1. \ **Response** +13.1.2. **Response** +>>>>>>>>>>>>>>>>>>>> NA @@ -2803,23 +2662,26 @@ NA 400: failed -1. \ **Unregistry VIM** +13.2. **Unregistry VIM** +------------------------ +---------------------+-----------------------------------------------------------------------------------------------+ | **IF Definition** | **Description** | +=====================+===============================================================================================+ -| URI | http(s)://[hostname][:port]/onapapi/multicloud/v1 /{cloud-owner}\_{cloud-region}/unregistry | +| URI | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region} | +---------------------+-----------------------------------------------------------------------------------------------+ | Operation | DELETE | +---------------------+-----------------------------------------------------------------------------------------------+ | Direction | ESR-> MULTICLOUD | +---------------------+-----------------------------------------------------------------------------------------------+ -1. \ **Request** +13.2.1. **Request** +>>>>>>>>>>>>>>>>>>> NA -1. \ **Response** +13.2.2. **Response** +>>>>>>>>>>>>>>>>>>>> NA