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
|
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
========================
PM Subscription Handler
========================
.. contents::
:depth: 3
Overview
========
Component description can be found under `PM Subscription Handler`_.
.. _PM Subscription Handler: ../../sections/services/pm-subscription-handler/index.html
.. csv-table::
:header: "API name", "Swagger JSON", "Swagger YAML"
:widths: 10,5,5
"PM Subscription Handler Service", ":download:`link <pmsh_swagger.json>`", ":download:`link <pmsh_swagger.yaml>`"
Paths
=====
GET ``/subscriptions``
----------------------
Description
~~~~~~~~~~~
Retrieves all defined Subscriptions and their related Network Functions from ONAP.
Responses
~~~~~~~~~
**200**
^^^^^^^
The Subscription details are returned successfully
**Example:**
.. code-block:: javascript
[
{
"network_functions": [
{
"nf_name": "pnf102",
"nf_sub_status": "PENDING_CREATE",
"orchestration_status": "Active"
},
{
"nf_name": "vnf101",
"nf_sub_status": "CREATED",
"orchestration_status": "Active"
}
],
"subscription_name": "demo-subscription",
"subscription_status": "UNLOCKED"
}
]
The subscription_status refers to the administrative status of the subscription.
.. csv-table:: Potential Values
:header: "Status", "Description"
:widths: 2,4
LOCKED, The Subscription is un-deploying / inactive.
UNLOCKED, The Subscription is deployed / active.
The network_functions.orchestration_status refers to the status of the xNF in AAI ONAP.
.. csv-table:: Potential Values
:header: "Status", "Description"
:widths: 4,18
Inventoried, The xNF has been on-boarded in ONAP but not yet operable.
Active, The xNF is active and contactable.
The network_functions.nf_sub_status refers to the status of the subscription (PM Job) on the xNF.
.. csv-table:: Potential Values
:header: "Status", "Description"
:widths: 5,16
PENDING_CREATE, Create event published to Policy topic. Awaiting response.
CREATE_FAILED, Subscription failed to be created on the xNF.
CREATED, Subscription created successfully on the xNF.
PENDING_DELETE, Delete event published to Poilcy topic. Awaiting response.
DELETE_FAILED, Subscription deletion failed to be applied on the xNF.
GET ``/healthcheck``
--------------------
Description
~~~~~~~~~~~
This is the health check endpoint. If this returns a 200, the server is alive.
If anything other than a 200, the server is either dead or no connection to PMSH.
Responses
~~~~~~~~~
**200**
^^^^^^^
The PMSH instance is running
|
