Oracle® Communications Services Gatekeeper Partner Relationship Management Guide Release 5.1 E37536-01 |
|
|
PDF · Mobi · ePub |
The Operator Alarm Utility Web Service allows the Operator to retrieve alarms from Oracle Communications Services Gatekeeper.
The endpoint for this interface is: http://<host>:<port>/prm_op/services/OpAlarmUtil
where the value of host and port depend on the Oracle Communications Services Gatekeeper deployment.
Counts the number of alarms of a certain type of a given severity for a specified time interval.
Table 13-1 countAlarms(alarmId, severity, fromDate, toDate)
Parameter Name | Type | Description |
---|---|---|
alarmId |
xsd:int |
Input parameter. The ID of the type of alarm. |
severity |
tns1:AlarmSeverity |
Input parameter. Severity of the alarm. See "AlarmSeverity". Use null to not filter on this parameter |
fromDate |
xsd:dateTime |
Input parameter. Start date and time. Use null to not filter on this parameter. |
toDate |
xsd:dateTime |
Input parameter. End date and time. Use null to not filter on this parameter. |
countAlarmsReturn |
xsd:long |
Return parameter. The number of alarms. |
ACCESS_DENIED |
N/A |
Exception |
CommonException |
N/A |
Exception |
Retrieves all alarms matching the given criteria.
Table 13-2 listAlarms(alarmId, severity, fromDate, toDate, startIndex, maxEntries)
Parameter Name | Type | Description |
---|---|---|
alarmId |
xsd:int |
Input parameter. The ID of the type of alarm. |
severity |
tns1:AlarmSeverity |
Input parameter. Severity of the alarm. See "AlarmSeverity". Use null to not filter on this parameter. |
fromDate |
xsd:dateTime |
Input parameter. From date and time.Use null to not filter on this parameter. |
toDate |
xsd:dateTime |
Input parameter. To date and time. Use null to not filter on this parameter. |
startIndex |
xsd:long |
Input parameter. Which entry, in the overall result set, to start the result list on (cursor). |
maxEntries |
xsd:int |
Input parameter. The maximum number of alarms returned. |
listAlarmsReturn |
Array of tns1:AlarmInfo |
Return parameter. List of alarms. See "AlarmInfo". |
ACCESS_DENIED |
N/A |
Exception |
CommonException |
N/A |
Exception |
These complex data types are used by this interface.
Data structure defining an alarm.
Element name | Datatype | Description |
---|---|---|
alarmInstanceId |
xsd:long |
The ID of the emitted alarm. Unique identifier for an emitted alarm. |
alarmId |
xsd:int |
The identifier for the alarm type. |
source |
xsd:string |
Specifies the name of the software module that raised the alarm and the IP address of the server the service is installed in. |
severity |
tns1:AlarmSeverity |
Specifies the alarm's severity level. See "AlarmSeverity". |
timeStamp |
xsd:dateTime |
Specifies the time and date the alarm was raised. |
info |
xsd:string |
Alarm information provided by the software module the raised the alarm. |
additional_info |
xsd:string |
Additional information depending on context. |