Etsicatalog API Document
- Yuanhong Deng
- Zihao Chen
Offered APIs
Etsicatalog provides the followed APIs:
NS package management interface
Provides runtime NS package management interface which aligns with SOL005 - NSD Management interface.
URL | Method | Description |
|---|---|---|
/api/nsd/v1/ns_descriptors | POST | Create a new NS descriptor resource. |
/api/nsd/v1/ns_descriptors | GET | Query information about multiple NS descriptor resources. |
/api/nsd/v1/ns_descriptors/{{nsdInfoId}} | GET | Read information about an individual NS descriptor resource. |
/api/nsd/v1/ns_descriptors/{{nsdInfoId}}/nsd_content | PUT | Upload the content of a NSD. |
/api/nsd/v1/ns_descriptors/{{nsdInfoId}}/nsd_content | GET | Fetch the content of a NSD. |
/api/nsd/v1/ns_descriptors/{{nsdInfoId}} | DELETE | Delete an individual NS descriptor resource. |
/api/nsd/v1/pnf_descriptors | POST | Create a new PNF descriptor resource. |
/api/nsd/v1/pnf_descriptors | GET | Query information about multiple PNF descriptor resources. |
/api/nsd/v1/pnf_descriptors/{{pnfdInfoId}} | GET | Read an individual PNFD resource. |
/api/nsd/v1/pnf_descriptors/{{pnfdInfoId}}/pnfd_content | PUT | Upload the content of a PNFD. |
/api/nsd/v1/pnf_descriptors/{{pnfdInfoId}}/pnfd_content | GET | Fetch the content of a PNFD. |
/api/nsd/v1/pnf_descriptors/{{pnfdInfoId}} | DELETE | Delete an individual PNF descriptor resource. |
VNF package management interface
Provides runtime VNF package management interface which aligns with SOL003 - VNF Package Management interface.
URL | Method | Description |
|---|---|---|
/api/vnfpkgm/v1/vnf_packages | POST | Create a new individual VNF package resource |
/api/vnfpkgm/v1/vnf_packages | GET | Query VNF packages information |
/api/vnfpkgm/v1/vnf_packages/{{vnfPkgId}} | GET | Read information about an individual VNF package |
/api/vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/package_content | PUT | Upload a VNF package by providing the content of the VNF package |
/api/vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/package_content/upload_from_uri | PUT | Upload a VNF package by providing the address information of the VNF package |
/api/vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/package_content | GET | Fetch an on-boarded VNF package |
/api/vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/vnfd | GET | Read VNFD of an on-boarded VNF package |
/api/vnfpkgm/v1/vnf_packages/{{vnfPkgId}}/artifacts/{{artifactPath}} | GET | Fetch individual VNF package artifact |
/api/vnfpkgm/v1/vnf_packages/{{vnfPkgId}} | DELETE | Delete an individual VNF package |
/api/vnfpkgm/v1/subscriptions | POST | Subscribe to notifications related to on-boarding and/or changes of VNF packages |
/api/vnfpkgm/v1/subscriptions | GET | Query multiple subscriptions |
/api/vnfpkgm/v1/subscriptions/{{subscriptionId}} | GET | Read an individual subscription resource |
/api/vnfpkgm/v1/subscriptions/{{subscriptionId}} | DELETE | Terminate a subscription |
Catalog interface
Provides APIs to query/fetch package from SDC catalog.
URL | Method | Description |
|---|---|---|
/api/catalog/v1/nspackages | POST | Fetch NS package from SDC catalog |
/api/catalog/v1/vnfpackages | POST | Fetch NVF package from SDC catalog |
/api/catalog/v1/service_packages | POST | Fetch Service package from SDC catalog |
Parser interface
Provide APIs to parser VNF/PNF/NS/Service package.
URL | Method | Description |
|---|---|---|
/api/parser/v1/parserpnfd | POST | Parse PNF package |
/api/parser/v1/parservnfd | POST | Parse VNF package |
/api/parser/v1/parsernsd | POST | Parse NS package |
/api/parser/v1/parser | POST | Parse package |
You can download the following API yaml file and paste the content into the swagger tool: https://editor.swagger.io to view whole detail of APIs.
Consumed APIs
Etsicatalog consumes the followed APIs of other ONAP components:
SDC
Etsicatalog invokes SDC APIs to query/fetch package from SDC catalog.
URL | Method | Description |
|---|---|---|
/api/sdc/v1/catalog/services/ | GET | Get service list |
/api/sdc/v1/catalog/services/{{csarId}}/metadata | GET | Get a service metadata |
/api/sdc/v1/catalog/resources | GET | Get resource list |
/api/sdc/v1/catalog/resources/{{csarId}}/metadata | GET | Get a resource metadata |
/api/sdc/v1/catalog/services/{{csarId}}/toscaModel | GET | Download a service package |
/api/sdc/v1/registerForDistribution | POST | Register for SDC topic |
/api/sdc2/rest/v1/consumers | POST | Create consumer for SDC |
note: Etsicatalog invokes SDC APIs through MSB.
You can download the following swagger file to view detail information of SDC APIs:
Dmaap
Etsicatalog invokes Dmaap APIs to subscribe topic and create a new apiKeys for topic
URL | Method | Description |
|---|---|---|
/api/events/{topic}/{group}/{consumer_id} | GET | Get events of a MessageRouter topic |
/api/apiKets/create | POST | Create apiKey from dmaap |
/api/apiKeys/{apikey} | GET | Get apiKeys from dmaap |
You can access the Dmaap APIs(MR) to view the detail information of Dmaap APIs.
Micro Service Bus
Etsicatalog invokes Micro Service Bus APIs to register service to MSB.
URL | Method | Description |
|---|---|---|
/api/microservices/v1/services | POST | Register service to the Microservice Bus |
For detail information of MSB APIs, please refer to: Microservice Bus API Documentation