alarm DataStream¶
alarm DataStream contains summarized alarms state
Fields¶
| Name | Type | Description |
|---|---|---|
| id | String | Alarm Id |
| timestamp | String | ISO 8601 timestamp (i.e. YYYY-MM-DDTHH:MM:SS) of alarm rising |
| clear_timestamp | String | ISO 8601 timestamp (i.e. YYYY-MM-DDTHH:MM:SS) of alarm clearange (for closed alarms only) |
| severity | Integer | Alarm severity |
| root | String | ID of root alarm (for consequences only) |
| object | Object | Managed Object |
| id | String | Managed Object's ID |
| object_profile | Object | Managed Object Profile |
| id | String | Managed Object Profile's ID |
| name | String | Managed Object Profile's Name |
| remote_system | Object | Managed Object's Remote System (if imported) |
| id | String | Remote System's ID |
| name | String | Remote System's Name |
| remote_id | String | Managed Object's ID in Remote System (if any) |
| alarm_class | String | Alarm Class |
| id | String | Alarm Class' ID |
| name | String | Alarm Class' Name |
| vars | Object | Key-value dictionary of alarm's variables |
| reopens | Integer | Number of alarm's reopens |
| tags | Object | Alarm tags |
| escalation | Object | Escalation data (if escalated) |
| timestamp | String | Escalation timestamp in ISO 8601 format |
| tt_system | Object | TT System to escalate |
| id | String | TT System's ID |
| name | String | TT System's name |
| error | String | Escalation error text (if any) |
| tt_id | String | TT ID |
| close_timestamp | String | Escalation closing timestamp in ISO 8601 format (if closed) |
| close_error | String | Escalation closing error text (if any) |
| direct_services | Object | Summary of services directly affected by alarm |
| profile | Object | Service Profile |
| id | String | Service Profile's ID |
| name | String | Service Profile's name |
| summary | Integer | Number of affected services |
| total_services | Object | Summary of services directly affected by alarm and all consequences |
| profile | Object | Service Profile |
| id | String | Service Profile's ID |
| name | String | Service Profile's name |
| summary | String | Number of affected services |
| direct_subscribers | Object | Summary of subscribers directly affected by alarm |
| profile | Object | Subscriber Profile |
| id | String | Subscriber Profile's ID |
| name | String | Subscriber Profile's name |
| summary | Integer | Subscriber Profile's summary |
| total_subscribers | Object | Summary of subscribers directly affected by alarm and all consequences |
| profile | Object | Subscriber Profile |
| id | String | Subscriber Profile's ID |
| name | String | Subscriber Profile's name |
| summary | Integer | Subscriber Profile's summary |
Access¶
API Key with datastream:alarm permissions
required.