AlarmSummary¶

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

Bases: object

A summary of properties for the specified alarm. 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 AlarmSummary.
`SEVERITY_ERROR`	A constant which can be used with the severity property of a AlarmSummary.
`SEVERITY_INFO`	A constant which can be used with the severity property of a AlarmSummary.
`SEVERITY_WARNING`	A constant which can be used with the severity property of a AlarmSummary.
`compartment_id`	[Required] Gets the compartment_id of this AlarmSummary.
`defined_tags`	Gets the defined_tags of this AlarmSummary.
`destinations`	[Required] Gets the destinations of this AlarmSummary.
`display_name`	[Required] Gets the display_name of this AlarmSummary.
`freeform_tags`	Gets the freeform_tags of this AlarmSummary.
`id`	[Required] Gets the id of this AlarmSummary.
`is_enabled`	[Required] Gets the is_enabled of this AlarmSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AlarmSummary.
`metric_compartment_id`	[Required] Gets the metric_compartment_id of this AlarmSummary.
`namespace`	[Required] Gets the namespace of this AlarmSummary.
`query`	[Required] Gets the query of this AlarmSummary.
`severity`	[Required] Gets the severity of this AlarmSummary.
`suppression`	Gets the suppression of this AlarmSummary.

Methods

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new AlarmSummary 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 AlarmSummary.
display_name (str) – The value to assign to the display_name property of this AlarmSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AlarmSummary.
metric_compartment_id (str) – The value to assign to the metric_compartment_id property of this AlarmSummary.
namespace (str) – The value to assign to the namespace property of this AlarmSummary.
query (str) – The value to assign to the query property of this AlarmSummary.
severity (str) – The value to assign to the severity property of this AlarmSummary. 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’.
destinations (list[str]) – The value to assign to the destinations property of this AlarmSummary.
suppression (oci.monitoring.models.Suppression) – The value to assign to the suppression property of this AlarmSummary.
is_enabled (bool) – The value to assign to the is_enabled property of this AlarmSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlarmSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlarmSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlarmSummary.

compartment_id¶

[Required] Gets the compartment_id of this AlarmSummary. The OCID of the compartment containing the alarm.

Returns:	The compartment_id of this AlarmSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this AlarmSummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this AlarmSummary.
Return type:	dict(str, dict(str, object))

destinations¶

[Required] Gets the destinations of this AlarmSummary. A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.

Returns:	The destinations of this AlarmSummary.
Return type:	list[str]

display_name¶

[Required] Gets the display_name of this AlarmSummary. A user-friendly name for the alarm. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

This name is sent as the title for notifications related to this alarm.

Example: High CPU Utilization

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

freeform_tags¶

Gets the freeform_tags of this AlarmSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this AlarmSummary.
Return type:	dict(str, str)

id¶

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

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

is_enabled¶

[Required] Gets the is_enabled of this AlarmSummary. Whether the alarm is enabled.

Example: true

Returns:	The is_enabled of this AlarmSummary.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this AlarmSummary. The current lifecycle state of the alarm.

Example: DELETED

Returns:	The lifecycle_state of this AlarmSummary.
Return type:	str

metric_compartment_id¶

[Required] Gets the metric_compartment_id of this AlarmSummary. The OCID of the compartment containing the metric being evaluated by the alarm.

Returns:	The metric_compartment_id of this AlarmSummary.
Return type:	str

namespace¶

[Required] Gets the namespace of this AlarmSummary. The source service or application emitting the metric that is evaluated by the alarm.

Example: oci_computeagent

Returns:	The namespace of this AlarmSummary.
Return type:	str

query¶

[Required] Gets the query of this AlarmSummary. The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.

Example of threshold alarm:

CpuUtilization[1m]{availabilityDomain=”cumS:PHX-AD-1”}.groupBy(availabilityDomain).percentile(0.9) > 85

Example of absence alarm:

CpuUtilization[1m]{availabilityDomain=”cumS:PHX-AD-1”}.absent()

Returns:	The query of this AlarmSummary.
Return type:	str

severity¶

[Required] Gets the severity of this AlarmSummary. The perceived severity of the alarm with regard to the affected system.

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 AlarmSummary.
Return type:	str

suppression¶

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

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