InlineAlarmInstance1

InlineAlarmInstance1

JSON Example

{
    "definition_id": "string",
    "feature_name": "string",
    "event_type": "string",
    "feature_display_name": "string",
    "event_type_display_name": "string",
    "severity": "HIGH",
    "summary": "string",
    "recommended_action": "string",
    "kb_article": "string",
    "event_resource_type": "string",
    "event_resource_type_display_name": "string",
    "resource_id": "string",
    "object_id": "string",
    "node_id": "string",
    "value": "string",
    "state": "OPEN",
    "suppress_duration": 0,
    "state_transitions": {
        "acknowledged": {
            "at_time": 0,
            "by_user": "string"
        },
        "suppressed": {
            "at_time": 0,
            "by_user": "string"
        },
        "raised": {
            "at_time": 0,
            "by_user": "string"
        },
        "resolved": {
            "at_time": 0,
            "by_user": "string"
        }
    }
}

string

definition_id

Required

Corresponds to an AlarmDefinition's id.

string

feature_name

Required

The feature an alarm is associated with

string

event_type

Required

The event type an alarm is associated with

string

feature_display_name

Required

The localized name of a feature.

string

event_type_display_name

Required

The localized name of an event type.

Severity

severity

Required

The severity level of an alarm, indicating its importance and urgency:

• CRITICAL - Highest severity, requires immediate attention
• HIGH - Serious issue that should be addressed promptly
• MEDIUM - Important but not urgent issue
• INFORMATIONAL - Lowest severity, for awareness only

Possible values are : CRITICAL, HIGH, MEDIUM, INFORMATIONAL,

string

summary

Required

Summary for an alarm instance, meant to provide a brief overview.

string

recommended_action

Required

Recommended action so the alarm can be addressed.

string

kb_article

Required

Link to knowledge based article for more details on impact and remediations.

string

event_resource_type

Required

The resource type an alarm event is associated with

string

event_resource_type_display_name

Required

The display name for the event resource type

string

resource_id

Required

The identifier of the resource that the alarm instance was created for.

string

object_id

Required

A sub-object id within the resource.

string

node_id

Required

The UUID of the node that reported the value.

string

value

Required

The current reported value associated with the alarm.

AlarmInstanceState

state

Required

The current state of an alarm instance:

• ACKNOWLEDGED - The alarm has been seen and is being handled
• OPEN - The alarm is active and requires attention
• SUPPRESSED - The alarm is temporarily silenced
• RESOLVED - The alarm condition has been fixed or no longer exists

Possible values are : ACKNOWLEDGED, OPEN, SUPPRESSED, RESOLVED,

integer

suppress_duration

Optional

Constraints: minimum: 0 maximum: 12

How long this alarm instance should be suppressed for, in hours.

StateTransitions

state_transitions

Required

A collection of state transition events for an alarm instance, tracking when and how the alarm's state has changed over time. This includes transitions to acknowledged, suppressed, raised, and resolved states.

Used By

AlarmInstance