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
|
.. 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:: http
{
"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 |
+-----------+---------------------------------------------------------------------+
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 |
+-----------+---------------------------------------------------------------------+
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 |
+-----------+---------------------------------------------------------------------+
|
