Common use of Field Type Description Clause in Contracts

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. • Returned value: Field Type Description 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‌ • API Name: Clear alarm by alarm ID • Description: Clear an alarm by its ID. • Request type: GET • API path: /api/v1/alarm/clear/alarmId Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description 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‌ • API Name: Get alarm by alarm ID • Description: Filter out alarms by alarm ID. • Request type: GET • API path: /api/v1/alarm/alarmId • Sample usage: http://<server>:<port>/api/v1/alarm/1f478dec-f920-4da9-a8d2-b9ba0dcd4394 • Header:

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. • Returned value: Field Type Description 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‌ • API Name: Clear alarm by alarm ID • Description: Clear an alarm by its ID. • Request type: GET • API path: /api/v1/alarm/clear/alarmId • Sample usage: http://<server>:<port>/api/v1/alarm/clear/1f478dec-f920-4da9-a8d2-b9ba0dcd4394 Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description 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‌ • API Name: Get alarm by alarm ID • Description: Filter out alarms by alarm ID. • Request type: GET • API path: /api/v1/alarm/alarmId • Sample usage: http://<server>:<port>/api/v1/alarm/1f478dec-f920-4da9-a8d2-b9ba0dcd4394 • Header:

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. • Returned value: Field Type Description 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 Get alarm by alarm rule ID‌ • API Name: Clear Get alarm by alarm ID rule ID. • Description: Clear an alarm Filter out alarms by its 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. • Request type: GET • API path: /api/v1/alarm/clearruleId/alarmId ruleId • Sample usage: http://<server>:<port>/api/v1/alarm/ruleId/se478dec-f920-4de9-a8d2-b9ba0dcasd94 • Returned value: Field Type Description 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‌ • API Name: Get current alarms • Description: Filter out current alarms. • Request type: GET • API path: /api/v1/alarm/current • Sample usage: http://<server>:<port>/api/v1/alarm/current • Header: 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. • Returned value: Field Type Description 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‌ history alarms‌ • API Name: Get alarm by alarm ID history alarms • Description: Filter out alarms by alarm IDall history alarms. • Request type: GET • API path: /api/v1/alarm/alarmId history • Sample usage: http://<server>:<port>/api/v1/alarm/1f478decalarm/history • Returned value: Field Type Description 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‌ • API Name: Get topology object current alarms • Description: Filter out current alarms by the ID of a topology object. • Request type: GET • API path: /api/v1/alarm/current/topologyId • Sample usage: http://<server>:<port>/api/v1/alarm/current/se478dec-f920-4da94de9-a8d2-b9ba0dcd4394 b9ba0dcasd94 • Header: 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. • Returned value: Field Type Description 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‌ • API Name: Get topology object history alarms • Description: Filter out history alarms by the ID of a topology object. • Request type: GET • API path: /api/v1/alarm/history/topologyId • Sample usage: http://<server>:<port>/api/v1/alarm/history/se478dec-f920-4de9-a8d2-b9ba0dcasd94 • Returned value: Field Type Description 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‌ • API Name: 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. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Request type: POST • API path: /api/v1/alarm/pushAlarm • Sample usage: When using the pushAlarm API, note the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule — Get all rules’ data API. ▫ Execute the following scripts in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = server.RuleService.getAllRules().find{ xx.xxxx == ruleName if(rule){ return xxxx.xx; }else{ return "Rule not found." } The following illustrates the sample code of request body in XML and JSON separately. Request body in XML: <externalAlarmParamBean> <alarmMessage>title of alarm dialog. alarm message</alarmMessage> <severity>3</severity> <topologyObjectId>94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> Value Description 2 Warning 3 Critical 4 Fatal • Header:

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. • Returned value: Field Type Description 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 Topology — Clear alarm Get topology object by alarm ID‌ id‌ • API Name: Clear alarm Get topology object by alarm ID IDs • Description: Clear Filter out topology objects by an alarm by its object ID. • Request type: GET • API path: /api/v1/alarmtopology/cleartopologyObjectId • Sample usage: http://<server>:<port>/api/alarmId v1/topology/1f478dec-f920-4da9-a8d2-b9ba0dcd4394 Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description 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 Topology — Get alarm topology object by alarm ID‌ ids‌ • API Name: Get alarm topology object by alarm ID ids • Description: Filter out alarms topology objects by alarm IDmultiple IDs. • Request type: GET • API path: /api/v1/alarmtopology/alarmId topologyIds • Sample usage: http://<server>:<port>/api/v1/alarm/1f478dectopology/topologyIds?Id=3546fa55-f92011b6-4da94943-a8d2b7cb- 84ddcf350bc5&Id=67beea68-b9ba0dcd4394 fa6f-4cd3-b122-dcb20db50360 • Header:

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. • Returned value: Field Type Description 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 Get alarm by alarm rule ID‌ • API Name: Clear Get alarm by alarm ID rule ID. • Description: Clear an alarm Filter out alarms by its 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. • Request type: GET • API path: /api/v1/alarm/clearruleId/alarmId ruleId • Sample usage: http://<server>:<port>/api/v1/alarm/ruleId/se478dec-f920-4de9-a8d2-b9ba0dcasd94 • Returned value: Field Type Description 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‌ • API Name: Get current alarms • Description: Filter out current alarms. • Request type: GET • API path: /api/v1/alarm/current • Sample usage: http://<server>:<port>/api/v1/alarm/current • Header: 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. • Returned value: Field Type Description 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‌ history alarms‌ • API Name: Get alarm by alarm ID history alarms • Description: Filter out alarms by alarm IDall history alarms. • Request type: GET • API path: /api/v1/alarm/alarmId history • Sample usage: http://<server>:<port>/api/v1/alarm/1f478decalarm/history • Returned value: Field Type Description 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‌ • API Name: Get topology object current alarms • Description: Filter out current alarms by the ID of a topology object. • Request type: GET • API path: /api/v1/alarm/current/topologyId • Sample usage: http://<server>:<port>/api/v1/alarm/current/se478dec-f920-4da94de9-a8d2-b9ba0dcd4394 b9ba0dcasd94 • Header: 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. • Returned value: Field Type Description 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‌ • API Name: Get topology object history alarms • Description: Filter out history alarms by the ID of a topology object. • Request type: GET • API path: /api/v1/alarm/history/topologyId • Sample usage: http://<server>:<port>/api/v1/alarm/history/se478dec-f920-4de9-a8d2-b9ba0dcasd94 • Returned value: Field Type Description 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‌ • API Name: 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. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Request type: POST • API path: /api/v1/alarm/pushAlarm • Sample usage: When using the pushAlarm API, note the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule — Get all rules’ data API. ▫ Execute the following scripts in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = server.RuleService.getAllRules().find{ xx.xxxx == ruleName } if(rule){ return xxxx.xx; }else{ return "Rule not found." } The following illustrates the sample code of request body in XML and JSON separately. Request body in XML: <externalAlarmParamBean> <alarmMessage>title of alarm dialog. alarm message</alarmMessage> <severity>3</severity> <topologyObjectId>94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> Value Description 2 Warning 3 Critical 4 Fatal • Header: