The aodh.api.controllers.v2.alarms Module

class aodh.api.controllers.v2.alarms.Alarm(rule=None, time_constraints=None, **kwargs)

Bases: aodh.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)

static check_alarm_actions(alarm)

static check_rule(alarm)

delete_actions()

get_description()

classmethod sample()

set_description(value)

update_actions(old_alarm=None)

static validate(alarm)

class aodh.api.controllers.v2.alarms.AlarmChange(**kw)

Bases: aodh.api.controllers.v2.base.Base

Representation of an event in an alarm’s history.

classmethod sample()

class aodh.api.controllers.v2.alarms.AlarmController(alarm_id)

Bases: pecan.rest.RestController

Manages operations on a single alarm.

delete(*args, **kwargs)

Delete this alarm.

get(*args, **kwargs)

Return this alarm.

get_state(*args, **kwargs)

Get the state of this alarm.

history(*args, **kwargs)

Assembles the alarm history requested.

Parameters:

• q – Filter rules for the changes to be described.
• sort – A list of pairs of sort key and sort dir.
• limit – The maximum number of items to be return.
• marker – The pagination query marker.

put(*args, **kwargs)

Modify this alarm.

Parameters:data – an alarm within the request body.

put_state(*args, **kwargs)

Set the state of this alarm.

Parameters:state – an alarm state within the request body.

class aodh.api.controllers.v2.alarms.AlarmTimeConstraint(**kw)

Bases: aodh.api.controllers.v2.base.Base

Representation of a time constraint on an alarm.

as_dict()

get_description()

classmethod sample()

set_description(value)

static validate(tc)

class aodh.api.controllers.v2.alarms.AlarmsController

Bases: pecan.rest.RestController

Manages operations on the alarms collection.

get_all(*args, **kwargs)

Return all alarms, based on the query provided.

Parameters:

• q – Filter rules for the alarms to be returned.
• sort – A list of pairs of sort key and sort dir.
• limit – The maximum number of items to be return.
• marker – The pagination query marker.

post(*args, **kwargs)

Create a new alarm.

Parameters:data – an alarm within the request body.

class aodh.api.controllers.v2.alarms.CronType

Bases: wsme.types.UserType

A user type that represents a cron format.

static validate(value)

exception aodh.api.controllers.v2.alarms.OverQuota(data)

Bases: aodh.api.controllers.v2.base.ClientSideError