Gitiles
Code Review Sign In
gerrit.nordix.org / onap / multicloud / framework / ee0e1b8884f945cd366f58753fa0ca3379002ff7 / . / docs / MultiCloud-APIv0-Specification.rst
blob: 57fa3b792cd395319797cdbd107cca5982bcd7f5 [file] [log] [blame]
Li Xinhui7469f512018-04-11 13:00:54 +0800[diff] [blame]1..
2 This work is licensed under a Creative Commons Attribution 4.0
3 International License.
Ethan Lynn2906f882018-01-15 10:32:43 +0800[diff] [blame]4
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]5================================
Bin Yangc8d753e2018-11-01 12:38:54 +0000[diff] [blame]6MultiCloud API v0 Specification
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]7================================
8
Bin Yang6eefba52019-05-15 07:20:00 +0000[diff] [blame]9API in json swagger
10===================
11
Bin Yang94e5ced2020-05-06 23:30:35 +0800[diff] [blame]12`MultiCloud Broker API v0 <https://wiki.onap.org/download/attachments/25435675/multicloud.broker.v0.swagger.json?version=1&modificationDate=1557892177024&api=v2>`__
Bin Yang6eefba52019-05-15 07:20:00 +0000[diff] [blame]13
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]14API Catalog
15===========
16
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]171. **Scope**
18^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]19
20The scope of the present document is to describe the VIM Driver API
21specification.
22
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]232. **Terms, Definitions and Abbreviations**
24^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]25
26For the purposes of the present document, the following abbreviations
27apply:
28
29+--------------------+-------------------------------------------------------------+
30| **Abbreviation** | |
31+====================+=============================================================+
32| NFVO | Network Functions Virtualization Orchestrator |
33+--------------------+-------------------------------------------------------------+
34| VNFM | Virtual Network Function Management |
35+--------------------+-------------------------------------------------------------+
36| VIM | Virtualized Infrastructure Manager |
37+--------------------+-------------------------------------------------------------+
38| MultiVIM | MultVIM driver services for OPEN-O to drive VIM instances |
39+--------------------+-------------------------------------------------------------+
40
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]413. **Image Management**
42^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]43
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]443.1. **Create Image**
45---------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]46
47+---------------------+-------------------------------------------------------------------------------+
48| **IF Definition** | **Description** |
49+=====================+===============================================================================+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]50| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]51+---------------------+-------------------------------------------------------------------------------+
52| Operation | POST |
53+---------------------+-------------------------------------------------------------------------------+
54| Direction | NSLCM->MULTIVIM |
55+---------------------+-------------------------------------------------------------------------------+
56| Description | Create Image and Upload the image file to the VIM |
57+---------------------+-------------------------------------------------------------------------------+
58
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]593.1.1. **Request**
60>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]61
62+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
63| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
64+===================+=================+===================+===========================+==================================================================================================+
65| name | M | 1 | String | Image Name |
66+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
67| imagePath | M | 1 | String | Image Local Path from catalog |
68+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
69| imageType | M | 1 | String | Image Type |
70| | | | | |
71| | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
72+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
73| containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova,  docker |
74+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
75| visibility | O | 1 | string | Visibility for this image. |
76| | | | | |
77| | | | | public, private, shared, or community |
78+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]79| properties | O | 0..N | List of key-value pairs | Examples:--property vmware_disktype=streamOptimized --property vmware_adaptertype="lsiLogic" |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]80+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------------------------------------------------+
81
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]82::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]83
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]84 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]85
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]86 "imageName": "cirros",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]87
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]88 "imagePath": "/home/cirros.qcow2",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]89
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]90 "imageType": "qcow2"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]91
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]92 "containerFormat":"bare"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]93
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]94 }
95
963.1.2. **Response**
97>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]98
99+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
100| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
101+===================+=================+===================+===========================+========================================================+
102| id | M | 1 | String | Image UUID in the VIM |
103+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
104| name | M | 1 | String | Image Name |
105+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
106| returnCode | M | 1 | Int | 0: Already exist 1: Newly created |
107+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
108| imageType | M | 1 | String | Image Type |
109| | | | | |
110| | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
111+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
112| containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova,  docker |
113+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
114| visibility | O | 1 | string | Visibility for this image. |
115| | | | | |
116| | | | | public, private, shared, or community |
117+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
118| properties | O | 0..N | List of key-value pairs | |
119+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
120| vimid | M | 1 | String | vim id |
121+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
122| vimName | O | 1 | string | vim name |
123+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
124| tenantId | M | 1 | String | Tenant UUID |
125+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
126
127*202*: accepted
128
129500: failed
130
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]131::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]132
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]133 {
134 "id": "3c9eebdbbfd345658269340b9ea6fb73",
135 "name": "cirros",
136 "returnCode": 1
137 }
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]138
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1393.2. **Delete Image**
140---------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]141
142+---------------------+-----------------------------------------------------------------------------------------+
143| **IF Definition** | **Description** |
144+=====================+=========================================================================================+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]145| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/images/{imageId} |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]146+---------------------+-----------------------------------------------------------------------------------------+
147| Operation | Delete |
148+---------------------+-----------------------------------------------------------------------------------------+
149| Direction | NSLCM->MULTIVIM |
150+---------------------+-----------------------------------------------------------------------------------------+
151| Description | Delete Image |
152+---------------------+-----------------------------------------------------------------------------------------+
153
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1543.2.1. **Request**
155>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]156
157N/A
158
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1593.2.2. **Response**
160>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]161
162204: no content
163
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1643.3. **List Images**
165--------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]166
167+---------------------+-------------------------------------------------------------------------------+
168| **IF Definition** | **Description** |
169+=====================+===============================================================================+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]170| URI | msb.onap.org:80/api/multicloud/v0/{cloud_owner}\_{region}/{tenantid}/images |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]171+---------------------+-------------------------------------------------------------------------------+
172| Operation | GET |
173+---------------------+-------------------------------------------------------------------------------+
174| Direction | NSLCM->MULTIVIM |
175+---------------------+-------------------------------------------------------------------------------+
176| Description | Query Image list |
177+---------------------+-------------------------------------------------------------------------------+
178
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1793.3.1. **Request**
180>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]181
182+-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
183| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
184+=================+=================+===================+===============+==================================================================================================================================================================================================================================================================+
185| 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. |
186+-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
187| 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. |
188+-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
189| name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of an image |
190+-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
191
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1923.3.2. **Response**
193>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]194
195+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
196| \ **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
197+=================================================+=================+===================+===============+========================================================+
198| images | M | 0..N | List | Image List |
199+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
200| id | M | 1 | String | Image ID |
201+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
202| size | M | 1 | int | Image Size |
203+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
204| name | M | 1 | String | Image Name |
205+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
206| status | M | 1 | String | Image Status |
207+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
208| imageType | M | 1 | String | Image Type |
209| | | | | |
210| | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
211+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
212| containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova,  docker |
213+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
214| visibility | O | 1 | string | Visibility for this image. |
215| | | | | |
216| | | | | public, private, shared, or community |
217+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
218| vimId | M | 1 | String | vim id |
219+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
220| vimName | O | 1 | string | vim name |
221+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
222| tenantId | M | 1 | String | Tenant UUID |
223+-------------------------------------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]224
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]225200: ok
226
227500: failed
228
229::
230
231 {
232 "vimid": "",
233 "vimname": "",
234 "imageList": [{
235 "status": "active",
236 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
237 "size": 862016,
238 "name": "vim-plus-cgsl40g-z.qcow2"
239 }]
240 }
241
242
2433.4. **Get Image**
244------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]245
246+---------------------+-----------------------------------------------------------------------------------------+
247| **IF Definition** | **Description** |
248+=====================+=========================================================================================+
249| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/images/{imageid} |
250+---------------------+-----------------------------------------------------------------------------------------+
251| Operation | GET |
252+---------------------+-----------------------------------------------------------------------------------------+
253| Direction | NSLCM->MULTIVIM |
254+---------------------+-----------------------------------------------------------------------------------------+
255| Description | Query Image Information |
256+---------------------+-----------------------------------------------------------------------------------------+
257
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2583.4.1. **Request**
259>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]260
261N/A
262
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2633.4.2. **Response**
264>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]265
266+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
267| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
268+===================+=================+===================+===============+========================================================+
269| id | M | 1 | String | Image ID |
270+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
271| size | M | 1 | int | Image Size |
272+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
273| name | M | 1 | String | Image Name |
274+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
275| status | M | 1 | String | Image Status |
276+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
277| imageType | M | 1 | String | Image Type |
278| | | | | |
279| | | | | ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso |
280+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
281| containerFormat | M | 1 | string | ami, ari, aki, bare, ovf, ova,  docker |
282+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
283| visibility | O | 1 | string | Visibility for this image. |
284| | | | | |
285| | | | | public, private, shared, or community |
286+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
287| vimId | M | 1 | String | vim id |
288+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
289| vimName | M | 1 | string | vim name |
290+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
291| tenantId | M | 1 | String | Tenant UUID |
292+-------------------+-----------------+-------------------+---------------+--------------------------------------------------------+
293
294200: ok
295
296500: failed
297
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]298::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]299
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]300 {
301 "vimid": "",
302 "vimname": "",
303 "status": "active",
304 "id": "5e2757c1-f846-4727-915c-9a872553ed75",
305 "size": 862016,
306 "name": "vim-plus-cgsl40g-z.qcow2"
307 }
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]308
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]3094. **Network Management**
310^^^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]311
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]3124.1. **Create Network**
313-----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]314
315+---------------------+---------------------------------------------------------------------------------+
316| **IF Definition** | **Description** |
317+=====================+=================================================================================+
318| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
319+---------------------+---------------------------------------------------------------------------------+
320| Operation | POST |
321+---------------------+---------------------------------------------------------------------------------+
322| Direction | VNFLCM,NSLCM->MULTIVIM |
323+---------------------+---------------------------------------------------------------------------------+
324| Description | Create network and subnetwork on the VIM |
325+---------------------+---------------------------------------------------------------------------------+
326
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]3274.1.1. **Request**
328>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]329
330+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
331| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
332+=============================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
333| name | M | 1 | String | Logical network name |
334+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
335| shared | M | 1 | boolean | Whether to share(1:sharing;0:private) |
336+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
337| vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
338+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
339| networkType | O | 1 | String | Network type |
340| | | | | |
341| | | | | flat, vlan, vxlan, gre, |
342| | | | | |
343| | | | | portgroup |
344+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
345| segmentationId | O | 1 | Int | id of paragraph |
346+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
347| 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. |
348+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]349| routerExternal | O | 1 | boolean |Indicates whether this network can provide floating IPs via a router. |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]350+-----------------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
351
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]352::
353
354 {
355 "tenant": "tenant1",
356 "networkName": "ommnet",
357 "shared": 1,
358 "vlanTransparent": 1,
359 "networkType": "vlan",
360 "segmentationId": 202,
361 "physicalNetwork": "ctrl",
362 "routerExternal": 0
363 }
364
3654.1.2. **Response**
366>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]367
368+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
369| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
370+===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
371| status | M | 1 | string | Network status |
372+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
373| id | M | 1 | string | Network id |
374+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
375| name | M | 1 | string | Network name |
376+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
377+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
378| tenantId | M | 1 | String | Tenant UUID |
379+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
380| segmentationId | O | 1 | int | Segmentation id |
381+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
382| networkType | O | 1 | string | Network type |
383+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
384| 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. |
385+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
386| vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
387+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
388| shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
389+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
390| routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
391+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
392| returnCode | M | 1 | int | 0: Already exist 1: Newly created |
393+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
394| vimId | M | 1 | String | vim id |
395+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
396| vimName | O | 1 | string | vim name |
397+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
398
399202: accepted
400
401500: failed
402
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]403::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]404
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]405 {
406 "returnCode": 0,
407 "vimId": "11111",
408 "vimName": "11111",
409 "status": "ACTIVE",
410 "id": "3c9eebdbbfd345658269340b9ea6fb73",
411 "name": "net1",
412 "tenant": "tenant1",
413 "networkName": "ommnet",
414 "shared": 1,
415 "vlanTransparent": 1,
416 "networkType": "vlan",
417 "segmentationId": 202,
418 "physicalNetwork": "ctrl",
419 "routerExternal": 0
420 }
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]421
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]4224.2. **Delete Network**
423-----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]424
425+---------------------+---------------------------------------------------------------------------------------------+
426| **IF Definition** | **Description** |
427+=====================+=============================================================================================+
428| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
429+---------------------+---------------------------------------------------------------------------------------------+
430| Operation | Delete |
431+---------------------+---------------------------------------------------------------------------------------------+
432| Direction | NFLCM,NSLCM->MULTIVIM |
433+---------------------+---------------------------------------------------------------------------------------------+
434
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]4354.2.1. **Request**
436>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]437
438N/A
439
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]4404.2.2. **Response**
441>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]442
443204: no content
444
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]4454.3. **List Network**
446---------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]447
448+---------------------+---------------------------------------------------------------------------------+
449| **IF Definition** | **Description** |
450+=====================+=================================================================================+
451| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks |
452+---------------------+---------------------------------------------------------------------------------+
453| Operation | get |
454+---------------------+---------------------------------------------------------------------------------+
455| Direction | NFLCM,NSLCM->MULTIVIM |
456+---------------------+---------------------------------------------------------------------------------+
457
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]4584.3.1. **Query**
459>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]460
461+-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
462| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
463+=================+=================+===================+===============+=======================================================================================+
464| name | O | 1 | String | Filters the response by a name, as a string. A valid value is the name of a network |
465+-----------------+-----------------+-------------------+---------------+---------------------------------------------------------------------------------------+
466
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]4674.3.2. **Response**
468>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]469
470+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
471| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
472+===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
473| vimId | M | 1 | String | vim id |
474+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
475| vimName | O | 1 | string | vim name |
476+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
477| networks | | 0..N | List | Network list |
478+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
479| status | M | 1 | string | Network status |
480+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
481| id | M | 1 | string | Network id |
482+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
483| name | M | 1 | string | Network name |
484+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
485| tenantId | M | 1 | String | Tenant UUID |
486+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
487| segmentationId | O | 1 | int | Segmentation id |
488+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
489| networkType | O | 1 | string | Network type |
490+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
491| 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. |
492+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
493| vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
494+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
495| shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
496+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
497| routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
498+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
499
500200: ok
501
502500: failed
503
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]504::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]505
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]506 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]507
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]508 "vimId": "11111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]509
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]510 "vimName": "111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]511
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]512 "networks":
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]513
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]514 [{
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]515
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]516 "status": "ACTIVE",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]517
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]518 "id": "3c9eebdbbfd345658269340b9ea6fb73",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]519
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]520 "name": "net1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]521
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]522 "tenant": "tenant1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]523
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]524 "networkName": "ommnet",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]525
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]526 "shared": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]527
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]528 "vlanTransparent": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]529
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]530 "networkType": "vlan",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]531
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]532 "segmentationId": 202,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]533
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]534 "physicalNetwork ": "ctrl",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]535
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]536 "routerExternal ": 0
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]537
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]538 }]
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]539
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]540 }
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]541
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]5424.4. **Get Network**
543--------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]544
545+---------------------+---------------------------------------------------------------------------------------------+
546| **IF Definition** | **Description** |
547+=====================+=============================================================================================+
548| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/networks/{networkId} |
549+---------------------+---------------------------------------------------------------------------------------------+
550| Operation | get |
551+---------------------+---------------------------------------------------------------------------------------------+
552| Direction | NFLCM,NSLCM->MULTIVIM |
553+---------------------+---------------------------------------------------------------------------------------------+
554
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]5554.4.1. **Request**
556>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]557
558N/A
559
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]5604.4.2. **Response**
561>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]562
563+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
564| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
565+===================+=================+===================+===============+===========================================================================================================================================================================================================================================================================================+
566| status | M | 1 | string | Network status |
567+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
568| id | M | 1 | string | Network id |
569+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
570| name | M | 1 | string | Network name |
571+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
572| tenantId | M | 1 | String | Tenant UUID |
573+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
574| segmentationId | O | 1 | int | Segmentation id |
575+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
576| networkType | O | 1 | string | Network type |
577+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
578| 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. |
579+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
580| vlanTransparent | O | 1 | boolean | Whether to support VLAN pass through(1:true;0:false) |
581+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
582| shared | O | 1 | boolean | Whether to share(1:sharing;0:private) |
583+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
584| routerExternal | O | 1 | boolean | Indicates whether this network can provide floating IPs via a router. |
585+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
586| returnCode | M | 1 | int | 0: Already exist 1: Newly created |
587+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
588| vimId | M | 1 | String | vim id |
589+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
590| vimName | O | 1 | string | vim name |
591+-------------------+-----------------+-------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
592
593200: ok
594
595500: failed
596
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]597::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]598
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]599 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]600
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]601 "vimId":"11111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]602
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]603 "vimName":"11111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]604
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]605 "status": "ACTIVE",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]606
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]607 "id": "3c9eebdbbfd345658269340b9ea6fb73",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]608
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]609 "name": "net1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]610
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]611 "tenant": "tenant1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]612
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]613 "networkName": "ommnet",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]614
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]615 "shared": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]616
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]617 "vlanTransparent": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]618
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]619 "networkType":"vlan",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]620
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]621 "segmentationId":202,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]622
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]623 "physicalNetwork ":"ctrl",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]624
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]625 "routerExternal ":0
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]626
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]627 }
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]628
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]6295. **Subnetwork Management**
630^^^^^^^^^^^^^^^^^^^^^^^^^^^^
631
6325.1. **Create Subnets**
633-----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]634
635+---------------------+--------------------------------------------------------------------------------+
636| **IF Definition** | **Description** |
637+=====================+================================================================================+
638| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
639+---------------------+--------------------------------------------------------------------------------+
640| Operation | POST |
641+---------------------+--------------------------------------------------------------------------------+
642| Direction | VNFLCM,NSLCM->MULTIVIM |
643+---------------------+--------------------------------------------------------------------------------+
644| Description | Create network and subnetwork on the VIM |
645+---------------------+--------------------------------------------------------------------------------+
646
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]6475.1.1. **Request**
648>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]649
650+-------------------+-----------------+-------------------+------------------------+----------------------+
651| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
652+===================+=================+===================+========================+======================+
653| networkId | M | 1 | String | Network Id |
654+-------------------+-----------------+-------------------+------------------------+----------------------+
655| name | M | 1 | String | SubnetName |
656+-------------------+-----------------+-------------------+------------------------+----------------------+
657| cidr | M | 1 | String | Subnet cidr |
658+-------------------+-----------------+-------------------+------------------------+----------------------+
659| ipVersion | M | 1 | Int | Ip type |
660| | | | | |
661| | | | | 4,6 |
662+-------------------+-----------------+-------------------+------------------------+----------------------+
663| enableDhcp | O | 1 | boolean | Whether to allow |
664| | | | | |
665| | | | | 1: yes;0: no |
666+-------------------+-----------------+-------------------+------------------------+----------------------+
667| gatewayIp | O | 1 | String | Gateway ip |
668+-------------------+-----------------+-------------------+------------------------+----------------------+
669| dnsNameservers | O | 1..n | List of servers | List of servers |
670+-------------------+-----------------+-------------------+------------------------+----------------------+
671| hostRoutes | O | 1..n | List of routes | List of routes |
672+-------------------+-----------------+-------------------+------------------------+----------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]673| allocationPools | O | 1..n | list of "allocation" | list of allocation |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]674+-------------------+-----------------+-------------------+------------------------+----------------------+
675| -->allocation | | | | |
676+-------------------+-----------------+-------------------+------------------------+----------------------+
677| -->start | O | 1 | String | Start ip |
678+-------------------+-----------------+-------------------+------------------------+----------------------+
679| -->end | O | 1 | String | End ip |
680+-------------------+-----------------+-------------------+------------------------+----------------------+
681
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]682::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]683
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]684 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]685
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]686 "tenant": "tenant1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]687
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]688 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]689
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]690 "subnetName": "subnet1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]691
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]692 "cidr": "10.43.35.0/24",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]693
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]694 "ipVersion": 4,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]695
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]696 "enableDhcp": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]697
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]698 "gatewayIp": "10.43.35.1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]699
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]700 "dnsNameservers": [],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]701
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]702 "allocationPools": [{
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]703
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]704 "start": "192.168.199.2",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]705
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]706 "end": "192.168.199.254"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]707
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]708 }],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]709
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]710 "hostRoutes": []
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]711
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]712 }
713
7145.1.2. **Response**
715>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]716
717+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
718| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
719+===================+=================+===================+========================+=====================================+
720| returnCode | M | 1 | int | 0: Already exist 1: Newly created |
721+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
722| vimId | M | 1 | String | vim id |
723+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
724| vimName | O | 1 | string | vim name |
725+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
726| status | M | 1 | string | subnetwork status |
727+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
728| id | M | 1 | string | subNetwork id |
729+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
730| tenantId | M | 1 | String | Tenant UUID |
731+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
732| networkId | O | 1 | String | Network Id |
733+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
734| networkName | O | 1 | String | Network Name |
735+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
736| name | M | 1 | String | SubnetName |
737+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
738| cidr | M | 1 | String | Subnet cidr |
739+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
740| ipVersion | M | 1 | Int | Ip type |
741| | | | | |
742| | | | | 4,6 |
743+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
744| enableDhcp | O | 1 | boolean | Whether to allow |
745| | | | | |
746| | | | | 1: yes;0: no |
747+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
748| gatewayIp | O | 1 | String | Gateway ip |
749+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
750| dnsNameservers | O | 1..n | List of servers | List of servers |
751+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
752| hostRoutes | O | 1..n | List of routes | List of routes |
753+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]754| allocationPools | O | 1..n | list of "allocation" | list of allocation |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]755+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
756| -->allocation | | | | |
757+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
758| -->start | O | 1 | String | Start ip |
759+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
760| -->end | O | 1 | String | End ip |
761+-------------------+-----------------+-------------------+------------------------+-------------------------------------+
762
763202: accepted
764
765500: failed
766
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]767::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]768
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]769 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]770
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]771 "returnCode": 0,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]772
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]773 "vimId": "11111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]774
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]775 "vimName": "11111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]776
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]777 "status": " ACTIVE",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]778
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]779 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]780
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]781 "tenant": "tenant1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]782
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]783 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]784
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]785 "name": "subnet1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]786
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]787 "cidr": "10.43.35.0/24",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]788
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]789 "ipVersion": 4,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]790
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]791 "enableDhcp": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]792
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]793 "gatewayIp": "10.43.35.1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]794
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]795 "dnsNameservers": [],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]796
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]797 "allocationPools": [{
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]798
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]799 "start": "192.168.199.2",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]800
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]801 "end": "192.168.199.254"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]802
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]803 }],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]804
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]805 "hostRoutes": []
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]806
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]807 }
808
8095.2. **Delete Subnets**
810-----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]811
812+---------------------+-------------------------------------------------------------------------------------------+
813| **IF Definition** | **Description** |
814+=====================+===========================================================================================+
815| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetId} |
816+---------------------+-------------------------------------------------------------------------------------------+
817| Operation | Delete |
818+---------------------+-------------------------------------------------------------------------------------------+
819| Direction | NFLCM,NSLCM->MULTIVIM |
820+---------------------+-------------------------------------------------------------------------------------------+
821
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]8225.2.1. **Request**
823>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]824
825N/A
826
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]8275.2.2. **Response**
828>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]829
830204: no content
831
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]8325.3. **List Subnets**
833---------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]834
835+---------------------+--------------------------------------------------------------------------------+
836| **IF Definition** | **Description** |
837+=====================+================================================================================+
838| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets |
839+---------------------+--------------------------------------------------------------------------------+
840| Operation | get |
841+---------------------+--------------------------------------------------------------------------------+
842| Direction | NFLCM,NSLCM->MULTIVIM |
843+---------------------+--------------------------------------------------------------------------------+
844
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]8455.3.1. **Query**
846>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]847
848msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/subnets?{……}
849
850+-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
851| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
852+=================+=================+===================+===============+================================================================================================+
853| name | O | 1 | String | Filters fields of the response by a name, as a string. A valid value is the name of a subnet |
854+-----------------+-----------------+-------------------+---------------+------------------------------------------------------------------------------------------------+
855
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]8565.3.2. **Response**
857>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]858
859+-------------------+-----------------+-------------------+------------------------+----------------------+
860| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
861+===================+=================+===================+========================+======================+
862| vimId | M | 1 | String | vim id |
863+-------------------+-----------------+-------------------+------------------------+----------------------+
864| vimName | O | 1 | string | vim name |
865+-------------------+-----------------+-------------------+------------------------+----------------------+
866| subnets | M | 0..N | List | Network list |
867+-------------------+-----------------+-------------------+------------------------+----------------------+
868| status | | 1 | string | subnetwork status |
869+-------------------+-----------------+-------------------+------------------------+----------------------+
870| id | | 1 | string | subNetwork id |
871+-------------------+-----------------+-------------------+------------------------+----------------------+
872| tenantId | M | 1 | String | Tenant UUID |
873+-------------------+-----------------+-------------------+------------------------+----------------------+
874| networkId | O | 1 | String | Network Id |
875+-------------------+-----------------+-------------------+------------------------+----------------------+
876| networkName | O | 1 | String | Network Name |
877+-------------------+-----------------+-------------------+------------------------+----------------------+
878| name | M | 1 | String | SubnetName |
879+-------------------+-----------------+-------------------+------------------------+----------------------+
880| cidr | M | 1 | String | Subnet cidr |
881+-------------------+-----------------+-------------------+------------------------+----------------------+
882| ipVersion | M | 1 | Int | Ip type |
883| | | | | |
884| | | | | 4,6 |
885+-------------------+-----------------+-------------------+------------------------+----------------------+
886| enableDhcp | O | 1 | boolean | Whether to allow |
887| | | | | |
888| | | | | 1: yes;0: no |
889+-------------------+-----------------+-------------------+------------------------+----------------------+
890| gatewayIp | O | 1 | String | Gateway ip |
891+-------------------+-----------------+-------------------+------------------------+----------------------+
892| dnsNameservers | O | 1..n | List of servers | List of servers |
893+-------------------+-----------------+-------------------+------------------------+----------------------+
894| hostRoutes | O | 1..n | List of routes | List of routes |
895+-------------------+-----------------+-------------------+------------------------+----------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]896| allocationPools | O | 1..n | list of "allocation" | list of allocation |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]897+-------------------+-----------------+-------------------+------------------------+----------------------+
898| -->allocation | | | | |
899+-------------------+-----------------+-------------------+------------------------+----------------------+
900| -->start | O | 1 | String | Start ip |
901+-------------------+-----------------+-------------------+------------------------+----------------------+
902| -->end | O | 1 | String | End ip |
903+-------------------+-----------------+-------------------+------------------------+----------------------+
904
905**200: ok**
906
907**500: failed**
908
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]909::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]910
911 {
912
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]913 "vimId": "11111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]914
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]915 "vimName": "11111",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]916
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]917 "subnets": [
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]918
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]919 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]920
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]921 "status": " ACTIVE",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]922
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]923 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]924
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]925 "tenant": "tenant1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]926
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]927 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]928
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]929 "name": "subnet1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]930
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]931 "cidr": "10.43.35.0/24",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]932
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]933 "ipVersion": 4,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]934
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]935 "enableDhcp": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]936
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]937 "gatewayIp": "10.43.35.1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]938
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]939 "dnsNameservers": [],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]940
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]941 "allocationPools": [{
942
943 "start": "192.168.199.2",
944
945 "end": "192.168.199.254"
946
947 }],
948
949 "hostRoutes": []
950
951 }
952
953 ]
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]954
955 }
956
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]9575.4. **Get Subnets**
958--------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]959
960+---------------------+-------------------------------------------------------------------------------------------+
961| **IF Definition** | **Description** |
962+=====================+===========================================================================================+
963| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/subnets/{subnetid} |
964+---------------------+-------------------------------------------------------------------------------------------+
965| Operation | get |
966+---------------------+-------------------------------------------------------------------------------------------+
967| Direction | NFLCM,NSLCM->MULTIVIM |
968+---------------------+-------------------------------------------------------------------------------------------+
969
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]9705.4.1. **Request**
971>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]972
973N/A
974
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]9755.4.2. **Response**
976>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]977
978+-------------------+-----------------+-------------------+------------------------+----------------------+
979| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
980+===================+=================+===================+========================+======================+
981| vimId | M | 1 | String | vim id |
982+-------------------+-----------------+-------------------+------------------------+----------------------+
983| vimName | O | 1 | string | vim name |
984+-------------------+-----------------+-------------------+------------------------+----------------------+
985| status | | 1 | string | subnetwork status |
986+-------------------+-----------------+-------------------+------------------------+----------------------+
987| id | | 1 | string | subNetwork id |
988+-------------------+-----------------+-------------------+------------------------+----------------------+
989| tenantId | M | 1 | String | Tenant UUID |
990+-------------------+-----------------+-------------------+------------------------+----------------------+
991| networkId | O | 1 | String | Network Id |
992+-------------------+-----------------+-------------------+------------------------+----------------------+
993| networkName | O | 1 | String | Network Name |
994+-------------------+-----------------+-------------------+------------------------+----------------------+
995| name | M | 1 | String | SubnetName |
996+-------------------+-----------------+-------------------+------------------------+----------------------+
997| cidr | M | 1 | String | Subnet cidr |
998+-------------------+-----------------+-------------------+------------------------+----------------------+
999| ipVersion | M | 1 | Int | Ip type |
1000| | | | | |
1001| | | | | 4,6 |
1002+-------------------+-----------------+-------------------+------------------------+----------------------+
1003| enableDhcp | O | 1 | boolean | Whether to allow |
1004| | | | | |
1005| | | | | 1: yes;0: no |
1006+-------------------+-----------------+-------------------+------------------------+----------------------+
1007| gatewayIp | O | 1 | String | Gateway ip |
1008+-------------------+-----------------+-------------------+------------------------+----------------------+
1009| dnsNameservers | O | 1..n | List of servers | List of servers |
1010+-------------------+-----------------+-------------------+------------------------+----------------------+
1011| hostRoutes | O | 1..n | List of routes | List of routes |
1012+-------------------+-----------------+-------------------+------------------------+----------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1013| allocationPools | O | 1..n | list of "allocation" | list of allocation |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1014+-------------------+-----------------+-------------------+------------------------+----------------------+
1015| -->allocation | | | | |
1016+-------------------+-----------------+-------------------+------------------------+----------------------+
1017| -->start | O | 1 | String | Start ip |
1018+-------------------+-----------------+-------------------+------------------------+----------------------+
1019| -->end | O | 1 | String | End ip |
1020+-------------------+-----------------+-------------------+------------------------+----------------------+
1021
1022202: accepted
1023
1024500: failed
1025
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1026::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1027
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1028 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1029
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1030 "status": " ACTIVE",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1031
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1032 "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1033
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1034 "tenant": "tenant1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1035
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1036 "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1037
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1038 "name": "subnet1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1039
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1040 "cidr": "10.43.35.0/24",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1041
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1042 "ipVersion": 4,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1043
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1044 "enableDhcp": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1045
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1046 "gatewayIp": "10.43.35.1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1047
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1048 "dnsNameservers": [],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1049
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1050 "allocationPools": [{
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1051
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1052 "start": "192.168.199.2",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1053
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1054 "end": "192.168.199.254"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1055
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1056 }],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1057
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1058 "hostRoutes": []
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1059
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1060 }
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1061
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]10626. **Virtual Port**
1063^^^^^^^^^^^^^^^^^^^
1064
10656.1. **Create Virtual Port**
1066----------------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1067
1068+---------------------+------------------------------------------------------------------------------+
1069| **IF Definition** | **Description** |
1070+=====================+==============================================================================+
1071| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports |
1072+---------------------+------------------------------------------------------------------------------+
1073| Operation | POST |
1074+---------------------+------------------------------------------------------------------------------+
1075| Direction | VNFLCM->MULTIVIM |
1076+---------------------+------------------------------------------------------------------------------+
1077
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]10786.1.1. **Request**
1079>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1080
1081+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1082| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1083+========================+=================+===================+===============+=======================================================+
1084| networkId | M | 1 | string | Network UUID |
1085+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1086| subnetId | O | 1 | string | Subnet UUID |
1087+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1088| name | M | 1 | string | Port name |
1089+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1090| macAddress | O | 1 | string | Mac address |
1091+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1092| ip | O | 1 | string | Ip address |
1093+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1094| vnicType | O | 1 | string | Virtual network card type, |
1095| | | | | |
1096| | | | | the value of three kinds of normal/direct/macvtap |
1097+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1098| \ **securityGroups** | **O** | **1** | **string** | **The IDs of security groups applied to the port.** |
1099+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
1100
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]11016.1.2. **Response**
1102>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1103
1104+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1105| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1106+======================+=================+===================+===============+=====================================================+
1107| returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1108+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1109| vimId | M | 1 | String | vim id |
1110+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1111| vimName | O | 1 | string | vim name |
1112+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1113| status | M | 1 | string | status |
1114+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1115| id | M | 1 | string | Port Id |
1116+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1117| name | M | 1 | string | Port name |
1118+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1119| tenantId | M | 1 | String | Tenant UUID |
1120+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1121| networkName | M | 1 | string | Network name |
1122+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1123| networkId | M | 1 | string | Network Id |
1124+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1125| subnetName | M | 1 | string | Subnet name |
1126+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1127| subnetId | M | 1 | string | SubnetId |
1128+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1129| macAddress | O | 1 | string | Mac address |
1130+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1131| ip | O | 1 | string | Ip address |
1132+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1133| vnicType | O | 1 | string | Virtual network card type, |
1134| | | | | |
1135| | | | | the value of three kinds of normal/direct/macvtap |
1136+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1137| **securityGroups** | **O** | **1** | **string** | **List of security group names.** |
1138+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1139
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]11406.2. **Delete Virtual Port**
1141----------------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1142
1143+---------------------+---------------------------------------------------------------------------------------+
1144| **IF Definition** | **Description** |
1145+=====================+=======================================================================================+
1146| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1147+---------------------+---------------------------------------------------------------------------------------+
1148| Operation | DELETTE |
1149+---------------------+---------------------------------------------------------------------------------------+
1150| Direction | VNFLCM->MULTIVIM |
1151+---------------------+---------------------------------------------------------------------------------------+
1152
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]11536.2.1. **Request**
1154>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1155
1156N/A
1157
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]11586.2.2. **Response**
1159>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1160
1161204: no content
1162
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]11636.3. **List Virtual Port**
1164--------------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1165
1166+---------------------+-----------------------------------------------------------------------------+
1167| **IF Definition** | **Description** |
1168+=====================+=============================================================================+
1169| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenantid}/ports |
1170+---------------------+-----------------------------------------------------------------------------+
1171| Operation | GET |
1172+---------------------+-----------------------------------------------------------------------------+
1173| Direction | VNFLCM->MULTIVIM |
1174+---------------------+-----------------------------------------------------------------------------+
1175
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]11766.3.1. **Query**
1177>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1178
1179+-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1180| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1181+=================+=================+===================+===============+=================================================+
1182| name | M | 1 | string | Port name to filter out list of virtual ports |
1183+-----------------+-----------------+-------------------+---------------+-------------------------------------------------+
1184
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]11856.3.2. **Response**
1186>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1187
1188+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1189| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1190+===================+=================+===================+===============+=====================================================+
1191| vimId | M | 1 | String | vim id |
1192+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1193| vimName | O | 1 | string | vim name |
1194+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1195| tenantId | M | 1 | String | Tenant UUID |
1196+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1197| Ports | M | 0..N | List | ports |
1198+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1199| id | M | 1 | string | Port Id |
1200+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1201| name | M | 1 | string | Port name |
1202+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1203| status | M | 1 | string | status |
1204+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1205| **networkName** | O | 1 | string | Network name |
1206+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1207| networkId | M | 1 | string | Network Id |
1208+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1209| subnetName | O | 1 | string | Subnet name |
1210+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1211| subnetId | M | 1 | string | SubnetId |
1212+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1213| macAddress | O | 1 | string | Mac address |
1214+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1215| ip | O | 1 | string | Ip address |
1216+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1217| vnicType | O | 1 | string | Virtual network card type, |
1218| | | | | |
1219| | | | | the value of three kinds of normal/direct/macvtap |
1220+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1221| securityGroups | O | 1 | string | List of security group names. |
1222+-------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1223
1224**200: ok**
1225
1226**500: failed**
1227
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1228
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]12296.4. **Get Virtual Port**
1230-------------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1231
1232+---------------------+---------------------------------------------------------------------------------------+
1233| **IF Definition** | **Description** |
1234+=====================+=======================================================================================+
1235| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ports/{portid} |
1236+---------------------+---------------------------------------------------------------------------------------+
1237| Operation | GET |
1238+---------------------+---------------------------------------------------------------------------------------+
1239| Direction | VNFLCM->MULTIVIM |
1240+---------------------+---------------------------------------------------------------------------------------+
1241
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]12426.4.1. **Request**
1243>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1244
1245N/A
1246
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]12476.4.2. **Response**
1248>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1249
1250+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1251| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1252+==================+=================+===================+===============+=====================================================+
1253| vimId | M | 1 | String | vim id |
1254+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1255| vimName | O | 1 | string | vim name |
1256+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1257| status | M | 1 | string | status |
1258+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1259| id | M | 1 | string | Port Id |
1260+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1261| name | M | 1 | string | Port name |
1262+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1263| tenantId | M | 1 | String | Tenant UUID |
1264+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1265| networkName | M | 1 | string | Network name |
1266+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1267| networkId | M | 1 | string | Network Id |
1268+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1269| subnetName | M | 1 | string | Subnet name |
1270+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1271| subnetId | M | 1 | string | SubnetId |
1272+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1273| macAddress | O | 1 | string | Mac address |
1274+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1275| ip | O | 1 | string | Ip address |
1276+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1277| vnicType | O | 1 | string | Virtual network card type, |
1278| | | | | |
1279| | | | | the value of three kinds of normal/direct/macvtap |
1280+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1281| securityGroups | O | 1 | string | **List of security group names.** |
1282+------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
1283
1284**200: ok**
1285
1286**500: failed**
1287
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1288
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]12897. **Server Management**
1290^^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1291
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]12927.1. **Create Server**
1293----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1294
1295+---------------------+--------------------------------------------------------------------------------+
1296| **IF Definition** | **Description** |
1297+=====================+================================================================================+
1298| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1299+---------------------+--------------------------------------------------------------------------------+
1300| Operation | POST |
1301+---------------------+--------------------------------------------------------------------------------+
1302| Direction | VNFLCM->MULTIVIM |
1303+---------------------+--------------------------------------------------------------------------------+
1304
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]13057.1.1. **Request**
1306>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1307
1308+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1309| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1310+======================+=================+===================+=======================================+========================================================================================================================================================================================+
1311| name | M | 1 | string | server name |
1312+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1313| boot | M | 1 | String | Start parameters |
1314+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1315| nicArray | O | 1..n | List of nic | List of nic |
1316+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1317| contextArray | O | 1..n | list of context | list of context |
1318+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1319| volumeArray | O | 1..n | list of volume | list of volume |
1320+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1321| availabilityZone | O | 1 | string | Usable field |
1322+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1323| flavorId | M | 1 | String | server Flavor id |
1324+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1325| metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1326+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1327| userdata | O | 1 | string | Configuration information or scripts to use upon launch. Must be Base64 encoded. |
1328| | | | | |
1329| | | | | 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. |
1330+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1331| 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. |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1332+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1333| serverGroup | O | 1 | string | the ServerGroup for anti-affinity and affinity |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1334+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1335
1336**boot**
1337
1338+-----------------+-----------------+-------------------+---------------+---------------------------+
1339| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1340+=================+=================+===================+===============+===========================+
1341| type | M | 1 | int | Startup mode |
1342| | | | | |
1343| | | | | 1. boot from the volume |
1344| | | | | |
1345| | | | | 2. boot from image |
1346+-----------------+-----------------+-------------------+---------------+---------------------------+
1347| volumeId | O | 1 | string | Volume Id(type=1) |
1348+-----------------+-----------------+-------------------+---------------+---------------------------+
1349| imageId | O | 1 | String | ImageId（type=2） |
1350+-----------------+-----------------+-------------------+---------------+---------------------------+
1351
1352**contextArray**
1353
1354+-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1355| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1356+=================+=================+===================+===============+===========================================================================================================================================================+
1357| fileName | M | 1 | String | Injection file name |
1358+-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1359| 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. ) |
1360+-----------------+-----------------+-------------------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
1361
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1362**volumeArray**
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1363
1364+-----------------+-----------------+-------------------+---------------+-------------------+
1365| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1366+=================+=================+===================+===============+===================+
1367| volumeId | M | 1 | String | Volume Id |
1368+-----------------+-----------------+-------------------+---------------+-------------------+
1369
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1370**nicArray**
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1371
1372+-----------------+-----------------+-------------------+---------------+-------------------+
1373| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1374+=================+=================+===================+===============+===================+
1375| portId | M | 1 | String | Port Id |
1376+-----------------+-----------------+-------------------+---------------+-------------------+
1377
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1378
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1379::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1380
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1381 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1382
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1383 "tenant": "tenant1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1384
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1385 "name": "vm1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1386
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1387 "availabilityZone": "az1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1388
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1389 "flavorName": "vm_large",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1390
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1391 "boot": {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1392
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1393 "type": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1394
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1395 " volumeName": "volume1"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1396
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1397 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1398
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1399 "flavorId": "vm_large_134213",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1400
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1401 "contextArray": [{
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1402
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1403 "fileName": "test.yaml",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1404
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1405 "fileData": "…."
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1406
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1407 }],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1408
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1409 "volumeArray": [{
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1410
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1411 "volumeName": "vol1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1412
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1413 }],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1414
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1415 "nicArray": [{
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1416
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1417 "portId": "port_a"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1418
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1419 }],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1420
Bin Yang0e8aea32018-11-16 10:09:08 +0000[diff] [blame]1421 "metada": {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1422
Bin Yang0e8aea32018-11-16 10:09:08 +0000[diff] [blame]1423 "foo": "foo value"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1424
Bin Yang0e8aea32018-11-16 10:09:08 +0000[diff] [blame]1425 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1426
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1427 "userdata": "abcdedf"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1428
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1429 }
1430
14317.1.2. **Response**
1432>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1433
1434+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1435| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1436+======================+=================+===================+======================================+========================================================================================================================================================================================+
1437| vimId | M | 1 | String | vim id |
1438+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1439| vimName | O | 1 | string | vim name |
1440+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1441| returnCode | | 1 | int | 0: Already exist 1: Newly created |
1442+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1443| id | M | 1 | string | server id |
1444+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1445| name | | 1 | string | server name |
1446+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1447| tenantId | M | 1 | String | Tenant UUID |
1448+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1449| boot | M | 1 | String | Start parameters |
1450+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1451| nicArray | O | 1..n | List of nic | List of nic |
1452+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1453| volumeArray | O | 1..n | list of volume | list of volume |
1454+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1455| availabilityZone | O | 1 | string | Usable field |
1456+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1457| flavorId | M | 1 | String | server Flavor |
1458+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1459| metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1460+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1461| **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.** |
1462| | | | | |
1463| | | | | **[TBD]** |
1464+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1465| **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1466| | | | | |
1467| | | | | [TBD] |
1468+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1469| **status** | **M** | **1** | **string** | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR |
1470+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1471
1472202: accepted
1473
1474500: failed
1475
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1476::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1477
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1478 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1479
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1480 "id": "3c9eebdbbfd345658269340b9ea6fb73",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1481
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1482 "name": "vm1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1483
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1484 "returnCode": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1485
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1486 }
1487
14887.2. **Delete Server**
1489----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1490
1491+---------------------+-------------------------------------------------------------------------------------------+
1492| **IF Definition** | **Description** |
1493+=====================+===========================================================================================+
1494| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1495+---------------------+-------------------------------------------------------------------------------------------+
1496| Operation | DELETE |
1497+---------------------+-------------------------------------------------------------------------------------------+
1498| Direction | NFLCM,NSLCM->MULTIVIM |
1499+---------------------+-------------------------------------------------------------------------------------------+
1500
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15017.2.1. **Request**
1502>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1503
1504N/A
1505
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15067.2.2. **Response**
1507>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1508
1509204: no content
1510
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15117.3. **List Server**
1512--------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1513
1514+---------------------+--------------------------------------------------------------------------------+
1515| **IF Definition** | **Description** |
1516+=====================+================================================================================+
1517| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers |
1518+---------------------+--------------------------------------------------------------------------------+
1519| Operation | get |
1520+---------------------+--------------------------------------------------------------------------------+
1521| Direction | NFLCM,NSLCM->MULTIVIM |
1522+---------------------+--------------------------------------------------------------------------------+
1523
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15247.3.1. **Request**
1525>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1526
1527msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/vms?{……}
1528
1529+-----------------+-----------------+-------------------+---------------+-------------------+
1530| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1531+=================+=================+===================+===============+===================+
1532| name | M | 1 | string | server name |
1533+-----------------+-----------------+-------------------+---------------+-------------------+
1534
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15357.3.2. **Response**
1536>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1537
1538+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1539| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1540+======================+=================+===================+=======================================+========================================================================================================================================================================================+
1541| vimId | M | 1 | String | vim id |
1542+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1543| vimName | O | 1 | string | vim name |
1544+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1545| servers | M | 1 | array | server list |
1546+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1547| id | M | 1 | string | server id |
1548+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1549| name | M | 1 | string | server name |
1550+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1551| tenantId | M | 1 | String | Tenant UUID |
1552+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1553| boot | M | 1 | String | Start parameters |
1554+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1555| nicArray | O | 1..n | List of nic | List of nic |
1556+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1557| volumeArray | O | 1..n | list of volume | list of volume |
1558+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1559| availabilityZone | O | 1 | string | Usable field |
1560+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1561| flavorId | M | 1 | String | server Flavor |
1562+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1563| metada | O | 1 | keypair | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1564+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1565| **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.** |
1566| | | | | |
1567| | | | | **[TBD]** |
1568+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1569| **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1570| | | | | |
1571| | | | | [TBD] |
1572+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1573
1574200: ok
1575
1576500: failed
1577
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15787.4. **Get Server**
1579-------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1580
1581+---------------------+-------------------------------------------------------------------------------------------+
1582| **IF Definition** | **Description** |
1583+=====================+===========================================================================================+
1584| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/servers/{serverid} |
1585+---------------------+-------------------------------------------------------------------------------------------+
1586| Operation | get |
1587+---------------------+-------------------------------------------------------------------------------------------+
1588| Direction | NFLCM,NSLCM->MULTIVIM |
1589+---------------------+-------------------------------------------------------------------------------------------+
1590
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15917.4.1. **Request**
1592>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1593
1594N/A
1595
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]15967.4.2. **Response**
1597>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1598
1599+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1600| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1601+======================+=================+===================+=======================================+========================================================================================================================================================================================+
1602| vimId | M | 1 | String | vim id |
1603+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1604| vimName | O | 1 | string | vim name |
1605+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1606| id | M | 1 | string | server id |
1607+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1608| name | M | 1 | string | server name |
1609+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1610| tenantId | M | 1 | String | Tenant UUID |
1611+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1612| boot | M | 1 | String | Start parameters |
1613+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1614| nicArray | O | 1..n | List of nic | List of nic |
1615+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1616| volumeArray | O | 1..n | list of volume | list of volume |
1617+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1618| availabilityZone | O | 1 | string | Usable field |
1619+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1620| flavorId | M | 1 | String | server Flavor |
1621+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1622| metadata | O | 1 | List of metadata | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
1623+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1624| **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.** |
1625| | | | | |
1626| | | | | **[TBD]** |
1627+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1628| **serverGroup** | **O** | **1** | **string** | the ServerGroup for anti-affinity and affinity |
1629| | | | | |
1630| | | | | [TBD] |
1631+----------------------+-----------------+-------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1632
1633200: ok
1634
1635500: failed
1636
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]16378. **Flavor Management**
1638^^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1639
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]16408.1. **Create Flavor**
1641----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1642
1643+---------------------+--------------------------------------------------------------------------------+
1644| **IF Definition** | **Description** |
1645+=====================+================================================================================+
1646| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors |
1647+---------------------+--------------------------------------------------------------------------------+
1648| Operation | POST |
1649+---------------------+--------------------------------------------------------------------------------+
1650| Direction | VNFLCM->MULTIVIM |
1651+---------------------+--------------------------------------------------------------------------------+
1652
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]16538.1.1. **Request**
1654>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1655
1656+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1657| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1658+=================+=================+===================+===============================+==============================================================================================================================+
1659| name | M | 1 | string | Flavor Name |
1660+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1661| vcpu | M | 1 | int | Virtual CPU number |
1662+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1663| memory | M | 1 | int | Memory size |
1664+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1665| disk | M | 1 | int | The size of the root disk |
1666+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1667| ephemeral | O | 1 | int | The size of the ephemeral disk |
1668+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1669| swap | O | 1 | int | The size of the swap disk |
1670+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1671| 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. |
1672+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1673| extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1674+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1675
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]16768.1.2. **Response**
1677>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1678
1679+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1680| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1681+=================+=================+===================+===========================+==============================================================================================================================+
1682| id | M | 1 | string | Flavor id |
1683+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1684| name | M | 1 | string | Flavor name |
1685+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1686| returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1687+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1688| tenantId | M | 1 | String | Tenant UUID |
1689+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1690| vcpu | M | 1 | int | Virtual CPU number |
1691+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1692| memory | M | 1 | int | Memory size |
1693+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1694| disk | M | 1 | int | The size of the root disk |
1695+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1696| ephemeral | M | 1 | int | The size of the ephemeral disk |
1697+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1698| swap | M | 1 | int | The size of the swap disk |
1699+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1700| 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. |
1701+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1702| extraSpecs | O | 0..N | List of Key-value pairs | EPA parameter |
1703+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1704| vimId | M | 1 | String | vim id |
1705+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1706| vimName | O | 1 | string | vim name |
1707+-----------------+-----------------+-------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------+
1708
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]17098.2. **Delete Flavor**
1710----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1711
1712+---------------------+--------------------------------------------------------------------------------------------+
1713| **IF Definition** | **Description** |
1714+=====================+============================================================================================+
1715| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors /{flavorid} |
1716+---------------------+--------------------------------------------------------------------------------------------+
1717| Operation | DELETE |
1718+---------------------+--------------------------------------------------------------------------------------------+
1719| Direction | NFLCM,NSLCM->MULTIVIM |
1720+---------------------+--------------------------------------------------------------------------------------------+
1721
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]17228.2.1. **Request**
1723>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1724
1725N/A
1726
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]17278.2.2. **Response**
1728>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1729
1730204: no content
1731
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]17328.3. **List Flavor**
1733--------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1734
1735+---------------------+---------------------------------------------------------------------------------+
1736| **IF Definition** | **Description** |
1737+=====================+=================================================================================+
1738| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/ flavors |
1739+---------------------+---------------------------------------------------------------------------------+
1740| Operation | get |
1741+---------------------+---------------------------------------------------------------------------------+
1742| Direction | NFLCM,NSLCM->MULTIVIM |
1743+---------------------+---------------------------------------------------------------------------------+
1744
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]17458.3.1. **Query**
1746>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1747
1748+-----------------+-----------------+-------------------+---------------+----------------------------------+
1749| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1750+=================+=================+===================+===============+==================================+
1751| name | M | 1 | string | Flavor name to filter out list |
1752+-----------------+-----------------+-------------------+---------------+----------------------------------+
1753
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]17548.3.2. **Response**
1755>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1756
1757+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1758| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1759+=================+=================+===================+===============================+==============================================================================================================================+
1760| flavors | M | 0..N | list | Vm list |
1761+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1762| id | M | 1 | string | Flavor id |
1763+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1764| name | M | 1 | string | Flavor Name |
1765+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1766| vcpu | M | 1 | int | Virtual CPU number |
1767+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1768| memory | M | 1 | int | Memory size |
1769+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1770| disk | M | 1 | int | The size of the root disk |
1771+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1772| ephemeral | M | 1 | int | The size of the ephemeral disk |
1773+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1774| swap | M | 1 | int | The size of the swap disk |
1775+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1776| 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. |
1777+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1778| extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1779+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1780| vimId | M | 1 | String | vim id |
1781+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1782| vimName | O | 1 | string | vim name |
1783+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1784| tenantId | M | 1 | String | Tenant UUID |
1785+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1786
1787200: ok
1788
1789500: failed
1790
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]17918.4. **Get Flavor**
1792-------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1793
1794+---------------------+----------------------------------------------------------------------------------------------+
1795| **IF Definition** | **Description** |
1796+=====================+==============================================================================================+
1797| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/flavors/{ flavorsid } |
1798+---------------------+----------------------------------------------------------------------------------------------+
1799| Operation | get |
1800+---------------------+----------------------------------------------------------------------------------------------+
1801| Direction | NFLCM,NSLCM->MULTIVIM |
1802+---------------------+----------------------------------------------------------------------------------------------+
1803
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]18048.4.1. **Request**
1805>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1806
1807N/A
1808
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]18098.4.2. **Response**
1810>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1811
1812+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1813| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1814+=================+=================+===================+===============================+==============================================================================================================================+
1815| id | M | 1 | string | Flavor id |
1816+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1817| name | M | 1 | string | Flavor Name |
1818+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1819| vcpu | M | 1 | int | Virtual CPU number |
1820+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1821| memory | M | 1 | int | Memory size |
1822+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1823| disk | M | 1 | int | The size of the root disk |
1824+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1825| ephemeral | M | 1 | int | The size of the ephemeral disk |
1826+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1827| swap | M | 1 | int | The size of the swap disk |
1828+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1829| 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. |
1830+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1831| extraSpecs | O | 0..N | List of keyname-value pairs | EPA parameter |
1832+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1833| vimId | M | 1 | String | vim id |
1834+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1835| vimName | O | 1 | string | vim name |
1836+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1837| tenantId | M | 1 | String | Tenant UUID |
1838+-----------------+-----------------+-------------------+-------------------------------+------------------------------------------------------------------------------------------------------------------------------+
1839
1840200: ok
1841
1842500: failed
1843
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]18449. **Volume Management**
1845^^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1846
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]18479.1. **Create Volume**
1848----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1849
1850+---------------------+--------------------------------------------------------------------------------+
1851| **IF Definition** | **Description** |
1852+=====================+================================================================================+
1853| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
1854+---------------------+--------------------------------------------------------------------------------+
1855| Operation | POST |
1856+---------------------+--------------------------------------------------------------------------------+
1857| Direction | NSLCM->MULTIVIM |
1858+---------------------+--------------------------------------------------------------------------------+
1859
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]18609.1.1. **Request**
1861>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1862
1863+--------------------+-----------------+-------------------+---------------+-------------------+
1864| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1865+====================+=================+===================+===============+===================+
1866| name | M | 1 | string | Volume name |
1867+--------------------+-----------------+-------------------+---------------+-------------------+
1868| volumeSize | M | 1 | int | Volume size |
1869+--------------------+-----------------+-------------------+---------------+-------------------+
1870| imageId | O | 1 | string | Image UUID |
1871+--------------------+-----------------+-------------------+---------------+-------------------+
1872| volumeType | O | 1 | string | Volume type |
1873+--------------------+-----------------+-------------------+---------------+-------------------+
1874| availabilityZone | O | 1 | string | Usable field |
1875+--------------------+-----------------+-------------------+---------------+-------------------+
1876
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1877::
1878
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1879 {
1880
1881 "tenant": "tenant1",
1882
1883 "volumeName": "volume1",
1884
1885 "volumeSize": 3,
1886
1887 "imageName": "cirros.qcow2",
1888
1889 "volumeType": "volumetype1",
1890
1891 "availabilityZone": "zone1"
1892
1893 }
1894
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]18959.1.2. **Response**
1896>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1897
1898+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1899| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1900+====================+=================+===================+===============+=====================================+
1901| returnCode | M | 1 | int | 0: Already exist 1: Newly created |
1902+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1903| vimId | M | 1 | String | vim id |
1904+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1905| vimName | O | 1 | string | vim name |
1906+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1907| tenantId | M | 1 | String | Tenant UUID |
1908+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1909| status | M | 1 | string | Volume status |
1910+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1911| id | M | 1 | string | Volume id |
1912+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1913| name | M | 1 | string | Volume name |
1914+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1915| volumeType | O | 1 | string | Volume type |
1916+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1917| availabilityZone | O | 1 | string | Availability Zone |
1918+--------------------+-----------------+-------------------+---------------+-------------------------------------+
1919
1920202: accepted
1921
1922500: failed
1923
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]1924::
1925
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1926 {
1927
1928 "id": "bc9eebdbbfd356458269340b9ea6fb73",
1929
1930 "name": "volume1",
1931
1932 "returnCode": 1,
1933
1934 }
1935
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]19369.2. **Delete Volume**
1937----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1938
1939+---------------------+-------------------------------------------------------------------------------------------+
1940| **IF Definition** | **Description** |
1941+=====================+===========================================================================================+
1942| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeId} |
1943+---------------------+-------------------------------------------------------------------------------------------+
1944| Operation | DELETE |
1945+---------------------+-------------------------------------------------------------------------------------------+
1946| Direction | NSLCM->MULTIVIM |
1947+---------------------+-------------------------------------------------------------------------------------------+
1948
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]19499.2.1. **Request**
1950>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1951
1952 N/A
1953
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]19549.2.2. **Response**
1955>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1956
1957 204: no content
1958
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]19599.3. **List Volumes**
1960---------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1961
1962+---------------------+--------------------------------------------------------------------------------+
1963| **IF Definition** | **Description** |
1964+=====================+================================================================================+
1965| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes |
1966+---------------------+--------------------------------------------------------------------------------+
1967| Operation | GET |
1968+---------------------+--------------------------------------------------------------------------------+
1969| Direction | NSLCM-> MULTIVIM |
1970+---------------------+--------------------------------------------------------------------------------+
1971
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]19729.3.1. **Request**
1973>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1974
1975 msb.onap.org:80/api/multicloud/v0/{cloud
1976 owner}\_{region}/volumes?{……}
1977
1978+-----------------+-----------------+-------------------+---------------+-------------------+
1979| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1980+=================+=================+===================+===============+===================+
1981| name | M | 1 | string | Volume name |
1982+-----------------+-----------------+-------------------+---------------+-------------------+
1983
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]19849.3.2. **Response**
1985>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]1986
1987+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1988| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
1989+====================+=================+===================+======================+====================================================+
1990| vimId | M | 1 | String | vim id |
1991+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1992| vimName | O | 1 | string | vim name |
1993+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1994| tenantId | M | 1 | String | Tenant UUID |
1995+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1996| volumes | M | 1 | Array | |
1997+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
1998| id | M | 1 | string | Volume id |
1999+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2000| name | M | 1 | string | Volume name |
2001+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2002| createTime | O | 1 | string | Create time |
2003+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2004| status | M | 1 | string | Volume status |
2005+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2006| volumeSize | M | 1 | int | Volume size |
2007+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2008| volumeType | M | 1 | string | Volume type |
2009+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2010| availabilityZone | M | 1 | string | Availability Zone |
2011+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2012| attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2013+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2014
2015200: ok
2016
2017500: failed
2018
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2019::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2020
2021 {
2022
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2023 "volumes": [
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2024
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2025 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2026
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2027 "status": "available",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2028
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2029 "name": "test",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2030
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2031 "attachments": [],
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2032
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2033 "createTime": "2015-12-02T07:57:23.000000",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2034
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2035 " volumeType ": "ws",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2036
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2037 "id": "91b39ebb-acdc-43f3-9c2e-b0da7ad0fd55",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2038
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2039 "size": 20
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2040
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2041 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2042
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2043 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2044
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2045 "status": "in-use",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2046
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2047 "name": "wangsong",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2048
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2049 "attachments": [
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2050
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2051 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2052
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2053 "device": "/dev/vdc",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2054
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2055 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2056
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2057 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2058
2059 "hostName": null,
2060
2061 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2062
2063 }
2064
2065 ],
2066
2067 "createTime": "2015-12-02T06:39:40.000000",
2068
2069 " volumeType ": null,
2070
2071 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2072
2073 "size": 40
2074
2075 }
2076
2077 ]
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2078
2079 }
2080
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]20819.4. **Get Volumes**
2082--------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2083
2084+---------------------+-------------------------------------------------------------------------------------------+
2085| **IF Definition** | **Description** |
2086+=====================+===========================================================================================+
2087| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/volumes/{volumeid} |
2088+---------------------+-------------------------------------------------------------------------------------------+
2089| Operation | GET |
2090+---------------------+-------------------------------------------------------------------------------------------+
2091| Direction | NSLCM-> MULTIVIM |
2092+---------------------+-------------------------------------------------------------------------------------------+
2093
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]20949.4.1. **Request**
2095>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2096
2097 N/A
2098
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]20999.4.2. **Response**
2100>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2101
2102+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2103| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2104+====================+=================+===================+======================+====================================================+
2105| vimId | M | 1 | String | vim id |
2106+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2107| vimName | O | 1 | string | vim name |
2108+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2109| tenantId | M | 1 | String | Tenant UUID |
2110+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2111| id | | 1 | string | Volume id |
2112+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2113| name | | 1 | string | Volume name |
2114+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2115| createTime | | 1 | string | Create time |
2116+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2117| status | | 1 | string | Volume status |
2118+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2119| volumeType | | 1 | list of string | Volume type |
2120+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2121| volumeSize | | 1 | int | Volume size |
2122+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2123| availabilityZone | M | 1 | string | Availability Zone |
2124+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2125| attachments | M | 1..n | list of attachment | List of additional information on the cloud disk |
2126+--------------------+-----------------+-------------------+----------------------+----------------------------------------------------+
2127
2128**attachment：**
2129
2130+-----------------+-----------------+-------------------+---------------+-------------------+
2131| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2132+=================+=================+===================+===============+===================+
2133| device | | 1 | string | Device name |
2134+-----------------+-----------------+-------------------+---------------+-------------------+
2135| serverId | | 1 | string | VM id |
2136+-----------------+-----------------+-------------------+---------------+-------------------+
2137| volumeId | | 1 | string | Volume id |
2138+-----------------+-----------------+-------------------+---------------+-------------------+
2139| hostName | | 1 | string | Host name |
2140+-----------------+-----------------+-------------------+---------------+-------------------+
2141| id | | 1 | string | Device id |
2142+-----------------+-----------------+-------------------+---------------+-------------------+
2143
2144200: ok
2145
2146500: failed
2147
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2148::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2149
2150 {
2151
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2152 "status": "in-use",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2153
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2154 "name": "wangsong",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2155
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2156 "attachments": [
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2157
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2158 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2159
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2160 "device": "/dev/vdc",
2161
2162 "serverId": "3030e666-528e-4954-88f5-cc21dab1262b",
2163
2164 "volumeId": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2165
2166 "hostName": null,
2167
2168 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31"
2169
2170 }
2171
2172 ],
2173
2174 "createTime": "2015-12-02T06:39:40.000000",
2175
2176 "volumeType ": null,
2177
2178 "id": "4bd3e9eb-cd8b-456a-8589-910836a0ab31",
2179
2180 "volumeSize ": 40
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2181
2182 }
2183
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]218410. **Tenant Management**
2185^^^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2186
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]218710.1. **List tenants**
2188----------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2189
2190+---------------------+---------------------------------------------------------------------+
2191| **IF Definition** | **Description** |
2192+=====================+=====================================================================+
2193| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/tenants |
2194+---------------------+---------------------------------------------------------------------+
2195| Operation | GET |
2196+---------------------+---------------------------------------------------------------------+
2197| Direction | NSLCM-> MULTIVIM |
2198+---------------------+---------------------------------------------------------------------+
2199
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]220010.1.1. **Query**
2201>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2202
2203+---------------------+-----------------+-------------------+---------------+-------------------------------------+
2204| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2205+=====================+=================+===================+===============+=====================================+
2206| name={tenantname} | O | 1 | string | Tenant name to filter output list |
2207+---------------------+-----------------+-------------------+---------------+-------------------------------------+
2208
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]220910.1.2. **Response**
2210>>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2211
2212+-----------------+-----------------+-------------------+---------------+-------------------+
2213| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2214+=================+=================+===================+===============+===================+
2215| vimId | M | 1 | String | vim id |
2216+-----------------+-----------------+-------------------+---------------+-------------------+
2217| vimName | O | 1 | string | vim name |
2218+-----------------+-----------------+-------------------+---------------+-------------------+
2219| tenants | M | 1 | Array | |
2220+-----------------+-----------------+-------------------+---------------+-------------------+
2221| id | M | 1 | string | tenant UUID |
2222+-----------------+-----------------+-------------------+---------------+-------------------+
2223| name | M | 1 | string | tenant name |
2224+-----------------+-----------------+-------------------+---------------+-------------------+
2225
2226200: ok
2227
2228500: failed
2229
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2230::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2231
2232 {
2233
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2234 " tenants ": [
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2235
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2236 {
2237
2238 "id": "1",
2239
2240 "name": "test\_a"
2241
2242 }
2243
2244 ]
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2245
2246 }
2247
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]224811. **Limits**
2249^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2250
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]225111.1. **List Limits of resouces**
2252---------------------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2253
2254+---------------------+-------------------------------------------------------------------------------+
2255| **IF Definition** | **Description** |
2256+=====================+===============================================================================+
2257| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/limits |
2258+---------------------+-------------------------------------------------------------------------------+
2259| Operation | GET |
2260+---------------------+-------------------------------------------------------------------------------+
2261| Direction | NSLCM-> MULTIVIM |
2262+---------------------+-------------------------------------------------------------------------------+
2263
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]226411.1.1. **Request**
2265>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2266
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2267N/A
2268
226911.1.2. **Response**
2270>>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2271
2272+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2273| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2274+===========================+=================+===================+===============+==================================================================+
2275| vimId | M | 1 | String | vim id |
2276+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2277| vimName | O | 1 | string | vim name |
2278+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2279| tenantId | M | 1 | string | Tenant UUID |
2280+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2281| maxPersonality | O | 1 | int | The number of allowed injected files for each tenant. |
2282+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2283| maxPersonalitySize | O | 1 | int | The number of allowed bytes of content for each injected file. |
2284+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2285| maxServerGroupMembers | O | 1 | int | The number of allowed members for each server group. |
2286+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2287| maxServerGroups | O | 1 | int | The number of allowed server groups for each tenant. |
2288+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2289| maxServerMeta | O | 1 | int | The number of allowed metadata items for each instance. |
2290+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2291| maxTotalCores | O | 1 | int | The number of allowed instance cores for each tenant. |
2292+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2293| maxTotalInstances | O | 1 | int | The number of allowed instances for each tenant. |
2294+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2295| maxTotalKeypairs | O | 1 | int | The number of allowed key pairs for each user. |
2296+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2297| maxTotalRAMSize | O | 1 | int | The amount of allowed instance RAM, in MB, for each tenant. |
2298+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2299| maxTotalVolumeGigabytes | O | 1 | int | The maximum total amount of volumes, in gibibytes (GiB). |
2300+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2301| maxTotalVolumes | O | 1 | int | The maximum number of volumes. |
2302+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2303| totalVolumesUsed | O | 1 | int | The total number of volumes used. |
2304+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2305| totalGigabytesUsed | O | 1 | int | The total number of gibibytes (GiB) used. |
2306+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2307| network | O | 1 | int | The number of networks allowed for each project. |
2308+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2309| subnet | O | 1 | int | The number of subnets allowed for each project. |
2310+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2311| subnetpool | O | 1 | int | The number of subnet pools allowed for each project. |
2312+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2313| security\_group\_rule | O | 1 | int | The number of security group rules allowed for each project. |
2314+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2315| security\_group | O | 1 | int | The number of security groups allowed for each project. |
2316+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2317| router | O | 1 | int | The number of routers allowed for each project. |
2318+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2319| port | O | 1 | int | The number of ports allowed for each project. |
2320+---------------------------+-----------------+-------------------+---------------+------------------------------------------------------------------+
2321
2322200: ok
2323
2324500: failed
2325
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2326::
2327
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2328 {
2329
2330 "maxPersonality": 5,
2331
2332 "maxPersonalitySize": 10240,
2333
2334 "maxServerMeta": 128,
2335
2336 "maxTotalCores": 20,
2337
2338 "maxTotalInstances": 10,
2339
2340 "maxTotalKeypairs": 100,
2341
2342 "maxTotalRAMSize": 51200,
2343
2344 "maxServerGroups": 10,
2345
2346 "maxServerGroupMembers": 10,
2347
2348 }
2349
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]235012. **Host Management**
2351^^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2352
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]235312.1. **List hosts**
2354--------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2355
2356+---------------------+------------------------------------------------------------------------------+
2357| **IF Definition** | **Description** |
2358+=====================+==============================================================================+
2359| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}\_{region}/{tenantid}/hosts |
2360+---------------------+------------------------------------------------------------------------------+
2361| Operation | GET |
2362+---------------------+------------------------------------------------------------------------------+
2363| Direction | NSLCM-> MULTIVIM |
2364+---------------------+------------------------------------------------------------------------------+
2365
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]236612.1.1. **Request**
2367>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2368
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2369N/A
2370
237112.1.2. **Response**
2372>>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2373
2374+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2375| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2376+=================+=================+===================+=================+===================================+
2377| vimId | M | 1 | String | vim id |
2378+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2379| vimName | O | 1 | string | vim name |
2380+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2381| tenantId | M | 1 | string | Tenant Name |
2382+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2383| hosts | M | 1 | Array of host | List of host information |
2384+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2385| service | M | 1 | string | The service running on the host |
2386+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2387| name | M | 1 | string | host name |
2388+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2389| zone | O | 1 | string | Available zone for the host |
2390+-----------------+-----------------+-------------------+-----------------+-----------------------------------+
2391
2392200: ok
2393
2394500: failed
2395
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2396::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2397
2398 {
2399
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2400 "vimId": "123",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2401
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2402 "vimName": "vimName",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2403
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2404 "tenantId": "tenantId1"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2405
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2406 "hosts": [
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2407
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2408 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2409
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2410 "name": "b6e4adbc193d428ea923899d07fb001e",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2411
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2412 "service": "conductor",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2413
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2414 "zone": "internal",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2415
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2416 "vimId": "123",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2417
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2418 "vimName": "vimName",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2419
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2420 "tenantId": "tenantId1"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2421
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2422 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2423
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2424 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2425
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2426 "name": "09c025b0efc64211bd23fc50fa974cdf",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2427
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2428 "service": "compute",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2429
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2430 "zone": "nova"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2431
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2432 "vimId": "123",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2433
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2434 "vimName": "vimName",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2435
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2436 "tenantId": "tenantId1"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2437
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2438 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2439
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2440 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2441
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2442 "name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2443
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2444 "service": "consoleauth",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2445
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2446 "zone": "internal"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2447
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2448 "vimId": "123",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2449
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2450 "vimName": "vimName",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2451
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2452 "tenantId": "tenantId1"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2453
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2454 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2455
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2456 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2457
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2458 "host\_name": "396a8a0a234f476eb05fb9fbc5802ba7",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2459
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2460 "service": "network",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2461
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2462 "zone": "internal"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2463
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2464 "vimId": "123",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2465
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2466 "vimName": "vimName",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2467
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2468 "tenantId": "tenantId1"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2469
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2470 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2471
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2472 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2473
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2474 "name": "abffda96592c4eacaf4111c28fddee17",
2475
2476 "service": "scheduler",
2477
2478 "zone": "internal"
2479
2480 "vimId": "123",
2481
2482 "vimName": "vimName",
2483
2484 "tenantId": "tenantId1"
2485
2486 }
2487
2488 ]
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2489
2490 }
2491
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]249212.2. **Get host**
2493------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2494
2495+---------------------+-----------------------------------------------------------------------------------------+
2496| **IF Definition** | **Description** |
2497+=====================+=========================================================================================+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2498| URI | msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/{tenantid}/hosts/{hostname} |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2499+---------------------+-----------------------------------------------------------------------------------------+
2500| Operation | GET |
2501+---------------------+-----------------------------------------------------------------------------------------+
2502| Direction | NSLCM-> MULTIVIM |
2503+---------------------+-----------------------------------------------------------------------------------------+
2504
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]250512.2.1. **Request**
2506>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2507
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]250812.2.2. **Response**
2509>>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2510
2511+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2512| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2513+=================+=================+===================+=====================+==============================================================+
2514| vimId | M | 1 | String | vim id |
2515+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2516| vimName | O | 1 | string | vim name |
2517+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2518| tenantId | M | 1 | string | Tenant Name |
2519+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2520| host | M | 1 | List of resources | Host resource info |
2521+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2522| resource | M | 1..N | Object | Resource description |
2523+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2524| cpu | M | 1 | Int | The cpu info on the host. |
2525+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2526| memory_mb | M | 1 | int | The memory info on the host (in MB). |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2527+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2528| name | M | 1 | string | host name |
2529+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2530| project | M | 1 | string | Value: total, used_now, used_max or specific project_id |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2531+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2532| disk_gb | M | 1 | int | The disk info on the host (in GB). |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2533+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2534
2535200: ok
2536
2537500: failed
2538
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2539::
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2540
2541 {
2542
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2543 "cpu": 1,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2544
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2545 "disk\_gb": 1028,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2546
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2547 "name": "c1a7de0ac9d94e4baceae031d05caae3",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2548
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2549 "memory\_mb": 8192,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2550
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2551 "vimId": "123",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2552
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2553 "vimName": "vimName",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2554
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2555 "tenantId": "tenantId1",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2556
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2557 "host": [
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2558
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2559 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2560
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2561 "memory\_mb": 4960,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2562
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2563 "name": " c1a7de0ac9d94e4baceae031d05caae3",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2564
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2565 "disk\_gb": 92,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2566
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2567 "project": "(total)",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2568
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2569 "cpu": 4
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2570
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2571 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2572
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2573 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2574
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2575 "memory\_mb": 1536,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2576
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2577 "name": " c1a7de0ac9d94e4baceae031d05caae3",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2578
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2579 "disk\_gb": 2,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2580
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2581 "project": "(used\_now)",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2582
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2583 "cpu": 2
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2584
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2585 },
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2586
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2587 {
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2588
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2589 "memory\_mb": 1024,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2590
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2591 "name": " c1a7de0ac9d94e4baceae031d05caae3",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2592
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2593 "disk\_gb": 2,
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2594
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2595 "project": "(used\_max)",
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2596
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2597 "cpu": 2
2598
2599 },
2600
2601 {
2602
2603 "memory\_mb": 1024,
2604
2605 "name": " c1a7de0ac9d94e4baceae031d05caae3",
2606
2607 "disk\_gb": 2,
2608
2609 "project": "568f7ec425db472ba348251bf1e7eebd",
2610
2611 "cpu": 2
2612
2613 }
2614
2615 ],
2616
2617 "vimName": "openstack\_newton",
2618
2619 "vimId": "dd5b6da9-5984-401f-b89f-78a9776b1a73",
2620
2621 "tenantId": "568f7ec425db472ba348251bf1e7eebd"
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2622
2623 }
2624
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]262513. **VIM Management**
2626^^^^^^^^^^^^^^^^^^^^^^
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2627
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]262813.1. **Update VIM Info**
2629-------------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2630
2631+---------------------+----------------------------------------------------------------------------------------------+
2632| **IF Definition** | **Description** |
2633+=====================+==============================================================================================+
Ethan Lynn59362c42018-07-13 16:51:48 +0800[diff] [blame]2634| URI | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region}/registry |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2635+---------------------+----------------------------------------------------------------------------------------------+
2636| Operation | POST |
2637+---------------------+----------------------------------------------------------------------------------------------+
2638| Direction | ESR-> MULTICLOUD |
2639+---------------------+----------------------------------------------------------------------------------------------+
2640
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]264113.1.1. **Request**
2642>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2643
2644+-----------------+-----------------+-------------------+---------------+-----------------------+
2645| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2646+=================+=================+===================+===============+=======================+
2647| defaultTenant | M | 1 | string | default tenant name |
2648+-----------------+-----------------+-------------------+---------------+-----------------------+
2649
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]265013.1.2. **Response**
2651>>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2652
2653NA
2654
2655202: accept
2656
2657400: failed
2658
Haibin Huangfaa72672020-01-15 00:28:13 -0800[diff] [blame]265913.2. **Get registry status**
Bin Yang94e5ced2020-05-06 23:30:35 +0800[diff] [blame]2660------------------------------
Haibin Huangfaa72672020-01-15 00:28:13 -0800[diff] [blame]2661
2662+---------------------+----------------------------------------------------------------------------------------------+
2663| **IF Definition** | **Description** |
2664+=====================+==============================================================================================+
2665| URI | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region}/registry |
2666+---------------------+----------------------------------------------------------------------------------------------+
Bin Yang94e5ced2020-05-06 23:30:35 +0800[diff] [blame]2667| Operation | GET |
Haibin Huangfaa72672020-01-15 00:28:13 -0800[diff] [blame]2668+---------------------+----------------------------------------------------------------------------------------------+
2669| Direction | ESR-> MULTICLOUD |
2670+---------------------+----------------------------------------------------------------------------------------------+
2671
267213.2.1. **Request**
2673>>>>>>>>>>>>>>>>>>>
2674
2675NA
2676
267713.2.2. **Response**
2678>>>>>>>>>>>>>>>>>>>>
2679
2680NA
2681
2682200: OK
2683
2684404: failed
2685
2686500: failed
2687
268813.3. **Unregistry VIM**
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]2689------------------------
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2690
2691+---------------------+-----------------------------------------------------------------------------------------------+
2692| **IF Definition** | **Description** |
2693+=====================+===============================================================================================+
Ethan Lynn59362c42018-07-13 16:51:48 +0800[diff] [blame]2694| URI | http://msb.onap.org:80/api/multicloud/v0/{cloud-owner}_{cloud-region} |
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2695+---------------------+-----------------------------------------------------------------------------------------------+
2696| Operation | DELETE |
2697+---------------------+-----------------------------------------------------------------------------------------------+
2698| Direction | ESR-> MULTICLOUD |
2699+---------------------+-----------------------------------------------------------------------------------------------+
2700
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]270113.2.1. **Request**
2702>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2703
2704NA
2705
Ethan Lynnb3e79cc2018-06-05 17:26:55 +0800[diff] [blame]270613.2.2. **Response**
2707>>>>>>>>>>>>>>>>>>>>
xinhuilid04a2f72017-10-08 03:05:00 +0800[diff] [blame]2708
2709NA
2710
2711204: No content found
2712
2713400: failed
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2714
2715
2716
2717
271814. **Proxied OpenStack APIs**
2719^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2720
272114.1. **Tokens**
2722-------------------------
2723
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2724
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2725+---------------------+----------------------------------------------------------------------------------------------+
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2726| **IF Definition** | **Description** |
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2727+=====================+==============================================================================================+
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2728| URI | http://msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/identity/v3/auth/tokens |
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2729+---------------------+----------------------------------------------------------------------------------------------+
2730| Operation | POST |
2731+---------------------+----------------------------------------------------------------------------------------------+
2732| Direction | NSLCM-> MULTICLOUD |
2733+---------------------+----------------------------------------------------------------------------------------------+
2734
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2735
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]273614.1.1. **Request**
2737>>>>>>>>>>>>>>>>>>>
2738
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2739
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2740+-----------------+-----------------+-------------------+---------------+-----------------------+
2741| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
2742+=================+=================+===================+===============+=======================+
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2743| auth | O | 1 | Object | Same as OpenStack |
2744| | | | | Identity Tokens API |
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2745+-----------------+-----------------+-------------------+---------------+-----------------------+
2746
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2747
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2748::
2749
2750 {
2751
2752 }
2753
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2754
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]275514.1.2. **Response**
2756>>>>>>>>>>>>>>>>>>>>
2757
2758
2759+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2760| **Parameter** | **Qualifier** | **Cardinality** | **Content** | **Description** |
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2761+=================+=================+===================+=====================+==============================================================+
2762| X-Subject-Token | M | 1 | String | The authentication token in Header |
2763+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2764| token | O | 1 | Object | Token response, the same as OpenStack Identity Tokens API |
2765+-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
2766
Bin Yang392cfda2019-05-16 01:30:11 +0000[diff] [blame]2767
Bin Yangcd65ac52019-05-15 08:38:04 +0000[diff] [blame]2768201: Created
2769
2770401: Unauthorized
2771
2772403: Forbidden
2773
2774500: failed
2775
2776
2777::
2778
2779 Header:
2780 X-Subject-Token: a33f3b209e9b471a97fbeab8324a9a45
2781
2782 Body:
2783
2784 {
2785 "token" : {
2786 "user" : {
2787 "domain" : {
2788 "id" : "default",
2789 "name" : "Default"
2790 },
2791 "id" : "9efb043c7629497a8028d7325ca1afb0",
2792 "name" : "admin"
2793 },
2794 "catalog" : [
2795 {
2796 "type" : "network",
2797 "endpoints" : [
2798 {
2799 "interface" : "public",
2800 "id" : "39583c1508ad4b71b380570a745ee10a",
2801 "url" : "http://172.16.77.10:80/api/multicloud-titaniumcloud/v0/CloudOwner_RegionOne/network",
2802 "region_id" : "RegionOne",
2803 "region" : "RegionOne"
2804 }
2805 ],
2806 "name" : "neutron",
2807 "id" : "99aefcc82a9246f98f8c281e61ffc754"
2808 },
2809 ...
2810 ]
2811 "project" : {
2812 "name" : "admin",
2813 "id" : "fcca3cc49d5e42caae15459e27103efc",
2814 "domain" : {
2815 "id" : "default",
2816 "name" : "Default"
2817 }
2818 },
2819 "is_domain" : false,
2820 "expires_at" : "2017-09-11T03:52:29.000000Z"
2821 }
2822 }
2823