![]() ![]() To delete a NAME:VALUE pair, click the icon available in that row.įigure 5 : The table populated with NAME:VALUE pair of body parameters Repeat this procedure until you include all the parameters of your choice. ![]() The Body Param chosen will be populated in the NAME column of the table and the value that you specified explicitly or the value that you have chosen from the adjacent list box will be populated in the VALUE column. Clicking the icon adds the chosen parameter and the value to a table. You need to choose the values from this list too. If you have chosen Analytics as the API Type, then, another list box will appear with the values relevant to the Body Param that you have chosen. For example, if you choose hostIp from this list, then, you should specify the IP address of the component in the Param Value text box. Select the parameter of your choice from the Body Params drop-down list. To this effect, the Body Params list will be automatically populated with all the parameters that are applicable for the chosen API. To execute the chosen API successfully, a few additional parameters are required by default. For example, if you have chosen getAlarmsHistory from the API list after selecting Analytics as the API Type, then, the API Endpoint URL will be populated in the following format: Once you choose an API from the API Name list, the API Endpoint URL will be automatically populated. Then, select the API of your choice from the API Name drop-down list as shown in Figure 3. However, if you wish to perform bulk operations, then, set this flag to Yes (see Figure 2). By default, this flag is set to No indicating that you are not performing bulk administrative operations on the target eG manager. If you wish to choose this type, then, an additional Bulk Operation flag will appear. Orchestration - By choosing this API type, you can perform various administrative activities such as adding a single component or multiple components at a time, adding agents/users/zones, modifying users/components/maintenance policies, etc. Miscellaneous - Choose this API type to figure out additional information with respect to the infrastructure configured in the eG manager. The APIs offered by eG Enterprise are grouped as follows:Īnalytics - Select this API type to retrieve analytical data such as alarms, detailed diagnosis data of a measure, health of the components, etc. Choose an API Type (see Figure 1) based on the task that you wish to perform. Using eG REST API, you can perform a wide range of administrative tasks (for e.g., adding the components to be monitored), retrieve analytical data (for e.g., history of alarms) and configuration data. Then, follow the menu sequence: Admin -> Miscellaneous -> REST API Client.Login to the eG manager console as an admin user.To know how to use this inbuilt REST API Client, follow the steps given below: Using this capability, with a few clicks after choosing the API, administrators can obtain the output of their desired REST API command. To reduce the time and effort in building the API commands, avoid manual errors and dependencies to a third party REST client, eG Enterprise offers an inbuilt utility called REST API Client. This process was time-consuming and sometimes, led to manual errors which were noticed only after executing the commands. However, to use the eG REST API capability, administrators had to install their desired REST Client in the target environment, painstakingly build the API commands with all the required parameters, import them into the REST Client and finally execute them. From any third-party REST Client, administrators can hit the URL of the eG manager using the HTTP POST method to connect to the manager and perform configuration tasks on it. ![]() To perform critical configuration tasks on the eG manager without logging into the eG manager, eG Enterprise offers both eG CLI and eG REST API capabilities. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |