docs/consumedapis.rst

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