Introduction

It provides the details of the REST API used for each of the command supported.

Service Management

Helps to check the list of ONAP service deployed on a given setup and retrieve the health status. 

Discovery


s.noFeaturecommandREST APIDepends-on Project
1Report registered services

microservice-list

microservice-show

GET on /api/microservices/v1/services

GET on /api/microservices/v1/services/{serviceName}/version/{version}/

MSB
2Register a servicemicroservice-registerPOST on /api/microservices/v1/servicesMSB
3Unregister a servicemicroservice-unregisterDELETE on /api/microservices/v1/services/{serviceName}/version/{version}/MSB

Health Check

s.noFeaturecommandREST APIDepends-on Project
1Report health of registered servicesmicroservice-statusNOT supported for Amesterdam releaseMSB
2Enable/Disable a registered services

microservice-enable

microservice-disable

NOT supported for Amesterdam release
MSB

External Resource Management

Helps to on-board the external system such as VIM, VNFM, EMS and SDNC and retrieve the current state of these resources.

VIM management

s.noFeatureCommandREST APIDepends-on Project
1Register cloudcloud-registerPUT on /api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

A&AI/ESR

2Un-register cloudcloud-unregisterDELETE on /onapapi/aai/esr/v1/vims?cloudOwner=xxx&cloudRegionId=xxx

A&AI/ESR

3Report registered clouds

cloud-list

cloud-show

GET on /api/aai-cloudInfrastructure/v1/cloud-regions

GET on /api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

A&AI/ESR

VNFM management

s.noFeaturecommandREST APIDepends-on Project
1Register VNFMvnfm-registerPUT on /api/aai-vnfm/v1/vnfms/vnfm/{vnfmId}

A&AI/ESR

2Un-register VNFMvnfm-unregisterDELETE on /api/aai-vnfm/v1/vnfms/vnfm/{vnfmId}

A&AI/ESR

3Report registered VNFMs

vnfm-list

vnfm-show

GET on /api/aai-vnfm/v1/vnfms

GET on /api/aai-vnfm/v1/vnfms/vnfm/{vnfmId}

A&AI/ESR

EMS management

s.noFeatureCommandREST APIDepends-on Project
1Register EMSems-registerPOST on /api/aai-ems/v1/emses/ems

A&AI/ESR

2Un-register EMSems-unregisterDELETE on /api/aai-ems/v1/emses/ems/{emsId}

A&AI/ESR

3Report registered EMSs

ems-list

ems-show

GET on /api/aai-ems/v1/emses/ems

GET on /api/aai-ems/v1/emses/ems/{emsId}

A&AI/ESR

Service Orchestration

Helps to deploy, instantiate and destroy a given services such as VoLTE and vCPE services

Service Life-cycle management


Deploy → Launch → Delete → Undeploy


s.noFeatureCommandREST APIDepends-on Project
1Create/show Service Type

service-type-register

service-type-list

PUT on /service-design-and-creation/services/service/{service-id}

GET on /service-design-and-creation/services

AAI
2Create service Insanceservice-create-instancePUT on /serviceInstances/v2

SO

3Create VNFservice-create-vnfPOST on /serviceInstances/v2/{serviceInstanceId}/vnfsSO
4Create VF moduleservice-create-module/serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModulesSO
5Report deployed servicesservice-listNOT available
6Delete VF moduleservice-delete-moduleDELTE on /serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id}SO
7Delete VNFservice-delete-vnfDELETE on /serviceInstances/v2/{serviceInstanceId}/vnfs/{vnfInstanceId}SO
5Delete service instanceservice-delete-instance

DELETE /serviceInstnaces/v2/{serviceInstanceId}

SO
7Remove service typeservice-type-unregister

DELETE on /service-design-and-creation/services/service/{service-id}

AAI


Closed loop Management

Helps to report the policy, alarm and analytics aspect of an given service in ONAP for auto-scaling and healing of them.

Policy management

s.noFeatureCommandREST APIDepends-on Project
1Report policies

policy-list

policy-show

Streach goal
Policy





Alarm management

s.noFeatureCommandREST APIDepends-on Project
1Report Alarms

alarm-list

alarm-show

NOT supported for Amesterdam release


DCAE





Analytics management


s.noFeatureCommandREST APIDepends-on Project
1Report metricsmetrics-listNOT supported for Amesterdam release
DCAE





Limitation

It does not support designing of the services as it involves studio. so its expected that design time artifact should be readily available for using the feature like service management.

Customer Management

Helps to manage the subscriber, who like to use the services provided by ONAP.

Customer management

s.noFeatureCommandREST APIDepends-on Project
1Add customercustomer-addPUT on /business/customers/customer/{global-customer-id}AAI
2Delete Customercustomer-deleteDELETE on /business/customers/customer/{global-customer-id}AAI
3Reports registered customer

customer-list

customer-show

GET on /business/customers

GET on /business/customers/customer/{global-customer-id}

AAI

Subscription management

s.noFeatureCommandREST APIDepends-on Project
1Create Subscriptionsubscription-createPUT on /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}
AAI
2Delete Subscription subscription-deleteDELETE on /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}
AAI

VSP Distribution

s.noFeatureCommandREST APIDepends-on Project
1Manage Catalog service

vsp-list

vsp-create

vsp-upload


vsp-checkin

vsp-submit


vsp-show

GET on /vendor-software-products

POST on /vendor-software-products

POST on /vendor-software-products/{VSP-ID}/upload

PUT on /vendor-software-products/{VSP-ID}/actions

PUT on /vendor-software-products/<VSP-ID>/actions

GET on /vendor-software-products/{VSP-ID}


SDC
2Manage service certification

catalog-service-verify

catalog-service-unverify

Streach goal
SDC
3Manage service distribution

catalog-service-distribute

catalog-service-undistribute

Streach goal
SDC


Command management

Helps to discover/validate the installed ONAP Commands/schema

s.noFeatureCommandDepends-on Project
1Open CLI schema validationschema-validateCLI
2CLI Helperonap -hCLI
3Dynamic Command discoveryschema-refreshCLI


User Authentication support

Helps to login/logout user.

s.noFeatureCommandREST APIDepends-on Project
1Loginservice→auth: aaf

NOT supported for Amesterdam release

AAF
2Logoutservice→auth: aafNOT supported for Amesterdam release
AAF
  • No labels