Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. TopologyType — Get type super type’s information
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json.
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Clear alarm by alarm ID Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get alarm by alarm ID
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get alarm by rule ID • Description: Filter out alarms by a rule ID. Time range is the default value set in the Management Server, and you can customize the time range using the startTimeMS and durationMS parameter. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get history alarms status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object history alarms status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Push alarms • Description: Push an alarm to an existing topology object, and the imported alarm will show on the Alarm dashboard. The “topologyObjectId” field is mandatory and the "ruleId" field is optional...
Field Type Description. Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object history alarms
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. We are more than just a name We are on a quest to make your information technology work harder for you. That is why we build community- driven software solutions that help you spend less time on IT administration and more time on business innovation. We help you modernize your data center, get you to the cloud quicker and provide the expertise, security and accessibility you need to grow your data-driven business. Combined with Quest’s invitation to the global community to be a part of its innovation, and our firm commitment to ensuring customer satisfaction, we continue to deliver solutions that have a real impact on our customers today and leave a legacy we are proud of. We are challenging the status quo by transforming into a new software company. And as your partner, we work tirelessly to make sure your information technology is designed for you and by you. This is our mission, and we are in this together. Welcome to a new Quest. You are invited to Join the Innovation™. Our brand, our vision. Together. Our logo reflects our story: innovation, community and support. An important part of this story begins with the letter
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server.
Field Type Description path String The property path. This may include multiple paths. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Topology — Get property value DataObject, Primitive Object, Observation, or else.
Field Type Description. Id String The topology object ID. This may include multiple IDs. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. range. AGGREGATE_AND_LAST Retrieve the aggregate and last data of an observation based on the time range. LAST_N Retrieve the last N data of the observation based on the time range. If retrievalType is set to LAST_N, you need configure the value of numberOfValue that defines the letter N of LAST_N. Generate a post request using the following url: "http://<server>:<port>/api/v1/topology/batchQuery" The basic format of request body can be set as below: {"includes":[{"ids":["ca83d1a2-f04b-483d-b224- 055967777e72"],"observationName":"utilization"}],
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Script — Publish custom REST API • Description: The Management Server provides the capability for publishing custom REST API with scripts. To run scripts of custom REST API, ensure that the value of Choose an Associated Cartridge (Optional) is set to Forge-RestAPI in the Administration > Tooling > Script Console > Scripts > Add > Run Script dialog box. This API is a runtime registration, so the registered custom REST APIs will be lost after restarting the server. import xxxxx.xx.xx.*; import javax.ws.rs.core.*; import javax.ws.rs.container.*; import javax.servlet.http.*; import com.quest.forge.rest.annotation.Secured; import com.quest.forge.rest.service.*; import com.quest.forge.rest.api.*; @Path("/echo") @Secured @Produces("application/json") class MyResource{ @Context private ContainerRequestContext requestContext; @Context protected HttpServletRequest request; @GET @Path("host") public Response echoSampleHost(){ def foglightServiceLocator = ServiceFactory.getInstance().getFoglightServiceLocator(); def ts = foglightServiceLocator.getTopologyService(); def hosts = ts.getObjectsOfType(ts.getType("Host")); if(!hosts){ return Response.ok("Empty hosts").build(); }else{ def host = (hosts as List).get(0); def helper = foglightServiceLocator.getExtensionContext().get(ForgeRestApiHelper.class); } return Response.ok(entity).build(); } } } class MyRestAPIExtension implements ForgeRestApiExtension{ @Override public Class getRestResourceClz(){ return MyResource.class; } @Override public String getCartridgeName(){ return "DummyCartridge"; } } def rrm = server.context('extensionContext').get(RestResourceManager.class); rrm.registerRestAPIExtension(new MyRestAPIExtension()); After running the above codes in the Script Console dashboard, you can access this API with the ▪ Use rrm.registerRestAPIExtension (replaces MyRestAPIExtension()) to register the custom API. ▪ Use rrm.unregisterRestAPIExtensions (DummyCartridge) to remove the custom API. ▪ The @Path annotation is used to define the relative URI path. ▪ The @Get annotation is used to...
