Versions Compared

Old Version 2

changes.mady.by.user Stephen terrill

Saved on

compared with

New Version Current

changes.mady.by.user Stephen terrill

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Drawio
bordertrue
viewerToolbartrue
fitWindowfalse
diagramDisplayNameExternalAPI System Context View
lboxtrue
revision37
diagramNameExternalAPI System Context View
simpleViewerfalse
width600
linksauto
tbstyletop
diagramWidth492

...

External API exposes ONAPs capabilities through defined TMF standardized interfaces.  Enables It enables ONAP to be viewed as a "black box"hide the internal API.


It provides

  • Exposes the ONAP service catalogue capabilities

  • Exposes the ONAP inventory capabiliteiscapabilities

  • Exposes ONAP Service Ordering capabilities

  • Interaces Interfaces to manage subscription to ExternalAPI events 

2. API definitions

Extenal External API provides the following interfaces:

Provides the capability to view the inventory 
Interface NameInterface Definition Interface Capabilities
AAIEExternalAPIE-1 Inventary Service Interface.   An interface to create, update, retrieve, query, delete the service, resources and relationship inventary information for:
  • Cloud infrastructure (including cloud infrastructure regions and availability zones, cloud infrastructure resources such as servers, storage, VLANs, cloud network technologies,...)
  • Paths and connectors
  • Business Customers and busines customer relationship to managed assets
  • Service Instances (including the relationship to used resources)
  • Resource instances (including allotted resources) (virtual and physical, including VNFs, PNFs, Switches, VNF modules)
  • External systems (systems that ONAP connects to)
  • Images
  • Networks
  • Infrastructure tenants
  • Relationships
  • Interfaces
  • IP addresses
  • Configurations
  • Licences
  • Site resources

AAI also provides Inventory History information

 AAIE-2AAI Graphical User Interfaces NBI Management Interface

Provides a healthcheck to verify that the NBI component is running fine


Provides:
  • Healthcheck of a NBI service
ExternalAPIE-2 Subscription Management Interface

Provides the ability to subscribe to and unsubscribe from External API events.

(also known as the External API Hub interface) 

Provides:
  • Create/Delete a Notification
  • List notification
  • Retrieve a notification
  • Listen to notifications
ExternalAPIE-3 Service Catalogue Interface Find service specifications that can be instantiated

 Provides:

  • Search for services in the catalogue (with filters)
  • Retrieve a service specification from the catalogue
ExternalAPIE-4 Service Ordering Interface Request the instantiation of a service

 Provides

  • Search for service orders
  • Retrieve a service order
  • Request a service instantiation
ExternalAPIE-5 Service Inventory Interface Query information about instantiated services Provides
  • Search for instantiated Services
  • Retrieve information about an instantiated order

Note:   xxxI interface is a Component internal interface.  xxxxE interface is a component external interface

The current API documents can be found at:

...

ExternalAPI consumes the following Interfaces:

Interface NamePurpose Reason For Use
SDCE-6To receive the service and resource artifacts from SDC.notifications of a new service.
SDCE-7To query the catalogue for service specifications 
SOE-X To request a service instantiation 
AAIE-1 To query the instantiated services 
MSBE-1Register NBI API
DMAAPE-1

Poll 2 topics:

AAI events

SDC events


3. Component Description:

...

<< For later inclusion >>

Image Added

4.

...

Known system limitations

  • FFS


5. Used Models

AAI ExternalAPI uses the following models:

  • Inventary Model-

6. System Deployment Architecture

AAI consists of X containers:

  • ?????

...


7. New Capabilities in this Release

...

  • Extended PNF support

8. References

  1.  AAI read the docsExternal API architecture: https://docs.onap.org/en/casablancalatest/submodules/aaiexternalapi/aai-commonnbi.git/docs/releasenotes/indexreleasenotes.html?highlight=AAI 
  2. AAI REST API Documentation - Dublin

  3. AAI REST API Documentation on readthedocs.io

  4. AAI GUI: AAI Graphical User Interface
  5. External API interface: https://docs.onap.org/en/casablanca/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdf