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 /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 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  41 | DELETE                                                                                                                        | Delete Volume group                                                    |
  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 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  58 | GET /tasks/v1                                                                                                                 | Get available manual tasks by request id                               |
  59 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  60
  61
  62 A&AI
  63 -----
  64
  65 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  66 | GET                                                                                                                           | Get all subscribers                                                    |
  67 |   aai/v11/business/customers?subscriber-type=INFRA&depth=2                                                                    |                                                                        |
  68 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  69 | GET aai/v11/                                                                                                                  | Get data for a specific subscriber including its available services    |
  70 |   business/customers/customer/<global_customer_id>                                                                            |                                                                        |
  71 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  72 | GET                                                                                                                           | Get all service types                                                  |
  73 |   aai/v11/service-design-and-creation/services                                                                                |                                                                        |
  74 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  75 | GET                                                                                                                           | Get services by owner entity id                                        |
  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 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  83 | POST search/named-query                                                                                                       | Get data regarding an instance and the instance's related nodes        |
  84 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  85 | GET aai/v11/                                                                                                                  | Get AIC zones for a specific service instance                          |
  86 |   business/customers/customer/<global_customer_id>/                                                                           |                                                                        |
  87 |   /service-subscriptions/service-subscription/<service_type>/service-instances/service-instance/<service_instance_id>         |                                                                        |
  88 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  89 | PUT Aai/v11/query?format=simple(types:                                                                                        | This is a custom query and has multiple types(declared in the url line)|
  90 |   “query/vnfFromModelbyRegion?cloudRegionId”,”                                                                                |                                                                        |
  91 |   vnf-topology-fromServiceInstance”)                                                                                          |                                                                        |
  92 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
  93 | Aai/v11/                                                                                                                      | Get the human readable version by version id                           |
  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 +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+