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

  1. Routing Manager request the xapp list and E2Term list available during startup.
_images/rtmgr_startup.png
  1. AppMgr send complete xapps list whenever a xapp is deployed/undeployed
_images/rtmgr_appmgr_cn.png
  1. Subscription Manager adds/deletes subscription ID
_images/rtmgr_submgr_add_delete.png
  1. Update the subscription ID for given xApp.(Subscription Merge Add)
_images/rtmgr_submgr_merge_add.png
  1. Update the subscription ID for given xApp.(Subscription Merge Delete)
_images/rtmgr_submgr_merge_delete.png
  1. E2Mgr sends request to Add/Delete E2Termination Instance
_images/rtmgr_create_delete_e2t.png
  1. E2Mgr sends request to Associate/Dissociate RAN names to a given E2Termination Instance
_images/rtmgr_ass_dis_e2t.png