Gitiles
Code Review Sign In
gerrit.nordix.org / onap / vid / b9d6126601120aabf2d43e2e951915c0eed370ce / . / docs / consumedapis.rst
blob: e9c219a7079934ee07370991298ad44aa73d9dbe [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+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]21| POST /e2eServiceInstances/v3 | Create E2E instance |
22+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
23| POST /serviceInstances/v6 | Create instance |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]24+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
25| DELETE | Delete instance |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]26| /serviceInstances/v6/<instance-id> | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]27+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
28| POST | Create VNF |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]29| /serviceInstances/v6/<service_instance_id>/vnfs | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]30+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
31| DELETE | Delete VNF |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]32| /serviceInstances/v6/<service_instance_id>/vnfs/<vnf_id> | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]33+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
34| POST | Create VF-Module |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]35| /serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]36+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
37| DELETE | Delete VF-Module |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]38| /serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]39+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
40| POST | Create Volume group |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]41| /serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]42+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]43| DELETE | Delete Volume group |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]44| /serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]45+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
46| POST | Create configuration |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]47| /serviceInstances/v6/<service_instance_id>/configurations/ | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]48+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
49| DELETE | Delete configuration |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]50| serviceInstances/v6/<service_instance_id>/configurations/<configuration_id> | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]51+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
52| POST | Create network |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]53| /serviceInstances/v6/<service_instance_id>/networks | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]54+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
55| DELETE | Delete network (network instance id) |
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]56| /serviceInstances/v6/<service_instance_id>/networks/<network_instance_id> | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]57+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Sonsino, Ofir (os0695)e45452e2018-05-09 13:56:55 +0300[diff] [blame]58| GET /orchestrationRequests/v6 | Get orchestration status |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]59+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]60| GET /tasks/v1 | Get available manual tasks by request id |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]61+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino49351d72017-10-24 10:18:23 +0300[diff] [blame]62
63
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]64A&AI
65-----
66
67+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
68| GET | Get all subscribers |
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]69| aai/v16/business/customers?subscriber-type=INFRA&depth=2 | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]70+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]71| GET aai/v16/ | Get data for a specific subscriber including its available services |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]72| business/customers/customer/<global_customer_id> | |
73+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
74| GET | Get all service types |
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]75| aai/v16/service-design-and-creation/services | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]76+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]77| GET | Get services by owner entity id |
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]78| aai/v16/business/owning-entities?<owning_entitiy_ids> | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]79+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
80| GET | Get services by project name |
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]81| aai/v16/business/projects?<project-names> | |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]82+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]83| GET aai/v16/network/zones | Get all AIC zones |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]84+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]85| 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]86+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]87| GET aai/v16/ | Get AIC zones for a specific service instance |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]88| business/customers/customer/<global_customer_id>/ | |
89| /service-subscriptions/service-subscription/<service_type>/service-instances/service-instance/<service_instance_id> | |
90+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]91| PUT aai/v16/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]92| “query/vnfFromModelbyRegion?cloudRegionId”,” | |
93| vnf-topology-fromServiceInstance”) | |
94+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
Ittay Stern03658e92020-03-04 12:20:33 +0200[diff] [blame]95| aai/v16/ | Get the human readable version by version id |
Ofir Sonsino1954d182017-10-30 11:25:19 +0200[diff] [blame]96| service-design-and-creation/models?depth=2 | |
97+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
98| business/customers/customer/<global_customer_id>/service-subscriptions/service-subscription/<service_Subscription_Id>?depth=0 | Get all service subscriptions |
99+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+