...
| Drawio | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Interface Name | Interface Definition | Interface Capabilities | |||||
|---|---|---|---|---|---|---|---|
| AAIEExternalAPIE-1 | Inventary Service Interface. | An interface to create, update, retrieve, query, delete the service, resources and relationship inventary information for:
AAI also provides Inventory History information | AAIE-2 | AAI Graphical User Interfaces | Provides the capability to view the inventoryNBI Management Interface | Retrieve the avaible NBIS and Validates the health of a NBI interface | Provides:
|
| 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:
| |||||
| ExternalAPIE-3 Service Catalogue Interface | Find service specifications that can be instantiated | Provides:
| |||||
| ExternalAPIE-4 Service Ording Interface | Request the instantiation of a service | Provides
| |||||
| ExternalAPIE-5 Service Inventory Interface | Query information about instantiated services | Provides
|
Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface
The current API documents can be found at:
...
- External API interface: https://docs.onap.org/en/casablanca/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdf
ExternalAPI consumes the following Interfaces:
| Interface Name | Purpose Reason For Use |
|---|---|
| SDCE-6 | To receive the service and resource artifacts from SDC.notifications of a new service. |
| SDCE-7 | To query the catalogue for service specifications |
| SOE-X | To request a service instantiation |
| AAIE-1 | To query the instantiated services |
3. Component Description:
...
<< 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.FFS
5. Used Models
AAI ExternalAPI uses the following models:
- Inventary Model-
6. System Deployment Architecture
AAI consists of X ExternalAPI consists of 1 containers:
- ?????ExternalAPI
Drawio border true viewerToolbar true fitWindow false diagramDisplayName ExternalAPI runtime architecture lbox true revision 12 diagramName ExternalAPI runtime architecture simpleViewer false width links auto tbstyle top diagramWidth 821231
This needs to be updated
7. New Capabilities in this Release
This release, AAI ExternalAPI adds the following Capabilities:
...
- Service inventory notification
- Service inventory improvements
- Update from springboot 1.x to springboot 2.x
- Refactor API testing
8. References
- AAI read the docsExternal API architecture: https://docs.onap.org/en/casablanca/submodules/aaiexternalapi/aai-commonnbi.git/docs/architecture/indexarchitecture.html?highlight=AAI
- AAI REST API Documentation - Dublin
- AAI GUI: AAI Graphical User Interface
- External API interface: https://docs.onap.org/en/casablanca/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdf