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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2022 Nordix Foundation
API
===
GET /healthcheck
---------------------------------------------------
Description
~~~~~~~~~~~
This is the health check endpoint. If this returns a 200, the server is alive.
Responses
~~~~~~~~~
+-----------+--------------------------+
| HTTP Code | Description |
+===========+==========================+
| **200** | Successful response |
+-----------+--------------------------+
| **503** | Service unavailable |
+-----------+--------------------------+
POST /subscription
--------------------------------------------------
Description
~~~~~~~~~~~
Create a PM Subscription
Responses
~~~~~~~~~
+-----------+--------------------------------------+
| HTTP Code | Description |
+===========+======================================+
| **201** | Successfully created PM Subscription |
+-----------+--------------------------------------+
| **400** | Invalid Input |
+-----------+--------------------------------------+
| **409** | Duplicate Data |
+-----------+--------------------------------------+
Sample Subscription Body
~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: json
{
"subscription": {
"subscriptionName": "new_sub",
"policyName": "pmsh_policy",
"nfFilter": {
"nfNames": [
"^pnf.*",
"^vnf.*"
],
"modelInvariantIDs": [
],
"modelVersionIDs": [
],
"modelNames": []
},
"measurementGroups": [{
"measurementGroup": {
"measurementGroupName": "msr_grp_name",
"fileBasedGP": 15,
"fileLocation": "\/pm\/pm.xml",
"administrativeState": "UNLOCKED",
"measurementTypes": [{
"measurementType": "counter_a"
}],
"managedObjectDNsBasic": [{
"DN": "string"
}]
}
}]
}
}
GET /subscription
--------------------------------------------------
Description
~~~~~~~~~~~
Get all the subscriptions from PMSH
Responses
~~~~~~~~~
+-----------+----------------------------------------+
| HTTP Code | Description |
+===========+========================================+
| **200** | Successfully fetched all subscriptions |
+-----------+----------------------------------------+
| **500** | Exception occured when querying DB |
+-----------+----------------------------------------+
GET /subscription/{subscription_name}
---------------------------------------------------
Description
~~~~~~~~~~~
Get the Subscription from PMSH specified by Name
Responses
~~~~~~~~~
+-----------+--------------------------------------------+
| HTTP Code | Description |
+===========+============================================+
| **200** | OK; Requested Subscription was returned |
+-----------+--------------------------------------------+
| **404** | Subscription with specified name not found |
+-----------+--------------------------------------------+
| **500** | Exception occurred while querying database |
+-----------+--------------------------------------------+
DELETE /subscription/{subscription_name}
---------------------------------------------------
Description
~~~~~~~~~~~
Deletes the Subscription from PMSH specified by Name
Responses
~~~~~~~~~
+-----------+---------------------------------------------------------------------+
| HTTP Code | Description |
+===========+=====================================================================+
| **204** | Successfully deleted the subscription and returns NO Content |
+-----------+---------------------------------------------------------------------+
| **404** | Subscription with specified name not found |
+-----------+---------------------------------------------------------------------+
| **409** | Subscription could not be deleted as it contains measurement groups |
| | with state UNLOCKED OR state change to LOCKED was under process |
+-----------+---------------------------------------------------------------------+
| **500** | Exception occurred on the server |
+-----------+---------------------------------------------------------------------+
PUT /subscription/{subscription_name}/nfFilter
----------------------------------------------
Description
~~~~~~~~~~~
Update a Subscription nf filter
Sample NF Filter Body
~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: json
{
"nfFilter": {
"nfNames": [
"^pnf.*",
"^vnf.*"
],
"modelInvariantIDs": [
],
"modelVersionIDs": [
],
"modelNames": [
]
}
}
Responses
~~~~~~~~~
+-----------+---------------------------------------------------------------------+
| HTTP Code | Description |
+===========+=====================================================================+
| **201** | Successfully updated nf filter |
+-----------+---------------------------------------------------------------------+
| **400** | Invalid input |
+-----------+---------------------------------------------------------------------+
| **409** | Conflicting data |
+-----------+---------------------------------------------------------------------+
| **500** | Exception occurred while querying database |
+-----------+---------------------------------------------------------------------+
POST /subscription/{subscription_name}/measurementGroups/{measurement_group_name}
----------------------------------------------------------------------------------
Description
~~~~~~~~~~~
Create a measurement group for a given subscription
Sample Measurement Group Body
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: json
{
"measurementGroup": {
"measurementGroupName": "msg_grp_03",
"fileBasedGP":15,
"fileLocation":"pm.xml",
"administrativeState": "UNLOCKED",
"measurementTypes": [
{
"measurementType": "counter_a"
}
],
"managedObjectDNsBasic": [
{
"DN": "string"
}
]
}
}
Responses
~~~~~~~~~
+-----------+---------------------------------------------------------------------+
| HTTP Code | Description |
+===========+=====================================================================+
| **201** | Successfully created measurement group |
+-----------+---------------------------------------------------------------------+
| **404** | Subscription with the specified name not found |
+-----------+---------------------------------------------------------------------+
| **409** | Duplicate data |
+-----------+---------------------------------------------------------------------+
| **500** | Internal server error |
+-----------+---------------------------------------------------------------------+
GET /subscription/{subscription_name}/measurementGroups/{measurement_group_name}
----------------------------------------------------------------------------------
Description
~~~~~~~~~~~
Get the measurement group and associated network functions from PMSH by using sub name and meas group name
Responses
~~~~~~~~~
+-----------+---------------------------------------------------------------------+
| HTTP Code | Description |
+===========+=====================================================================+
| **200** | OK; Received requested measurement group with associated NF's |
+-----------+---------------------------------------------------------------------+
| **404** | Measurement group with specified name not found |
+-----------+---------------------------------------------------------------------+
| **500** | Exception occurred on the server |
+-----------+---------------------------------------------------------------------+
DELETE /subscription/{subscription_name}/measurementGroups/{measurement_group_name}
------------------------------------------------------------------------------------
Description
~~~~~~~~~~~
Delete a measurement group
Responses
~~~~~~~~~
+-----------+--------------------------------------------------------------------------------------------------+
| HTTP Code | Description |
+===========+==================================================================================================+
| **204** | Successfully deleted the measurement group and returns NO Content |
+-----------+--------------------------------------------------------------------------------------------------+
| **404** | Measurement group with the specified name not found |
+-----------+--------------------------------------------------------------------------------------------------+
| **409** | Measurement group not deleted because state UNLOCKED OR state change to LOCKED was under process |
+-----------+--------------------------------------------------------------------------------------------------+
| **500** | Exception occurred on the server |
+-----------+--------------------------------------------------------------------------------------------------+
PUT /subscription/{subscription_name}/measurementGroups/{measurement_group_name}/{administrativeState}
-------------------------------------------------------------------------------------------------------
Description
~~~~~~~~~~~
Update administrative state for a measurement group
Responses
~~~~~~~~~
+-----------+---------------------------------------------------------------------+
| HTTP Code | Description |
+===========+=====================================================================+
| **201** | Successfully updated administrative state |
+-----------+---------------------------------------------------------------------+
| **409** | Duplicate data |
+-----------+---------------------------------------------------------------------+
| **500** | Invalid input |
+-----------+---------------------------------------------------------------------+
|
