AlarmStatusSummary¶

class oci.monitoring.models.AlarmStatusSummary(**kwargs)¶

Bases: object

A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see Alarms Overview.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Attributes

`SEVERITY_CRITICAL`	A constant which can be used with the severity property of a AlarmStatusSummary.
`SEVERITY_ERROR`	A constant which can be used with the severity property of a AlarmStatusSummary.
`SEVERITY_INFO`	A constant which can be used with the severity property of a AlarmStatusSummary.
`SEVERITY_WARNING`	A constant which can be used with the severity property of a AlarmStatusSummary.
`STATUS_FIRING`	A constant which can be used with the status property of a AlarmStatusSummary.
`STATUS_OK`	A constant which can be used with the status property of a AlarmStatusSummary.
`STATUS_SUSPENDED`	A constant which can be used with the status property of a AlarmStatusSummary.
`alarm_summary`	[Required] Gets the alarm_summary of this AlarmStatusSummary.
`display_name`	[Required] Gets the display_name of this AlarmStatusSummary.
`id`	[Required] Gets the id of this AlarmStatusSummary.
`rule_name`	[Required] Gets the rule_name of this AlarmStatusSummary.
`severity`	[Required] Gets the severity of this AlarmStatusSummary.
`status`	[Required] Gets the status of this AlarmStatusSummary.
`suppression`	Gets the suppression of this AlarmStatusSummary.
`timestamp_triggered`	[Required] Gets the timestamp_triggered of this AlarmStatusSummary.

Methods

__init__(**kwargs) Initializes a new AlarmStatusSummary object with values from keyword arguments.

SEVERITY_CRITICAL = 'CRITICAL'¶: A constant which can be used with the severity property of a AlarmStatusSummary. This constant has a value of “CRITICAL”

SEVERITY_ERROR = 'ERROR'¶: A constant which can be used with the severity property of a AlarmStatusSummary. This constant has a value of “ERROR”

SEVERITY_INFO = 'INFO'¶: A constant which can be used with the severity property of a AlarmStatusSummary. This constant has a value of “INFO”

SEVERITY_WARNING = 'WARNING'¶: A constant which can be used with the severity property of a AlarmStatusSummary. This constant has a value of “WARNING”

STATUS_FIRING = 'FIRING'¶: A constant which can be used with the status property of a AlarmStatusSummary. This constant has a value of “FIRING”

STATUS_OK = 'OK'¶: A constant which can be used with the status property of a AlarmStatusSummary. This constant has a value of “OK”

STATUS_SUSPENDED = 'SUSPENDED'¶: A constant which can be used with the status property of a AlarmStatusSummary. This constant has a value of “SUSPENDED”

__init__(**kwargs)¶

Initializes a new AlarmStatusSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this AlarmStatusSummary.
display_name (str) – The value to assign to the display_name property of this AlarmStatusSummary.
severity (str) – The value to assign to the severity property of this AlarmStatusSummary. Allowed values for this property are: “CRITICAL”, “ERROR”, “WARNING”, “INFO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
rule_name (str) – The value to assign to the rule_name property of this AlarmStatusSummary.
timestamp_triggered (datetime) – The value to assign to the timestamp_triggered property of this AlarmStatusSummary.
alarm_summary (str) – The value to assign to the alarm_summary property of this AlarmStatusSummary.
status (str) – The value to assign to the status property of this AlarmStatusSummary. Allowed values for this property are: “FIRING”, “OK”, “SUSPENDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
suppression (oci.monitoring.models.Suppression) – The value to assign to the suppression property of this AlarmStatusSummary.

alarm_summary¶

[Required] Gets the alarm_summary of this AlarmStatusSummary. Customizable alarm summary (alarmSummary alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to list_alarms_status() get_alarm_history() and retrieve_dimension_states().

Returns:	The alarm_summary of this AlarmStatusSummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this AlarmStatusSummary. The configured name of the alarm.

Example: High CPU Utilization

Returns:	The display_name of this AlarmStatusSummary.
Return type:	str

id¶

[Required] Gets the id of this AlarmStatusSummary. The OCID of the alarm.

Returns:	The id of this AlarmStatusSummary.
Return type:	str

rule_name¶

[Required] Gets the rule_name of this AlarmStatusSummary. Identifier of the alarm’s base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see alarm_override().

Returns:	The rule_name of this AlarmStatusSummary.
Return type:	str

severity¶

[Required] Gets the severity of this AlarmStatusSummary. The perceived type of response required when the alarm is in the “FIRING” state.

Example: CRITICAL

Allowed values for this property are: “CRITICAL”, “ERROR”, “WARNING”, “INFO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The severity of this AlarmStatusSummary.
Return type:	str

status¶

[Required] Gets the status of this AlarmStatusSummary. The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use retrieve_dimension_states(). Example: FIRING

Allowed values for this property are: “FIRING”, “OK”, “SUSPENDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this AlarmStatusSummary.
Return type:	str

suppression¶

Gets the suppression of this AlarmStatusSummary. The configuration details for suppressing an alarm.

Returns:	The suppression of this AlarmStatusSummary.
Return type:	oci.monitoring.models.Suppression

timestamp_triggered¶

[Required] Gets the timestamp_triggered of this AlarmStatusSummary. Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics.

Example: 2023-02-01T01:02:29.600Z

Returns:	The timestamp_triggered of this AlarmStatusSummary.
Return type:	datetime