aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api/apis/ManagedObject3gppServiceInstances.rst
blob: 1d3336a2d14173e1bcdf495dac401d34f86db0d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2023 DTAG

ManagedObject3gppServiceInstances API
=====================================

Create a ManagedObject3gppServiceInstances
++++++++++++++++++++++++++++++++++++++++++

+--------------------+------------------------------------------------------------+
|Interface Definition|Description                                                 |
+====================+============================================================+
|URI                 |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID     |
+--------------------+------------------------------------------------------------+
|Operation Type      |PUT                                                         |
+--------------------+------------------------------------------------------------+
|Content-Type        |application/json                                            |
+--------------------+------------------------------------------------------------+

Request Body:

+-----------------------------------+---------+-----------+--------------+---------------------------------------+
|Attribute                          |Qualifier|Cardinality|Content       |Description                            |
+===================================+=========+===========+==============+=======================================+
|ManagedObject3gppServiceInstances  |M        |1          |allocateMOI   |Content of allocate3gppMOI object      |
+-----------------------------------+---------+-----------+--------------+---------------------------------------+

ManagedObject3gppServiceInstances Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|attributes                    |List             |List of Slice Profile Attribute                                    |
+------------------------------+-----------------+-------------------------------------------------------------------+


SliceProfileList Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|plmnInfoList                  |List             |Contains plmnInfoList                                              |
+------------------------------+-----------------+-------------------------------------------------------------------+
|RANSliceSubnetProfile         |Object           |Contains RAN Attributes Object                                     |
+------------------------------+-----------------+-------------------------------------------------------------------+


plmnInfoList Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|plmnId                        |Object           |Contains plmnData                                                  |
+------------------------------+-----------------+-------------------------------------------------------------------+
|snssai                        |Object           |Contains snssai data                                               |
+------------------------------+-----------------+-------------------------------------------------------------------+

plmnId Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|mcc                           |integer          |Contains mcc value                                                 |
+------------------------------+-----------------+-------------------------------------------------------------------+
|mnc                           |integer          |Contains mcc value                                                 |
+------------------------------+-----------------+-------------------------------------------------------------------+

snssai Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|sst                           |string           |Contains sst                                                       |
+------------------------------+-----------------+-------------------------------------------------------------------+
|sd                            |string           |Contains sd                                                        |
+------------------------------+-----------------+-------------------------------------------------------------------+

RAN Attribute Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|coverageAreaTAList            |integer          |Contains coverageAreaTAList                                        |
+------------------------------+-----------------+-------------------------------------------------------------------+
|latency                       |integer          |desired latency of slice                                           |
+------------------------------+-----------------+-------------------------------------------------------------------+
|areaTrafficCapDL              |integer          |Contains areaTrafficCapDL                                          |
+------------------------------+-----------------+-------------------------------------------------------------------+
|resourceSharingLevel          |string           |describes slice sharing level                                      |
+------------------------------+-----------------+-------------------------------------------------------------------+
|serviceType                   |string           |describes serviceType                                              |
+------------------------------+-----------------+-------------------------------------------------------------------+
|maxNumberofUEs                |integer          |describes maxNumberofUEs                                           |
+------------------------------+-----------------+-------------------------------------------------------------------+


Response:

+-------------------------+---------+-----------+-----------------+-------------------------------------------+
|Attribute                |Qualifier|Cardinality|Content          |Description                                |
+=========================+=========+===========+=================+===========================================+
|requestReferences        |M        |1          |Response Object  |Content of Response object.                |
+----------------+--------+---------+-----------+-----------------+-------------------------------------------+

Response Object

+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content                   |Description                                |
+===================+=========+===========+==========================+===========================================+
|requestId          |M        |1          |String                    |Request Id.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|instanceId         |M        |1          |requestStatus Object      |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+



Terminate/Deallocate a MOI
++++++++++++++++++++++++++

+--------------------+------------------------------------------------------------+
|Interface Definition|Description                                                 |
+====================+============================================================+
|URI                 |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID     |
+--------------------+------------------------------------------------------------+
|Operation Type      |DELETE                                                      |
+--------------------+------------------------------------------------------------+
|Content-Type        |application/json                                            |
+--------------------+------------------------------------------------------------+


