Click or drag to resize
Check Class
This API is preliminary and subject to change.
This class represents an check in the IMonitoringService.
Inheritance Hierarchy

Namespace: net.openstack.Providers.Rackspace.Objects.Monitoring
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
[JsonObjectAttribute(MemberSerialization.OptIn)]
public class Check : CheckConfiguration

The Check type exposes the following members.

Properties
  NameDescription
Public propertyCheckTypeId
Gets the ID of the check type.
(Inherited from CheckConfiguration.)
Public propertyCreated
Gets a timestamp indicating when the check was first created.
Public propertyDetails
Gets a CheckDetails object describing the detailed properties specific to this type of check.
(Inherited from CheckConfiguration.)
Public propertyExtensionData
Gets a map of object properties which did not map to another field or property during JSON deserialization. The keys of the map represent the property names, and the values are JToken instances containing the parsed JSON values.
(Inherited from ExtensibleJsonObject.)
Public propertyId
Gets the unique identifier for the check.
Public propertyLabel
Gets the friendly name of the check.
(Inherited from CheckConfiguration.)
Public propertyLastModified
Gets a timestamp indicating when the check was last modified.
Public propertyMetadata
Gets a collection of custom metadata associated with the check.
(Inherited from CheckConfiguration.)
Public propertyMonitoringZonesPoll
Gets a collection of MonitoringZoneId objects identifying the monitoring zones to poll from.
(Inherited from CheckConfiguration.)
Public propertyPeriod
Gets the delay between check operations.
(Inherited from CheckConfiguration.)
Public propertyResolverType
Gets the type of resolver that should be used to convert the TargetHostname to an IP address.
(Inherited from CheckConfiguration.)
Public propertyTargetAlias
Gets the key for looking up the target for this check in the associated entity's IPAddresses map.
(Inherited from CheckConfiguration.)
Public propertyTargetHostname
Gets the target hostname this check should target.
(Inherited from CheckConfiguration.)
Public propertyTimeout
Gets the timeout for the check.
(Inherited from CheckConfiguration.)
Top
Remarks
A check is one of the foundational building blocks of the monitoring system. The check determines the parts or pieces of the entity that you want to monitor, the monitoring frequency, how many monitoring zones are originating the check, and so on. When you create a new check in the monitoring system, you specify the following information:
  • A name for the check
  • The check's parent entity
  • The type of check you're creating
  • Details of the check
  • The monitoring zones that will launch the check

The check, as created, will not trigger alert messages until you create an alarm to generate notifications, to enable the creation of a single alarm that acts upon multiple checks (e.g. alert if any of ten different servers stops responding) or multiple alarms off of a single check. (e.g. ensure both that a HTTPS server is responding and that it has a valid certificate).

Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also