The ceilometer.api.controllers.v2.alarms
ModuleΒΆ
-
class
ceilometer.api.controllers.v2.alarms.
Alarm
(rule=None, time_constraints=None, **kwargs)[source] Bases:
ceilometer.api.controllers.v2.base.Base
Representation of an alarm.
Note
combination_rule and threshold_rule are mutually exclusive. The type of the alarm should be set to threshold or combination and the appropriate rule should be filled.
-
as_dict
(db_model)[source]
-
static
check_alarm_actions
(alarm)[source]
-
static
check_rule
(alarm)[source]
-
get_description
()[source]
-
classmethod
sample
()[source]
-
set_description
(value)[source]
-
static
validate
(alarm)[source]
-
-
class
ceilometer.api.controllers.v2.alarms.
AlarmChange
(**kw)[source] Bases:
ceilometer.api.controllers.v2.base.Base
Representation of an event in an alarm’s history.
-
classmethod
sample
()[source]
-
classmethod
-
class
ceilometer.api.controllers.v2.alarms.
AlarmController
(alarm_id)[source] Bases:
pecan.rest.RestController
Manages operations on a single alarm.
-
delete
(*args, **kwargs)[source] Delete this alarm.
-
get
(*args, **kwargs)[source] Return this alarm.
-
get_state
(*args, **kwargs)[source] Get the state of this alarm.
-
history
(*args, **kwargs)[source] Assembles the alarm history requested.
Parameters: q – Filter rules for the changes to be described.
-
put
(*args, **kwargs)[source] Modify this alarm.
Parameters: data – an alarm within the request body.
-
put_state
(*args, **kwargs)[source] Set the state of this alarm.
Parameters: state – an alarm state within the request body.
-
-
class
ceilometer.api.controllers.v2.alarms.
AlarmTimeConstraint
(**kw)[source] Bases:
ceilometer.api.controllers.v2.base.Base
Representation of a time constraint on an alarm.
-
as_dict
()[source]
-
get_description
()[source]
-
classmethod
sample
()[source]
-
set_description
(value)[source]
-
static
validate
(tc)[source]
-
-
class
ceilometer.api.controllers.v2.alarms.
AlarmsController
[source] Bases:
pecan.rest.RestController
Manages operations on the alarms collection.
-
get_all
(*args, **kwargs)[source] Return all alarms, based on the query provided.
Parameters: q – Filter rules for the alarms to be returned.
-
post
(*args, **kwargs)[source] Create a new alarm.
Parameters: data – an alarm within the request body.
-
-
class
ceilometer.api.controllers.v2.alarms.
CronType
[source] Bases:
wsme.types.UserType
A user type that represents a cron format.
-
static
validate
(value)[source]
-
static
-
exception
ceilometer.api.controllers.v2.alarms.
OverQuota
(data)[source] Bases:
ceilometer.api.controllers.v2.base.ClientSideError