Monitoring as a Service (part of Cloud API) (1)
Alarm management endpoints for Monitoring as a Service by IONOS cloud.
Monitoring as a Service (or just MaaS) is a PaaS service by IONOS cloud. It is a complimentary “always-on” service that is provided to all compute instances (public cloud servers as well as IONOS Cloud Cubes). “Always-on” means that a user does not have to select any option or must configure further properties but can use the service directly after provisioning a virtual instance.
Furthermore, MaaS is also available to already provisioned virtual machines. There is no change to a running virtual instance required nor does it take any installation of additional software to the instance to use the service.
While the “always-on” monitoring service collects metrics from an instance the service also provides an option to set up threshold based alarms as well as actions if a threshold gets triggered so the user wants to take further actions. In this version of Monitoring as a Service, only eMail actions are supported. Further actions will be enabled in upcoming versions of the service.
The MonitoringAPI allows managing (create/ read/ update/ delete) of monitoring alarms as well as actions
Authentication
Basic Authentication
Example:
Authorization: Basic ZGVtbzpwQDU1dzByZA ==
API key
Example:
Authorization: Bearer <token>
Actions
Create an Action
This operation is used to create an Action which can be assigned to an arbitrary number of Alarms.
"name" must not be null or blank.
"type" must be a valid kind (EMAIL).
"typeProperties.emailTo" must be a well-formed email address and must not be null or blank.
Update an Action
This operation is used to update an Action for a particular action id.
"name" must not be null or blank.
"type" must be a valid kind (EMAIL).
"typeProperties.emailTo" must be a well-formed email address and must not be null or blank.
Alarms
Create an Alarm
This operation is used to create an Alarm. All following properties must be provided i.e. "name" and "expression" ("comparisonThreshold", "metric" and "source")
"name": Name of the alarm
"expression.source": The virtual instance for which you want to configure the alarm
"expression.metric": The metric (CPU|Network|Storage)
"expression.comparisonThreshold": The threshold value applied to the alarm.
A 'range' is required when setting a 'rangeAggregation'.
Update an Alarm
This operation is used to update an Alarm. All following properties must be provided i.e. "name" and "expression" ("comparisonThreshold", "metric" and "source")
"name": Name of the alarm
"expression.source": The virtual instance for which you want to configure the alarm
"expression.metric": The metric (CPU|Network|Storage)
"expression.comparisonThreshold": The threshold value applied to the alarm.
A 'range' is required when setting a 'rangeAggregation'.