openstack.telemetry.v2.alarm¶
The Alarm Class¶
The Alarm
class inherits from Resource
.
-
class
openstack.telemetry.v2.alarm.
Alarm
(attrs=None, loaded=False)¶ Caution
This API is a work in progress and is subject to change.
Construct a Resource to interact with a service’s REST API.
The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See
Resource.new()
andResource.existing()
.Parameters: - attrs (dict) – The attributes to set when constructing this Resource.
- loaded (bool) –
True
if this Resource exists on the server,False
if it does not.
-
alarm_actions
= None¶ The actions to do when alarm state changes to alarm
-
alarm_id
= None¶ The ID of the alarm
-
description
= None¶ The description of the alarm
-
is_enabled
= None¶ True
if this alarm is enabled. Type: bool
-
insufficient_data_actions
= None¶ The actions to do when alarm state changes to insufficient data
-
is_repeat_actions
= None¶ The actions should be re-triggered on each evaluation cycle. Type: bool
-
name
= None¶ The name for the alarm
-
ok_actions
= None¶ The actions to do when alarm state change to ok
-
project_id
= None¶ The ID of the project that owns the alarm
-
severity
= None¶ The severity of the alarm
-
state
= None¶ The state off the alarm
-
state_changed_at
= None¶ The timestamp of the last alarm state change. Type: datetime object parsed from ISO 8601 formatted string
-
time_constraints
= None¶ Describe time constraints for the alarm
-
type
= None¶ Explicit type specifier to select which rule to follow
-
updated_at
= None¶ The timestamp of the last alarm definition update. Type: datetime object parsed from ISO 8601 formatted string
-
user_id
= None¶ The ID of the user who created the alarm
-
change_state
(session, next_state)¶ Set the state of an alarm.
The next_state may be one of: ‘ok’ ‘insufficient data’ ‘alarm’
-
check_state
(session)¶ Retrieve the current state of an alarm from the service.
The properties of the alarm are not modified.