summaryrefslogtreecommitdiffstats
path: root/docs/platform/consumedapis.rst
blob: 46b2cde0c67f51504e28e73816d0bf1d74c649af (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
.. 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, Usecase-UI mainly depends on the APIs provided by VF-C, SDC, A&AI, SO, DMaaP and MSB.

VF-C
^^^^

#. Distribute Network Service package:

   ``POST  /api/catalog/v1/nspackages``

#. Distribute VF resource:

   ``POST /api/catalog/v1/vnfpackages``

#. Query operation progress for distributing network service/vf resource:

   ``GET  /api/nslcm/v1/jobs/{jobId}``

#. Delete Network Service package:

   ``DELETE  /api/catalog/v1/nspackages/{csarId}``

#. Delete VF resource:

   ``DELETE /api/catalog/v1/vnfpackages/{csarId}``


SDC
^^^^

#. Query all distributed End to End Service:

   ``GET /sdc/v1/catalog/services``

#. Query specified service:

   ``GET  /sdc/v1/catalog/services/{uuid}/metadata``

#. Query VF resource:

   ``GET /sdc/v1/catalog/resources``

#. Download csar file:

   ``GET /sdc/v1/catalog/services/{uuid}/toscaModel``


A&AI
^^^^

#. Query all customers:

   ``/aai/v11/business/customers``

#. Query all service types for the specified customer:

   ``/aai/v11/business/customers/customer/{global-customer-id}/service-subscriptions``

#. Query all service instances:

   ``/aai/v11/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances``

#. Query all cloud regions:

   ``/aai/v11/cloud-infrastructure/cloud-regions``

#. Query all sdnc controllers:

   ``/aai/v11/external-system/esr-thirdparty-sdnc-list``


SO
^^^^

#. Instantiate service instance:

   ``POST /ecomp/mso/infra/e2eServiceInstances/v3``

#. Query operation progress for service instantiation/termination:

   ``GET /ecomp/mso/infra/e2eServiceInstances/v3/{serviceId}/operations/{operationId}``

#. Terminate service instance:

   ``DELETE /ecomp/mso/infra/e2eServiceInstances/v3/{serviceId}``


DMaaP
^^^^^

#. Subscribing:

   ``/events/{topic}/{consumergroup}/{consumerid}``


MSB
^^^

#. Service Registration:

   ``/api/microservices/v1/services``