Gitiles
Code Review Sign In
gerrit.nordix.org / onap / so / 0d4d842149337527625cb95cd2f41c49a77ff9e6 / . / docs / SO_R1_Interface.rst
blob: ddac76b2f4bf4443c8555f6a0525c9858f1ed3a9 [file] [log] [blame]
seshukmcdcf19b2017-11-06 12:16:25 +0530[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright 2017 Huawei Technologies Co., Ltd.
4
seshukm30345e82017-11-16 19:04:51 +0530[diff] [blame]5SO Amsterdam Interfaces
seshukmcdcf19b2017-11-06 12:16:25 +0530[diff] [blame]6================
7
8.. image:: images/SO_R1_1.png
9
seshukm30345e82017-11-16 19:04:51 +0530[diff] [blame]10Service Orchestrator in Amsterdam release uses interfaces from both the MSO seed code and as well as new interfaces between the new components of ONAP.
seshukmcdcf19b2017-11-06 12:16:25 +0530[diff] [blame]11The below documentation of the SO APIs and are reviewed in the architecture committee meeting on 22/08/2017.
12
seshukm30345e82017-11-16 19:04:51 +0530[diff] [blame]13See :download:`SO_API_v0.1.2.pdf`
seshukmcdcf19b2017-11-06 12:16:25 +0530[diff] [blame]14
seshukm30345e82017-11-16 19:04:51 +0530[diff] [blame]15The interface between UUI and SO for the E2E VoLTE service:
seshukmcdcf19b2017-11-06 12:16:25 +0530[diff] [blame]16
seshukm30345e82017-11-16 19:04:51 +0530[diff] [blame]17See :download:`UUI-SO_API_Specification_v0.1.docx`
18
19The interface between Multi VIM and SO:
20
seshukm0d4d8422017-12-08 18:52:05 +0530[diff] [blame^]21See :download:`SO_MultiCloud.xlsx`
22
23SO APIs
24============
25
26UUI API
27----------------
28Create E2E service instance
29++++++++++++++++++++++++++++
30
31+--------------------+-------------------------------------+
32|Interface Definition|Description |
33+====================+=====================================+
34|URI |{serverRoot}/e2eServiceInstances/v3 |
35+--------------------+-------------------------------------+
36|Operation Type |POST |
37+--------------------+-------------------------------------+
38|Content-Type |multipart/form-data |
39+--------------------+-------------------------------------+
40
41Request Body:
42
43+---------+---------+-----------+--------------------------+-----------------------------+
44|Attribute|Qualifier|Cardinality|Content |Description |
45+=========+=========+===========+==========================+=============================+
46|service |M |1 |Service Object |Content of service object. |
47+---------+---------+-----------+--------------------------+-----------------------------+
48
49Service Object
50
51+----------------+------------------+-------------------------------------------------+
52|Attribute |Content |Description |
53+================+==================+=================================================+
54|name |String |Service instance name. |
55+----------------+------------------+-------------------------------------------------+
56|description |String |Service instance description |
57+----------------+------------------+-------------------------------------------------+
58|serviceDef ID |String |The service invariantUUID. It is defined in SDC. |
59+----------------+------------------+-------------------------------------------------+
60|templateId |String |The service Template UUID. It is defined in SDC. |
61+----------------+------------------+-------------------------------------------------+
62|parameters |Parameter Object |Parameter Object |
63+----------------+------------------+-------------------------------------------------+
64
65Parameter Object
66
67+----------------------+------------------+-----------------------------------------------------+
68|Attribute |Content |Description |
69+======================+==================+=====================================================+
70|globalSubscriberId |String |The subscriber id. It is defined in AAI |
71+----------------------+------------------+-----------------------------------------------------+
72|subscriberName |String |The subscriber name. It is defined in AAI |
73+----------------------+------------------+-----------------------------------------------------+
74|serviceType |String |The service type. It is defined in AAI |
75+----------------------+------------------+-----------------------------------------------------+
76|templateName |String |The service Template name |
77+----------------------+------------------+-----------------------------------------------------+
78|resources |Parameter Object |This field manages parameters of resources |
79+----------------------+------------------+-----------------------------------------------------+
80|resourceName |String |The resource name |
81+----------------------+------------------+-----------------------------------------------------+
82|resouceDefId |String |The resource invariantUUID. It is defined in SDC. |
83+----------------------+------------------+-----------------------------------------------------+
84|resourceId |String |The resource UUID. It is defined in SDC. |
85+----------------------+------------------+-----------------------------------------------------+
86|nsParameters |String |Parameters for current resource object. |
87+----------------------+------------------+-----------------------------------------------------+
88|locationConstraints |String |The DC location info for each VNF of current service |
89+----------------------+------------------+-----------------------------------------------------+
90|vnfProfileId |String |VNFD id |
91+----------------------+------------------+-----------------------------------------------------+
92|additionalParamForNs |String |The parameter for current resource |
93+----------------------+------------------+-----------------------------------------------------+
94
95
96Response:
97
98+-------------+---------+-----------+-------+------------------------------------------------------------------------+
99|Attribute |Qualifier|Cardinality|Content|Description |
100+-------------+---------+-----------+-------+------------------------------------------------------------------------+
101|serviceId |M |1 |String |Service instance ID. |
102+-------------+---------+-----------+-------+------------------------------------------------------------------------+
103|operationId |M |1 |String |Service Operation ID. |
104+-------------+---------+-----------+-------+------------------------------------------------------------------------+
105
106Delete E2E service instance
107++++++++++++++++++++++++++++
108
109+--------------------+-----------------------------------------------+
110|Interface Definition|Description |
111+====================+===============================================+
112|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
113+--------------------+-----------------------------------------------+
114|Operation Type |DELETE |
115+--------------------+-----------------------------------------------+
116
117Request Parameters:
118
119+-------------------+---------+-----------+-------+----------------------------------------+
120|Attribute |Qualifier|Cardinality|Content|Description |
121+===================+=========+===========+=======+========================================+
122|globalSubscriberId |M |1 |String |The subscriber id. It is defined in AAI |
123+-------------------+---------+-----------+-------+----------------------------------------+
124|serviceType |M |1 |String |The service type. It is defined in AAI |
125+-------------------+---------+-----------+-------+----------------------------------------+
126
127Response:
128
129+-------------+---------+-----------+-------+------------------------------------------------------------------------+
130|Attribute |Qualifier|Cardinality|Content|Description |
131+-------------+---------+-----------+-------+------------------------------------------------------------------------+
132|operationId |M |1 |String |The operation id. |
133+-------------+---------+-----------+-------+------------------------------------------------------------------------+
134
135Query E2E service operation result
136++++++++++++++++++++++++++
137
138+--------------------+------------------------------------------------------------------------+
139|Interface Definition|Description |
140+====================+========================================================================+
141|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
142+--------------------+------------------------------------------------------------------------+
143|Operation Type |GET |
144+--------------------+------------------------------------------------------------------------+
145
146Request Parameters:
147
148+--------------+---------+-----------+-------+--------------+
149|Attribute |Qualifier|Cardinality|Content|Description |
150+==============+=========+===========+=======+==============+
151|serviceId |M |1 |Service instance ID. |
152+--------------+---------+-----------+-------+--------------+
153|operationId |M |1 |Service Operation ID. |
154+--------------+---------+-----------+-------+--------------+
155
156Response:
157
158+------------------+---------+-----------+-------+------------------------------------------------------------------------+
159|Attribute |Qualifier|Cardinality|Content|Description |
160+------------------+---------+-----------+-------+------------------------------------------------------------------------+
161|operation |M |1 |String |Operation object identify. |
162+------------------+---------+-----------+-------+------------------------------------------------------------------------+
163|operationId |M |1 |String |Operation ID. |
164+------------------+---------+-----------+-------+------------------------------------------------------------------------+
165|operation |M |1 |String |Operation type, create|delete. |
166+------------------+---------+-----------+-------+------------------------------------------------------------------------+
167|result |M |1 |String |Operation result: finished, error, processing. |
168+------------------+---------+-----------+-------+------------------------------------------------------------------------+
169|reason |M |1 |String |If failing, need to write fail reason. |
170+------------------+---------+-----------+-------+------------------------------------------------------------------------+
171|userId |M |1 |String |Operation user ID. |
172+------------------+---------+-----------+-------+------------------------------------------------------------------------+
173|operationContent |M |1 |String |The status detail of current operation which is being executing. |
174+------------------+---------+-----------+-------+------------------------------------------------------------------------+
175|progress |M |1 |String |Current operation progress. |
176+------------------+---------+-----------+-------+------------------------------------------------------------------------+
177|operateAt |M |1 |String |Time that it starts to execute operation. |
178+------------------+---------+-----------+-------+------------------------------------------------------------------------+
179|finishedAt |M |1 |String |Time that it finished executing operation. |
180+------------------+---------+-----------+-------+------------------------------------------------------------------------+
181
182AAI API
183----------------
184
185create or update an existing service-instance
186+++++++++++++++++++++++++++++++++++++++++++++
187
188+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
189|Interface Definition|Description |
190+====================+====================================================================================================================================================================+
191|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
192+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
193|Operation Type |PUT |
194+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
195
196Request Parameters:
197
198+-------------------+---------+-----------+-------+-----------------------+
199|Attribute |Qualifier|Cardinality|Content|Description |
200+===================+=========+===========+=======+=======================+
201|global-customer-id |M |1 |String |Global Customer ID |
202+-------------------+---------+-----------+-------+-----------------------+
203|service-type |M |1 |String |Service Type |
204+-------------------+---------+-----------+-------+-----------------------+
205|service-instance-id|M |1 |String |Service Instance ID |
206+-------------------+---------+-----------+-------+-----------------------+
207
208Response:
209
210+---------+---------+-----------+-------+-------------------+
211|Attribute|Qualifier|Cardinality|Content|Description |
212+---------+---------+-----------+-------+-------------------+
213|HTTP code|M |1 |Integer|HTTP response code |
214+---------+---------+-----------+-------+-------------------+
215
216delete an existing service-instance
217+++++++++++++++++++++++++++++++++++
218
219+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
220|Interface Definition|Description |
221+====================+====================================================================================================================================================================+
222|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
223+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
224|Operation Type |DELETE |
225+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
226
227Request Parameters:
228
229+-------------------+---------+-----------+-------+-----------------------+
230|Attribute |Qualifier|Cardinality|Content|Description |
231+===================+=========+===========+=======+=======================+
232|global-customer-id |M |1 |String |Global Customer ID |
233+-------------------+---------+-----------+-------+-----------------------+
234|service-type |M |1 |String |Service Type |
235+-------------------+---------+-----------+-------+-----------------------+
236|service-instance-id|M |1 |String |Service Instance ID |
237+-------------------+---------+-----------+-------+-----------------------+
238
239Response:
240
241+---------+---------+-----------+-------+-------------------+
242|Attribute|Qualifier|Cardinality|Content|Description |
243+---------+---------+-----------+-------+-------------------+
244|HTTP code|M |1 |Integer|HTTP response code |
245+---------+---------+-----------+-------+-------------------+
246
247get service-instances
248+++++++++++++++++++++
249
250+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
251|Interface Definition|Description |
252+====================+=============================================================================================================================+
253|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
254+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
255|Operation Type |GET |
256+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
257
258Request Parameters:
259
260+-------------------+---------+-----------+-------+-----------------------+
261|Attribute |Qualifier|Cardinality|Content|Description |
262+===================+=========+===========+=======+=======================+
263|global-customer-id |M |1 |String |Global Customer ID |
264+-------------------+---------+-----------+-------+-----------------------+
265|service-type |M |1 |String |Service Type |
266+-------------------+---------+-----------+-------+-----------------------+
267
268Response:
269
270+-----------------+---------+-----------+----------------+-------------------+
271|Attribute |Qualifier|Cardinality|Content |Description |
272+-----------------+---------+-----------+----------------+-------------------+
273|service-instances|M |1 |ServiceInstances|Service Instances |
274+-----------------+---------+-----------+----------------+-------------------+
275
276get service-instance
277++++++++++++++++++++
278
279+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
280|Interface Definition|Description |
281+====================+====================================================================================================================================================================+
282|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
283+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
284|Operation Type |GET |
285+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
286
287Request Parameters:
288
289+-------------------+---------+-----------+-------+-----------------------+
290|Attribute |Qualifier|Cardinality|Content|Description |
291+===================+=========+===========+=======+=======================+
292|global-customer-id |M |1 |String |Global Customer ID |
293+-------------------+---------+-----------+-------+-----------------------+
294|service-type |M |1 |String |Service Type |
295+-------------------+---------+-----------+-------+-----------------------+
296|service-instance-id|M |1 |String |Service instance ID |
297+-------------------+---------+-----------+-------+-----------------------+
298
299Response:
300
301+-----------------+---------+-----------+----------------+-------------------+
302|Attribute |Qualifier|Cardinality|Content |Description |
303+-----------------+---------+-----------+----------------+-------------------+
304|service-instance |M |1 |ServiceInstance |Service Instance |
305+-----------------+---------+-----------+----------------+-------------------+
306
307see node definition for valid relationships
308+++++++++++++++++++++++++++++++++++++++++++
309
310+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
311|Interface Definition|Description |
312+====================+===================================================================================================================================================================================================+
313|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
314+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
315|Operation Type |PUT |
316+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
317
318Request Parameters:
319
320+-------------------+---------+-----------+-------+-----------------------+
321|Attribute |Qualifier|Cardinality|Content|Description |
322+===================+=========+===========+=======+=======================+
323|global-customer-id |M |1 |String |Global Customer ID |
324+-------------------+---------+-----------+-------+-----------------------+
325|service-type |M |1 |String |Service Type |
326+-------------------+---------+-----------+-------+-----------------------+
327|service-instance-id|M |1 |String |Service instance ID |
328+-------------------+---------+-----------+-------+-----------------------+
329
330Response:
331
332+---------+---------+-----------+-------+-------------------+
333|Attribute|Qualifier|Cardinality|Content|Description |
334+---------+---------+-----------+-------+-------------------+
335|HTTP code|M |1 |Integer|HTTP response code |
336+---------+---------+-----------+-------+-------------------+
337
338delete an existing relationship
339+++++++++++++++++++++++++++++++
340
341+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
342|Interface Definition|Description |
343+====================+===================================================================================================================================================================================================+
344|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
345+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
346|Operation Type |DELETE |
347+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
348
349Request Parameters:
350
351+-------------------+---------+-----------+-------+-----------------------+
352|Attribute |Qualifier|Cardinality|Content|Description |
353+===================+=========+===========+=======+=======================+
354|global-customer-id |M |1 |String |Global Customer ID |
355+-------------------+---------+-----------+-------+-----------------------+
356|service-type |M |1 |String |Service Type |
357+-------------------+---------+-----------+-------+-----------------------+
358|service-instance-id|M |1 |String |Service instance ID |
359+-------------------+---------+-----------+-------+-----------------------+
360
361Response:
362
363+---------+---------+-----------+-------+-------------------+
364|Attribute|Qualifier|Cardinality|Content|Description |
365+---------+---------+-----------+-------+-------------------+
366|HTTP code|M |1 |Integer|HTTP response code |
367+---------+---------+-----------+-------+-------------------+