API-Docs¶
This is the API-docs of ROUTING MANAGER
API Introduction¶
Routing Manager interacts with the following RIC platform components.
* Appmgr:
1. POST API to request the xapp list available
http://<rtmgr_http_service_IP>/ric/v1/xapps
2. POST API to send the xapps that either get deployed or undeployed
http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-handle
* Submgr:
1. POST API to provide the subscription details
http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle
2. DELETE API to delete the subscription details
http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle
3. PUT API to update the subscriptionID for given xApp.
http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle/{subscription_id}
* E2Mgr:
1. POST API to Add E2Termination Instance
http://<rtmgr_http_service_IP>/ric/v1/handles/e2t
2. DELETE API to Delete E2Termination Instance
http://<rtmgr_http_service_IP>/ric/v1/handles/e2t
3. POST API to Associate RAN names to a given E2Termination
http://<rtmgr_http_service_IP>/ric/v1/handles/associate-ran-to-e2t
4. DELETE API to Dissociate RAN names to a given E2Termination
http://<rtmgr_http_service_IP>/ric/v1/handles/dissociate-ran
* Health Check:
1. GET API's to retrieve the Aliveness and Readyness checks
http://<rtmgr_pod_IP>:8080/ric/v1/health/alive
http://<rtmgr_pod_IP>:8080/ric/v1/health/ready
API Functions¶
Routing Manager request the xapp list and E2Term list available during startup.
AppMgr send complete xapps list whenever a xapp is deployed/undeployed
Subscription Manager adds/deletes subscription ID
Update the subscription ID for given xApp.(Subscription Merge Add)
Update the subscription ID for given xApp.(Subscription Merge Delete)
E2Mgr sends request to Add/Delete E2Termination Instance
E2Mgr sends request to Associate/Dissociate RAN names to a given E2Termination Instance