Request Body:

+-----------------------------------+---------+-----------+--------------+---------------------------------------+
|Attribute                          |Qualifier|Cardinality|Content       |Description                            |
+===================================+=========+===========+==============+=======================================+
|ManagedObject3gppServiceInstances  |M        |1          |deleteMOI     |Content of deleteMOI object            |
+-----------------------------------+---------+-----------+--------------+---------------------------------------+

ManagedObject3gppServiceInstances Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|attributes                    |List             |List of Slice Profile Attribute                                    |
+------------------------------+-----------------+-------------------------------------------------------------------+


SliceProfileList Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|sliceProfileId                |string           |slice profile id to be deleted                                     |
+------------------------------+-----------------+-------------------------------------------------------------------+


Response

+-------------------------+---------+-----------+-----------------+-------------------------------------------+
|Attribute                |Qualifier|Cardinality|Content          |Description                                |
+=========================+=========+===========+=================+===========================================+
|requestReferences        |M        |1          |Response Object  |Content of Response object.                |
+-------------------------+---------+-----------+-----------------+-------------------------------------------+

Response Object

+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content                   |Description                                |
+===================+=========+===========+==========================+===========================================+
|requestId          |M        |1          |String                    |Request Id.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|instanceId         |M        |1          |requestStatus Object      |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+




Modify a 3GPP service instance
++++++++++++++++++++++++++++++
+--------------------+------------------------------------------------------------+
|Interface Definition|Description                                                 |
+====================+============================================================+
|URI                 |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID     |
+--------------------+------------------------------------------------------------+
|Operation Type      |PATCH                                                       |
+--------------------+------------------------------------------------------------+
|Content-Type        |application/json                                            |
+--------------------+------------------------------------------------------------+


Request Body:

+-----------------------------------+---------+-----------+--------------+---------------------------------------+
|Attribute                          |Qualifier|Cardinality|Content       |Description                            |
+===================================+=========+===========+==============+=======================================+
|ManagedObject3gppServiceInstances  |M        |1          |modifyMOI     |Content of modifyMOI object            |
+-----------------------------------+---------+-----------+--------------+---------------------------------------+


ManagedObject3gppServiceInstances Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|attributes                    |List             |List of Slice Profile Attribute                                    |
+------------------------------+-----------------+-------------------------------------------------------------------+


SliceProfileList Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|sliceProfileId                |string           |slice profile id to be modify                                      |
+------------------------------+-----------------+-------------------------------------------------------------------+
|RANSliceSubnetProfile         |Object           |Contains RAN Attributes Object                                     |
+------------------------------+-----------------+-------------------------------------------------------------------+


RAN Attribute Object

+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute                     |Content          |Description                                                        |
+==============================+=================+===================================================================+
|coverageAreaTAList            |integer          |Contains coverageAreaTAList                                        |
+------------------------------+-----------------+-------------------------------------------------------------------+
|latency                       |integer          |desired latency of slice                                           |
+------------------------------+-----------------+-------------------------------------------------------------------+
|areaTrafficCapDL              |integer          |Contains areaTrafficCapDL                                          |
+------------------------------+-----------------+-------------------------------------------------------------------+
|resourceSharingLevel          |string           |describes slice sharing level                                      |
+------------------------------+-----------------+-------------------------------------------------------------------+
|serviceType                   |string           |describes serviceType                                              |
+------------------------------+-----------------+-------------------------------------------------------------------+
|maxNumberofUEs                |integer          |describes maxNumberofUEs                                           |
+------------------------------+-----------------+-------------------------------------------------------------------+


Response:

+-------------------------+---------+-----------+-----------------+-------------------------------------------+
|Attribute                |Qualifier|Cardinality|Content          |Description                                |
+=========================+=========+===========+=================+===========================================+
|requestReferences        |M        |1          |Response Object  |Content of Response object.                |
+-------------------------+---------+-----------+-----------------+-------------------------------------------+

Response Object

+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content                   |Description                                |
+===================+=========+===========+==========================+===========================================+
|requestId          |M        |1          |String                    |Request Id.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|instanceId         |M        |1          |requestStatus Object      |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+