Gitiles
Code Review Sign In
gerrit.nordix.org / onap / vid / c139b01c500b2e860ae889d2879ebd69ec82b82a / . / docs / consumedapis.rst
blob: 4326aeec6b79ca39755702b380239ca5b4dabda2 [file] [log] [blame]
Ofir Sonsino49351d72017-10-24 10:18:23 +0300[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4Consumed APIs
5=============
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]6VID consumes the following APIs from other components:
Ofir Sonsino49351d72017-10-24 10:18:23 +0300[diff] [blame]7
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]8SDC
9----
Ofir Sonsino49351d72017-10-24 10:18:23 +0300[diff] [blame]10
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]11+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]12| /sdc/v1/catalog/services/meta | Get available services |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]13+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]14| /sdc/v1/catalog/services/toscaModel | Download CSAR by UUID |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]15+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
16
17SO
18---
19
20+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
21| POST /serviceInstances/v5 | Create instance |
22+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
23| DELETE | Delete instance |
24| /serviceInstances/v5/<instance-id> | |
25+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
26| POST | Create VNF |
27| /serviceInstances/v5/<service_instance_id>/vnfs | |
28+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
29| DELETE | Delete VNF |
30| /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_id> | |
31+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
32| POST | Create VF-Module |
33| /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules | |
34+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
35| DELETE | Delete VF-Module |
36| /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules | |
37+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
38| POST | Create Volume group |
39| /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups | |
40+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]41| DELETE | Delete Volume group |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]42| /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups | |
43+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
44| POST | Create configuration |
45| /serviceInstances/v5/<service_instance_id>/configurations/ | |
46+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
47| DELETE | Delete configuration |
48| serviceInstances/v5/<service_instance_id>/configurations/<configuration_id> | |
49+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
50| POST | Create network |
51| /serviceInstances/v5/<service_instance_id>/networks | |
52+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
53| DELETE | Delete network (network instance id) |
54| /serviceInstances/v5/<service_instance_id>/networks/<network_instance_id> | |
55+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
56| GET /orchestrationRequests/v5 | Get orchestration status |
57+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]58| GET /tasks/v1 | Get available manual tasks by request id |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]59+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino49351d72017-10-24 10:18:23 +0300[diff] [blame]60
61
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]62A&AI
63-----
64
65+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
66| GET | Get all subscribers |
67| aai/v11/business/customers?subscriber-type=INFRA&depth=2 | |
68+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]69| GET aai/v11/ | Get data for a specific subscriber including its available services |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]70| business/customers/customer/<global_customer_id> | |
71+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
72| GET | Get all service types |
73| aai/v11/service-design-and-creation/services | |
74+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]75| GET | Get services by owner entity id |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]76| aai/v11/business/owning-entities?<owning_entitiy_ids> | |
77+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
78| GET | Get services by project name |
79| aai/v11/business/projects?<project-names> | |
80+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
81| GET aai/v11/network/zones | Get all AIC zones |
82+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]83| POST search/named-query | Get data regarding an instance and the instance's related nodes |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]84+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]85| GET aai/v11/ | Get AIC zones for a specific service instance |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]86| business/customers/customer/<global_customer_id>/ | |
87| /service-subscriptions/service-subscription/<service_type>/service-instances/service-instance/<service_instance_id> | |
88+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]89| PUT Aai/v11/query?format=simple(types: | This is a custom query and has multiple types(declared in the url line)|
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]90| “query/vnfFromModelbyRegion?cloudRegionId”,” | |
91| vnf-topology-fromServiceInstance”) | |
92+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]93| Aai/v11/ | Get the human readable version by version id |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]94| service-design-and-creation/models?depth=2 | |
95+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
96| business/customers/customer/<global_customer_id>/service-subscriptions/service-subscription/<service_Subscription_Id>?depth=0 | Get all service subscriptions |
97+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
98| | |
99+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+