REST API definitions
The APIs in Telco Network Cloud Manager - Performance that give access to the database data for constructing the dashboards.
Using Telco Network Cloud Manager - Performance REST API commands requires the same permissions as using the web interface. These REST APIs are available so that you can retrieve the data outside of the web interface.
Each REST resource contains information such as URLs, functions, parameters, descriptions, sample input, and output data.
All the REST APIs must be accessed via the Dashboard Service only.
In OpenShift® Container Platform environment, access the APIs by using the Dashboard Service route that is created after the installation of Telco Network Cloud Manager - Performance and port number 80. For example, use the following format: <Dashboard_route>:80.
In K8 environment, access the APIs by using the hostname of any of the worker nodes in the cluster and Dashboard Service port number, which is 31443 by default. For example, use the following format: https://<hostname>:<port>.Where, <hostname> is the hostname of any worker node in your cluster and <port> is nodePort of the Dashboard Service, which is 31443.
Common REST API status codes
| HTTP status code | Generic description |
|---|---|
| 200 | Success |
| 400 | Failure |