summaryrefslogtreecommitdiffstats
path: root/docs/platform/consumedapis.rst
blob: 24dce36bb6ce1dd7885cf0a6fc77b485717e2ee4 (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
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

Consumed APIs
-------------

In the Amsterdam release, Holmes does not consume any APIs provided by other ONAP components.

A&AI
^^^^

ESR stored external system data to A&AI. EMS/VNFM/Third-party SDNC operation API included in external system namespace. VIM operation API included in CloudInfrastructure namespace.

#. VIM management API:

   ``PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}``
   
   ``GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}``

   ``GET /cloud-infrastructure/cloud-regions``
   
   ``DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}``
   
#. VNFM management API:

   ``PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}``
   
   ``GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}``

   ``GET /external-system/esr-vnfm-list``
   
   ``DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}``
   
#. EMS management API:

   ``PUT /external-system/esr-ems-list/esr-ems/{ems-id}``
   
   ``GET /external-system/esr-ems-list/esr-ems/{ems-id}``

   ``GET /external-system/esr-ems-list``
   
   ``DELETE /external-system/esr-ems-list/esr-ems/{ems-id}``
   
#. Thirdparty SDNC management API:

   ``PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}``
   
   ``GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}``

   ``GET /external-system/esr-thirdparty-sdnc-list``
   
   ``DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}``   

More details could be found at `A&AI APIs <https://wiki.onap.org/pages/viewpage.action?pageId=13598793>`_. 
   
Multi-Cloud
^^^^^^^^^^^

ESR will call the API from Multi-Cloud to update the cloud-region information after put the VIM data to A&AI.

#. Update VIM Info:

   ``POST /api/multicloud /v1/{cloud-owner}/{cloud-region}/registry``

More details could be found at `Multi-Cloud APIs <https://wiki.onap.org/download/attachments/13599038/MultiVIM-onap-draft-r1-0822.doc?version=1&modificationDate=1503406573000&api=v2>`_.
   
MSB
^^^

Both esr-server and esr-gui need to registered to MSB.

Service Registration: ``/api/microservices/v1/services``

More details could be found at `MSB APIs <https://wiki.onap.org/display/DW/Microservice+Bus+API+Documentation>`_.