The ceilometer.api.controllers.v2 ModuleΒΆ

Version 2 of the API.

class ceilometer.api.controllers.v2.AdvEnum(name, *args, **kwargs)[source]

Bases: wsme.types.wsproperty

Handle default and mandatory for wtypes.Enum.

class ceilometer.api.controllers.v2.Aggregate(**kwargs)[source]

Bases: ceilometer.api.controllers.v2._Base

classmethod Aggregate.sample()[source]
static Aggregate.validate(aggregate)[source]
class ceilometer.api.controllers.v2.Alarm(rule=None, time_constraints=None, **kwargs)[source]

Bases: ceilometer.api.controllers.v2._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.

Alarm.as_dict(db_model)[source]
static Alarm.check_alarm_actions(alarm)[source]
static Alarm.check_rule(alarm)[source]
Alarm.get_description()[source]
classmethod Alarm.sample()[source]
Alarm.set_description(value)[source]
static Alarm.validate(alarm)[source]
class ceilometer.api.controllers.v2.AlarmChange(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

Representation of an event in an alarm’s history.

classmethod AlarmChange.sample()[source]
class ceilometer.api.controllers.v2.AlarmCombinationRule(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

AlarmCombinationRule.as_dict()[source]
classmethod AlarmCombinationRule.sample()[source]
static AlarmCombinationRule.validate(rule)[source]
class ceilometer.api.controllers.v2.AlarmController(alarm_id)[source]

Bases: pecan.rest.RestController

Manages operations on a single alarm.

AlarmController.delete(*args, **kwargs)[source]

Delete this alarm.

AlarmController.get(*args, **kwargs)[source]

Return this alarm.

AlarmController.get_state(*args, **kwargs)[source]

Get the state of this alarm.

AlarmController.history(*args, **kwargs)[source]

Assembles the alarm history requested.

Parameters:q – Filter rules for the changes to be described.
AlarmController.put(*args, **kwargs)[source]

Modify this alarm.

Parameters:data – an alarm within the request body.
AlarmController.put_state(*args, **kwargs)[source]

Set the state of this alarm.

Parameters:state – an alarm state within the request body.
exception ceilometer.api.controllers.v2.AlarmNotFound(alarm, auth_project)[source]

Bases: ceilometer.api.controllers.v2.ClientSideError

class ceilometer.api.controllers.v2.AlarmThresholdRule(query=None, **kwargs)[source]

Bases: ceilometer.api.controllers.v2._Base

AlarmThresholdRule.as_dict()[source]
classmethod AlarmThresholdRule.sample()[source]
static AlarmThresholdRule.validate(threshold_rule)[source]
class ceilometer.api.controllers.v2.AlarmTimeConstraint(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

Representation of a time constraint on an alarm.

AlarmTimeConstraint.as_dict()[source]
AlarmTimeConstraint.get_description()[source]
classmethod AlarmTimeConstraint.sample()[source]
AlarmTimeConstraint.set_description(value)[source]
static AlarmTimeConstraint.validate(tc)[source]
class ceilometer.api.controllers.v2.AlarmsController[source]

Bases: pecan.rest.RestController

Manages operations on the alarms collection.

AlarmsController.get_all(*args, **kwargs)[source]

Return all alarms, based on the query provided.

Parameters:q – Filter rules for the alarms to be returned.
AlarmsController.post(*args, **kwargs)[source]

Create a new alarm.

Parameters:data – an alarm within the request body.
class ceilometer.api.controllers.v2.Capabilities(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

A representation of the API and storage capabilities.

Usually constrained by restrictions imposed by the storage driver.

classmethod Capabilities.sample()[source]
class ceilometer.api.controllers.v2.CapabilitiesController[source]

Bases: pecan.rest.RestController

Manages capabilities queries.

CapabilitiesController.get(*args, **kwargs)[source]

Returns a flattened dictionary of API capabilities.

Capabilities supported by the currently configured storage driver.

exception ceilometer.api.controllers.v2.ClientSideError(error, status_code=400)[source]

Bases: wsme.exc.ClientSideError

class ceilometer.api.controllers.v2.ComplexQuery(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

Holds a sample query encoded in json.

classmethod ComplexQuery.sample()[source]
class ceilometer.api.controllers.v2.CronType[source]

Bases: wsme.types.UserType

A user type that represents a cron format.

static CronType.validate(value)[source]
exception ceilometer.api.controllers.v2.EntityNotFound(entity, id)[source]

Bases: ceilometer.api.controllers.v2.ClientSideError

class ceilometer.api.controllers.v2.Event(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

A System event.

Event.get_traits()[source]
classmethod Event.sample()[source]
Event.set_traits(traits)[source]
class ceilometer.api.controllers.v2.EventQuery(**kw)[source]

Bases: ceilometer.api.controllers.v2.Query

Query arguments for Event Queries.

class ceilometer.api.controllers.v2.EventTypesController[source]

Bases: pecan.rest.RestController

Works on Event Types in the system.

EventTypesController.get_all(*args, **kwargs)[source]

Get all event types.

EventTypesController.get_one(event_type)[source]
class ceilometer.api.controllers.v2.EventsController[source]

Bases: pecan.rest.RestController

Works on Events.

EventsController.get_all(*args, **kwargs)[source]

Return all events matching the query filters.

Parameters:q – Filter arguments for which Events to return
EventsController.get_one(*args, **kwargs)[source]

Return a single event with the given message id.

Parameters:message_id – Message ID of the Event to be returned
class ceilometer.api.controllers.v2.Link(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

A link representation.

classmethod Link.sample()[source]
class ceilometer.api.controllers.v2.Meter(**kwargs)[source]

Bases: ceilometer.api.controllers.v2._Base

One category of measurements.

classmethod Meter.sample()[source]
class ceilometer.api.controllers.v2.MeterController(meter_name)[source]

Bases: pecan.rest.RestController

Manages operations on a single meter.

MeterController.get_all(*args, **kwargs)[source]

Return samples for the meter.

Parameters:
  • q – Filter rules for the data to be returned.
  • limit – Maximum number of samples to return.
MeterController.post(*args, **kwargs)[source]

Post a list of new Samples to Telemetry.

Parameters:samples – a list of samples within the request body.
MeterController.statistics(*args, **kwargs)[source]

Computes the statistics of the samples in the time range given.

Parameters:
  • q – Filter rules for the data to be returned.
  • groupby – Fields for group by aggregation
  • period – Returned result will be an array of statistics for a period long of that number of seconds.
  • aggregate – The selectable aggregation functions to be applied.
class ceilometer.api.controllers.v2.MetersController[source]

Bases: pecan.rest.RestController

Works on meters.

MetersController.get_all(*args, **kwargs)[source]

Return all known meters, based on the data recorded so far.

Parameters:q – Filter rules for the meters to be returned.
class ceilometer.api.controllers.v2.OldSample(counter_volume=None, resource_metadata=None, timestamp=None, **kwds)[source]

Bases: ceilometer.api.controllers.v2._Base

A single measurement for a given meter and resource.

This class is deprecated in favor of Sample.

classmethod OldSample.sample()[source]
exception ceilometer.api.controllers.v2.OverQuota(data)[source]

Bases: ceilometer.api.controllers.v2.ClientSideError

exception ceilometer.api.controllers.v2.ProjectNotAuthorized(id, aspect='project')[source]

Bases: ceilometer.api.controllers.v2.ClientSideError

class ceilometer.api.controllers.v2.Query(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

Query filter.

Query.as_dict()[source]
Query.get_op()[source]
classmethod Query.sample()[source]
Query.set_op(value)[source]
class ceilometer.api.controllers.v2.QueryAlarmHistoryController[source]

Bases: pecan.rest.RestController

Provides complex query possibilities for alarm history.

QueryAlarmHistoryController.post(*args, **kwargs)[source]

Define query for retrieving AlarmChange data.

Parameters:body – Query rules for the alarm history to be returned.
class ceilometer.api.controllers.v2.QueryAlarmsController[source]

Bases: pecan.rest.RestController

Provides complex query possibilities for alarms.

QueryAlarmsController.post(*args, **kwargs)[source]

Define query for retrieving Alarm data.

Parameters:body – Query rules for the alarms to be returned.
class ceilometer.api.controllers.v2.QueryController[source]

Bases: pecan.rest.RestController

class ceilometer.api.controllers.v2.QuerySamplesController[source]

Bases: pecan.rest.RestController

Provides complex query possibilities for samples.

QuerySamplesController.post(*args, **kwargs)[source]

Define query for retrieving Sample data.

Parameters:body – Query rules for the samples to be returned.
class ceilometer.api.controllers.v2.Resource(metadata=None, **kwds)[source]

Bases: ceilometer.api.controllers.v2._Base

An externally defined object for which samples have been received.

classmethod Resource.sample()[source]
class ceilometer.api.controllers.v2.ResourcesController[source]

Bases: pecan.rest.RestController

Works on resources.

ResourcesController.get_all(*args, **kwargs)[source]

Retrieve definitions of all of the resources.

Parameters:
  • q – Filter rules for the resources to be returned.
  • meter_links – option to include related meter links
ResourcesController.get_one(*args, **kwargs)[source]

Retrieve details about one resource.

Parameters:resource_id – The UUID of the resource.
class ceilometer.api.controllers.v2.Sample(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

One measurement.

classmethod Sample.from_db_model(m)[source]
classmethod Sample.sample()[source]
class ceilometer.api.controllers.v2.SamplesController[source]

Bases: pecan.rest.RestController

Controller managing the samples.

SamplesController.get_all(*args, **kwargs)[source]

Return all known samples, based on the data recorded so far.

Parameters:
  • q – Filter rules for the samples to be returned.
  • limit – Maximum number of samples to be returned.
SamplesController.get_one(*args, **kwargs)[source]

Return a sample

Parameters:sample_id – the id of the sample
class ceilometer.api.controllers.v2.Statistics(start_timestamp=None, end_timestamp=None, **kwds)[source]

Bases: ceilometer.api.controllers.v2._Base

Computed statistics for a query.

classmethod Statistics.sample()[source]
class ceilometer.api.controllers.v2.Trait(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

A Trait associated with an event.

classmethod Trait.sample()[source]
class ceilometer.api.controllers.v2.TraitDescription(**kw)[source]

Bases: ceilometer.api.controllers.v2._Base

A description of a trait, with no associated value.

classmethod TraitDescription.sample()[source]
class ceilometer.api.controllers.v2.TraitsController[source]

Bases: pecan.rest.RestController

Works on Event Traits.

TraitsController.get_all(*args, **kwargs)[source]

Return all trait names for an event type.

Parameters:event_type – Event type to filter traits by
TraitsController.get_one(*args, **kwargs)[source]

Return all instances of a trait for an event type.

Parameters:
  • event_type – Event type to filter traits by
  • trait_name – Trait to return values for
class ceilometer.api.controllers.v2.V2Controller[source]

Bases: object

Version 2 API controller root.

class ceilometer.api.controllers.v2.ValidatedComplexQuery(query, db_model, additional_name_mapping=None, metadata_allowed=False)[source]

Bases: object

ValidatedComplexQuery.validate(visibility_field)[source]

Validates the query content and does the necessary conversions.

Previous topic

The ceilometer.api.controllers.root Module

Next topic

The ceilometer.api.controllers Module

This Page