XiqAlertRule.md

extremecloudiq.model.xiq_alert_rule.XiqAlertRule

The state for a configured alert rule

Model Type Info

Input Type	Accessed Type	Description	Notes
dict, frozendict.frozendict,	frozendict.frozendict,	The state for a configured alert rule

Dictionary Keys

Key	Input Type	Accessed Type	Description	Notes
is_enabled	bool,	BoolClass,	True if this rule is active and enabled.
trigger_type	str,	str,	The configured trigger type of the rule.
id	decimal.Decimal, int,	decimal.Decimal,	The unique identifier	value must be a 64 bit integer
severity_id	decimal.Decimal, int,	decimal.Decimal,	The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.	value must be a 64 bit integer
message_metadata_id	decimal.Decimal, int,	decimal.Decimal,	The identifier for the unique message type that corresponds to this rule.	value must be a 64 bit integer
message_metadata_name	str,	str,	The display name for the message.	[optional]
message_metadata_type	str,	str,	The type of the message.	[optional]
description	str,	str,	This is a description for the alert rule.	[optional]
severity_name	str,	str,	The display name for the alert severity.	[optional]
duration	decimal.Decimal, int,	decimal.Decimal,	Has value when trigger_type is "DEFERRED". The deferred duration, in seconds.	[optional] value must be a 32 bit integer
time_window	decimal.Decimal, int,	decimal.Decimal,	Has value when trigger_type is "REPEATED". The time window to count the number of repeated messages, in seconds.	[optional] value must be a 32 bit integer
count	decimal.Decimal, int,	decimal.Decimal,	Has value when trigger_type is "REPEATED". The lower bound of the number of messages required to trigger this rule.	[optional] value must be a 32 bit integer
threshold	decimal.Decimal, int, float,	decimal.Decimal,	Has value when type is "METRIC". The threshold for the message.	[optional] value must be a 64 bit float
unit	str,	str,	The unit of this threshold	[optional]
operator	str,	str,	Has value when message_metadata_type is "METRIC". The operator to compare against the threshold.	[optional]
any_string_name	dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader	frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO	any string name can be used but the value must be the correct type	[optional]

[Back to Model list] [Back to API list] [Back to README]