How Can We Help?
The Topology APIs, which are served by the Control Center data service to create entities and relationships between them for the Enterprise.
Topology API Listing
Topology APIs of Heal consist of the following:
- Application
- Connections
- Category
- Component
- KPI Group
- KPI
- Producer
- Agent
- Cluster
- Host Instance
- Service
- Component Instance
- Forensic and Healing Action
- Supervisor
The APIs must be used in the same sequential order, as there is a dependency between the APIs. However, it is not mandatory to use all the APIs. Refer to the Use Cases to better understand the API sequence.
Prerequisites
The prerequisites to use the Topology API is as follows:
- Account for your enterprise must be added through the Control Center UI.
- Control Center must be up and accessible.
- Access to the Heal Keycloak server to generate the Authorization token.
- Curl must be installed in the Heal keycloak server.
- The identifier of the Account for your Enterprise must be obtained.
Account Identifier
You can get this information from the “Identifier” column of the Manage Accounts page of Control Center UI.
Topology API Request Details
This section will describe the details about the Topology API Request.
Base URI
Topology API use the following base URI.
- keycloak_host: IP Address or the Hostname of the server, where the Keycloack is installed.
- keycloak_port: Port number on which the Keycloack is running.
Request Structure
Topology API Request structure is common and the details are follows
| HTTP Method | POST |
|---|---|
| Request Header | |
| Authorization Token | Keycloak token from Appsone Server. Refer: Authorization Token |
| Content Type | application/json |
Authorization Token
To generate the Authorization token for the API request header, follow the below steps
- Log on to the Heal Keycloak Server.
- Execute the following command.
where the value of client_id and grant_type must be replaced with admin-cli and password respectively. Use the Heal Control Center Admin Username and Password for the values of username and password.
For Example:
Use Cases
The following use case examples will help you in understanding the API Sequence to be used based on your requirement.
| Sr.No. | Use Case | API Usage Sequence |
|---|---|---|
| 1 | A user wants to add basic entities and standard component instances and host instances to monitor Behaviour KPIs. | Application Connections Agent Component Agent Host Cluster Component Cluster Host Instance Component Instance Supervisor |
| 2 | Application Connections Agent Component Agent Host Cluster Component Cluster Host Instance Component Instance Supervisor. | Application Connections Agent Log Agent Host Cluster Component Cluster Host Instance Component Instance Supervisor Transaction. |
| 3 | A user wants to add basic entities and standard component instances and host instances to monitor Workload KPIs using Custom Agent | Application Connections Agent Custom Agent Host Cluster Component Cluster Host Instance Component Instance Supervisor |
| 4 | A user wants to add a new Component and its dependencies, but use the existing basic entities. | Category Component KPI Group KPI Producer Forensics |
| 5 | A user wants to add a new Component and its dependencies, but use the existing basic entities, category & forensics. | Component KPI Group KPI Producer |
| 6 | A user wants to add new Group KPI and producer, but use the existing basic entities, category & forensics. | KPI Group Producer |
| 7 | A user wants to add new KPI and producer, but use the existing basic entities, category & forensics. | KPI Producer |
| 8 | A user wants to add just a new producer for existing KPI. | Producer |
Steps
- Choose the entity to be created.
- Create the JSON for the entity.
- Call the Topology URI with the required request details and JSON created.
- On successful creation of the entity, Success Response will be received from the Topology API.
- In case of failures, Failure Response will be received from the Topology API.