Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

STATUS: Draft

External API:

1 High Level Component Definition and Architectural Relationships 



External API exposes ONAPs capabilities through defined interfaces.  Enables ONAP to be viewed as a "black box".
It provides

  • Exposes the ONAP service catalogue capabilities

  • Exposes the ONAP inventory capabiliteis

  • Exposes ONAP Service Ordering capabilities

  • Interaces to manage subscription to ExternalAPI events 

2. API definitions

Extenal API provides the following interfaces:

Interface NameInterface Definition Interface Capabilities
AAIE-1Inventary 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 Provides the capability to view the inventory 

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

The current API documents can be found at:

AAI consumes the following Interfaces:

Interface NamePurpose Reason For Use
SDCE-6To receive the service and resource artifacts from SDC.


3. Component Description:

A more detailed figure and description of the component.

<< For later inclusion >>

4. known system limitations

  • Multithreaded concurrent operations on the same objects can cause duplicates in the graph - we have implemented stickiness in the haproxy that sits between AAI and clients to keep a client bound to the same node which can mitigate this, but we do not force locking on updates which means that malicious or careless clients can cause duplicates in the graph.  We provide cleanup utilities for data grooming, but we recommend that clients are careful not to send multiple requests on the same object within microseconds of one another.
  • Operators should pay special attention to giving cassandra enough space, because we have known issues where things go pretty bad (like unhelpful or just wrong error messages) when the disks fill up on the cassandra cluster nodes.


5. Used Models

AAI uses the following models:

  • Inventary Model


6. System Deployment Architecture


AAI consists of X containers:

  • ?????

7. New Capabilities in this Release

This release, AAI adds the following Capabilities:

  • Extended PNF support

8. References

  1.  AAI read the docs: https://docs.onap.org/en/casablanca/submodules/aai/aai-common.git/docs/index.html?highlight=AAI 
  2. AAI REST API Documentation - Dublin

  3. AAI REST API Documentation on readthedocs.io

  4. AAI GUI: AAI Graphical User Interface


  • No labels