You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 3
Next »
STATUS: Draft
External API:
1 High Level Component Definition and Architectural Relationships
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkNoYWtlciBBbC1IYWtpbSIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJDaGFrZXIgQWwtSGFraW0iLCJsYW5ndWFnZSI6ImVuIiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiODE0MDQ1ODAiLCJkaWFncmFtTmFtZSI6ImV4dGVybmFwaV9yNSIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJBUkMgRXh0ZXJuYWxBUEkgQ29tcG9uZW50IERlc2NyaXB0aW9uIC0gRWwgQWx0by1SNSIsInRic3R5bGUiOiJ0b3AiLCJjYW5Db21tZW50IjpmYWxzZSwiZGlhZ3JhbVVybCI6IiIsImNzdkZpbGVVcmwiOiIiLCJib3JkZXIiOnRydWUsIm1heFNjYWxlIjoiMSIsIm93bmluZ1BhZ2VJZCI6ODE0MDQzMDMsImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjgxNDA0NTg1LCJwYWdlSWQiOiIiLCJsYm94Ijp0cnVlLCJzZXJ2ZXJDb25maWciOnsiZW1haWxwcmV2aWV3IjoiMSJ9LCJvZHJpdmVJZCI6IiIsInJldmlzaW9uIjoyLCJtYWNyb0lkIjoiNzE5OGVlMTItMWQwYS00MTFiLTllNjMtOTUzYWY3NTUxY2E5IiwicHJldmlld05hbWUiOiJleHRlcm5hcGlfcjUucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjU3MCIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTU4NjE0MDIyNzAwMCwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkNoYWtlciBBbC1IYWtpbSIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJDaGFrZXIgQWwtSGFraW0iLCJsYW5ndWFnZSI6ImVuIiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiRXh0ZXJuYWxBUEkgU3lzdGVtIENvbnRleHQgVmlldyIsInNGaWxlSWQiOiIiLCJhdHRJZCI6IjgxNDA0MzA1IiwiZGlhZ3JhbU5hbWUiOiJFeHRlcm5hbEFQSSBTeXN0ZW0gQ29udGV4dCBWaWV3IiwiYXNwZWN0IjoiIiwibGlua3MiOiJhdXRvIiwiY2VvTmFtZSI6IkFSQyBFeHRlcm5hbEFQSSBDb21wb25lbnQgRGVzY3JpcHRpb24gLSBFbCBBbHRvLVI1IiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo4MTQwNDMwMywiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6ODE0MDQ1ODUsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjIsIm1hY3JvSWQiOiI3MmM1Mzc1YS01ZjdmLTQyZTEtYTA4YS02ZDE5M2Q0MjQ5ZWEiLCJwcmV2aWV3TmFtZSI6IkV4dGVybmFsQVBJIFN5c3RlbSBDb250ZXh0IFZpZXcucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjYwMCIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTU4NjE0MDE1NzAwMCwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
External API exposes ONAPs capabilities through TMF standardized interfaces. It enables ONAP to hide the internal API.
It provides
Exposes the ONAP service catalogue capabilities
Exposes the ONAP inventory capabilities
Exposes ONAP Service Ordering capabilities
Interfaces to manage subscription to ExternalAPI events
2. API definitions
External API provides the following interfaces:
Interface Name | Interface Definition | Interface Capabilities |
---|
ExternalAPIE-1 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 Name | Purpose Reason For Use |
---|
SDCE-6 | To receive the 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 |
MSBE-1 | Register NBI API |
DMAAPE-1 | Poll 2 topics: AAI events SDC events |
3. Component Description:
A more detailed figure and description of the component.
<< For later inclusion >>
4. Known system limitations
5. Used Models
ExternalAPI uses the following models:
6. System Deployment Architecture
7. New Capabilities in this Release
8. References
- External API architecture: https://docs.onap.org/en/latest/submodules/externalapi/nbi.git/docs/releasenotes/releasenotes.html
- External API interface: https://docs.onap.org/en/casablanca/_downloads/8cce799c6c8f3f5916f265c52ab60ba7/nbicallflow.pdf