56eed8c839
This is Ceilometer specific code that's not used in Aodh. Change-Id: Ida81435f4a0e1786e221e14ccd1aa79ea8017ce6
3.2 KiB
V2 Web API
Capabilities
The Capabilities API allows you to directly discover which functions from the V2 API functionality, including the selectable aggregate functions, are supported by the currently configured storage driver. A capabilities query returns a flattened dictionary of properties with associated boolean values -a 'False' or absent value means that the corresponding feature is not available in the backend.
aodh.api.controllers.v2.capabilities:CapabilitiesController
aodh.api.controllers.v2.capabilities.Capabilities
Alarms
aodh.api.controllers.v2.alarms:AlarmsController
aodh.api.controllers.v2.alarms:AlarmController
aodh.api.controllers.v2.alarms.Alarm
aodh.api.controllers.v2.alarm_rules.threshold.AlarmThresholdRule
aodh.api.controllers.v2.alarm_rules.combination.AlarmCombinationRule
aodh.api.controllers.v2.alarm_rules.gnocchi.MetricOfResourceRule
aodh.api.controllers.v2.alarm_rules.gnocchi.AggregationMetricByResourcesLookupRule
aodh.api.controllers.v2.alarm_rules.gnocchi.AggregationMetricsByIdLookupRule
aodh.api.controllers.v2.alarms.AlarmTimeConstraint
aodh.api.controllers.v2.alarms.AlarmChange
Filtering Queries
The filter expressions of the query feature operate on the fields of Alarm and AlarmChange. The following comparison operators are supported: =, !=, <, <=, >, >= and in; and the following logical operators can be used: and or and not. The field names are validated against the database models.
Note
The not operator has different meaning in Mongo DB and in SQL DB engine. If the not operator is applied on a non existent metadata field then the result depends on the DB engine. For example if {"not": {"metadata.nonexistent_field" : "some value"}} filter is used in a query the Mongo DB will return every Sample object as not operator evaluated true for every Sample where the given field does not exists. See more in the Mongod DB doc. On the other hand SQL based DB engine will return empty result as the join operation on the metadata table will return zero rows as the on clause of the join which tries to match on the metadata field name is never fulfilled.
Complex Query supports defining the list of orderby expressions in the form of [{"field_name": "asc"}, {"field_name2": "desc"}, ...].
The number of the returned items can be bounded using the limit option.
The filter, orderby and limit are all optional fields in a query.
aodh.api.controllers.v2.query:QueryAlarmsController
aodh.api.controllers.v2.query:QueryAlarmHistoryController
aodh.api.controllers.v2.query.ComplexQuery