InlineAlarm1

JSON Example

{
    "alarm_source": [
        "string"
    ],
    "alarm_source_type": "string",
    "description": "string",
    "entity_id": "string",
    "entity_resource_type": "string",
    "event_tags": [
        "string"
    ],
    "event_type": "string",
    "event_type_display_name": "string",
    "feature_display_name": "string",
    "feature_name": "string",
    "id": "string",
    "kb_article": "string",
    "last_reported_time": 0,
    "node_display_name": "string",
    "node_id": "string",
    "node_ip_addresses": [
        "string"
    ],
    "node_resource_type": "string",
    "recommended_action": "string",
    "reoccurrences_while_suppressed": 0,
    "resolved_by": "string",
    "resolved_time": 0,
    "runtime_data": "string",
    "severity": "string",
    "status": "string",
    "summary": "string",
    "suppress_duration": 0,
    "suppress_start_time": 0,
    "suppressed_by": "string"
}

array of string

alarm_source

Optional

If alarm_source_type = INTENT_PATH, this field will contain a list of intent paths for the entity that the event instance applies to. If alarm_source_type = ENTITY_ID, this field will contain a list with a single item identifying the entity id that the event instance applies to.

string

alarm_source_type

Optional

Type of alarm source of the Event instance. Can be one of - INTENT_PATH, ENTITY_ID.

Possible values are : INTENT_PATH, ENTITY_ID, SYSTEM_ID,

string

description

Optional

Detailed description of Alarm. This is the same detailed description as the corresponding Event identified by feature_name.event_type.

string

entity_id

Optional

The entity that the Event instance applies to. Note entity_id may not be included in a response body. For example, the cpu_high Event may not return an entity_id.

string

entity_resource_type

Optional

The entity type that the Event instance applies to.

array of string

event_tags

Optional

Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.

string

event_type

Optional

Name of Event, e.g. manager_cpu_usage_high, certificate_expired.

string

event_type_display_name

Optional

Display name of Event type.

string

feature_display_name

Optional

Display name of feature defining this Event.

string

feature_name

Optional

Feature defining this Event, e.g. manager_health, certificates.

string

Optional

ID that uniquely identifies an Alarm.

string

kb_article

Optional

KB article link that contains more information on this alarm and recommended actions. Users can refer to the specified link if needed.

integer As int64 As int64

last_reported_time

Optional

Indicates when the corresponding Event instance was last reported in milliseconds since epoch.

string

node_display_name

Optional

Display name of node that the event instance applies to.

string

node_id

Optional

The UUID of the node that the Event instance applies to.

array of string

node_ip_addresses

Optional

IP addresses of node that the event instance applies to.

string

node_resource_type

Optional

The resource type of node that the Event instance applies to eg. ClusterNodeConfig, TransportNode.

string

recommended_action

Optional

Recommended action for Alarm. This is the same action as the corresponding Event identified by feature_name.event_type.

integer As int64 As int64

reoccurrences_while_suppressed

Optional

The number of reoccurrences since this alarm has been SUPPRESSED.

string

resolved_by

Optional

User ID of the user that set the status value to RESOLVED. This value can be SYSTEM to indicate that the system resolved the Alarm, for example when the system determines CPU usage is no longer high and the cpu_high Alarm is no longer applicable. This property is only returned when the status value is RESOLVED.

integer As int64 As int64

resolved_time

Optional

Indicates when the Alarm was resolved in milliseconds since epoch. This property is only returned when the status value is RESOLVED.

string

runtime_data

Optional

Runtime data for Alarm. When an alarming condition occurs, there may be additional data of interest when triaging the underlying issue, for example, output from system commands captured at the time of the error. Note, the contents of this property are not localized.

string

severity

Optional

Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.

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

string

status

Required

Indicate the status which the Alarm is in.

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

string

summary

Optional

Summary description of Alarm. This is the same summary description as the corresponding Event identified by feature_name.event_type.

integer As int64 As int64

suppress_duration

Optional

The time period between suppress_start_time and suppress_start_time + suppress_duration (specified in hours) an Alarm is SUPPRESSED. This property is only returned when the status value is SUPPRESSED.

integer As int64 As int64

suppress_start_time

Optional

Indicates when the Alarm was suppressed in milliseconds since epoch. This property is only returned when the status value is SUPPRESSED.

string

suppressed_by

Optional

User ID of the user that set the status value to SUPPRESSED. This property is only returned when the status value is SUPPRESSED.

Used By

Alarm