pyrax
Python Bindings for the Rackspace Cloud
 All Classes Namespaces Files Functions Variables Properties
Public Member Functions
CloudMonitorEntity Class Reference
Inheritance diagram for CloudMonitorEntity:
BaseResource

List of all members.

Public Member Functions

def update
 Only the agent_id and metadata are able to be updated via the API.
def list_checks
 Returns a list of all CloudMonitorChecks defined for this entity.
def delete_check
 Deletes the specified check from this entity.
def list_metrics
 Returns a list of all the metrics associated with the specified check.
def get_metric_data_points
 Returns the data points for a given metric for the given period.
def create_alarm
 Creates an alarm that binds the check on this entity with a notification plan.
def update_alarm
 Updates an existing alarm on this entity.
def list_alarms
 Returns a list of all the alarms created on this entity.
def get_alarm
 Returns the alarm with the specified ID for this entity.
def delete_alarm
 Deletes the specified alarm.
def name

Member Function Documentation

def create_alarm (   self,
  check,
  notification_plan,
  criteria = None,
  disabled = False,
  label = None,
  name = None,
  metadata = None 
)

Creates an alarm that binds the check on this entity with a notification plan.

def delete_alarm (   self,
  alarm 
)

Deletes the specified alarm.

def delete_check (   self,
  check 
)

Deletes the specified check from this entity.

def get_alarm (   self,
  alarm 
)

Returns the alarm with the specified ID for this entity.

If a CloudMonitorAlarm instance is passed, returns a new CloudMonitorAlarm object with the current state from the API.

def get_metric_data_points (   self,
  check,
  metric,
  start,
  end,
  points = None,
  resolution = None,
  stats = None 
)

Returns the data points for a given metric for the given period.

The 'start' and 'end' times must be specified; they can be be either Python date/datetime values, or a Unix timestamp.

The 'points' parameter represents the number of points to return. The 'resolution' parameter represents the granularity of the data. You must specify either 'points' or 'resolution'. The allowed values for resolution are: FULL MIN5 MIN20 MIN60 MIN240 MIN1440

Finally, the 'stats' parameter specifies the stats you want returned. By default only the 'average' is returned. You omit this parameter, pass in a single value, or pass in a list of values. The allowed values are: average variance min max

def list_alarms (   self)

Returns a list of all the alarms created on this entity.

def list_checks (   self)

Returns a list of all CloudMonitorChecks defined for this entity.

def list_metrics (   self,
  check 
)

Returns a list of all the metrics associated with the specified check.

def name (   self)
def update (   self,
  agent = None,
  metadata = None 
)

Only the agent_id and metadata are able to be updated via the API.

def update_alarm (   self,
  alarm,
  criteria = None,
  disabled = False,
  label = None,
  name = None,
  metadata = None 
)

Updates an existing alarm on this entity.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties