The Alarm
class inherits from Resource
.
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()
and
Resource.existing()
.
Parameters: |
|
---|
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
enabled
= None¶True
if this alarm is enabled
insufficient_data_actions
= None¶The actions to do when alarm state changes to insufficient data
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
repeat_actions
= None¶The actions should be re-triggered on each evaluation cycle
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
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
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.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.