docs/consumedapis/consumedapis.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2 .. Copyright 2018 ORANGE
   3
   4
   5 Consumed APIs
   6 =============
   7
   8
   9 NBI application is interacting with 4 ONAP APIs
  10
  11 *******
  12 SDC API
  13 *******
  14
  15 This API is used to provide Service Catalog information
  16 Information are retrieved in SDC (and in TOSCA "service template" file)
  17 - Only GET operation is provided - this API DID NOT UPDATE SDC
  18
  19 ::
  20
  21     SDC_ROOT_URL = "/sdc/v1/catalog/services/"
  22
  23     SDC_GET_PATH = "/metadata"
  24
  25     SDC_TOSCA_PATH = "/toscaModel"
  26
  27
  28 *******
  29 AAI API
  30 *******
  31
  32 This API is used to provide Service Inventory information
  33 This API retrieves service(s) in the AAI inventory. Only following attributes
  34 will be retrieve in service inventory: id, name and type
  35 (no state or startDate available )
  36
  37 ::
  38
  39     AAI_GET_TENANTS_PATH = "/aai/v14/cloud-infrastructure/cloud-regions/cloud-region/$onap.cloudOwner/$onap.lcpCloudRegionId/tenants"
  40
  41     AAI_GET_CUSTOMER_PATH = "/aai/v14/business/customers/customer/"
  42
  43     AAI_GET_SERVICES_FOR_CUSTOMER_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions"
  44
  45     AAI_PUT_SERVICE_FOR_CUSTOMER_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions/service-subscription/
  46
  47     AAI_GET_SERVICE_FOR_CUSTOMER_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/service-instance/$serviceId"
  48
  49     AAI_GET_SERVICE_INSTANCES_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/"
  50
  51     AAI_HEALTH_CHECK = "aai/util/echo?action=long"
  52
  53     AAI_GET_SERVICE = "/aai/v14/nodes/service-instances/service-instance/$serviceId"
  54
  55     AAI_GET_SERVICE_CUSTOMER = "/aai/v14/nodes/service-instances/service-instance/$serviceId?format=resource_and_url"
  56
  57     SDC_HEALTH_CHECK = "/sdc2/rest/healthCheck"
  58
  59 ******
  60 SO API
  61 ******
  62
  63 This API is used to perform Service Order and thus instantiate a service.
  64 Distinct SO APIs are used for serviceInstance creation request depending on the
  65 serviceSpecification category (set in SDC). If service could be delivered
  66 end-to-end from one request category is set to 'E2E Service'.
  67 In this case NBI uses
  68
  69 ::
  70
  71     MSO_CREATE_E2ESERVICE_INSTANCE_PATH = "/ecomp/mso/infra/e2eServiceInstances/v3"
  72
  73     MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v7/"
  74
  75     MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v7/"
  76
  77
  78 else following API are used:
  79
  80 ::
  81
  82     MSO_CREATE_SERVICE_INSTANCE_PATH = "/ecomp/mso/infra/serviceInstance/v6"
  83
  84     MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v7/"
  85
  86     MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v7/"
  87
  88     MSO_HEALTH_CHECK = "/globalhealthcheck"
  89
  90 *********
  91 DMAAP API
  92 *********
  93
  94 This API is used to retrieve Dmaap notifications from SDC and AAI.
  95
  96 ::
  97
  98     DMAAP_CONSUME_EVENTS = "/events/$topic/$consumergroup/$consumerid?timeout=$timeout"