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 the user can start using the service directly after provisioning a virtual instance, without the need to select any options or configure additional properties.
What’s more, MaaS is readily available for the already-provisioned VMs, without requiring additional software or any changes to running virtual instances.
The “always-on” monitoring service collects instance metrics and provides options to set up threshold-based alarms and triggers for further actions. Monitoring as a Service currently supports email actions; additional action types will be added in future versions.
The Monitoring API can be used to manage (create/read/update/delete) monitoring alarms and actions.
Authentication
Basic Authentication
Example:
Authorization: Basic ZGVtbzpwQDU1dzByZA ==
API key
Example:
Authorization: Bearer <token>
Actions
Create Actions
Create an Action that can be assigned to an arbitrary number of Alarms.
"name" must not be null or blank
"type" must be of a valid type (EMAIL)
"typeProperties.emailTo" must be a well-formed email address that is not null or blank
Update Actions
Update an Action with the specified Action ID.
"name" must not be null or blank
"type" must be of a valid type (EMAIL)
"typeProperties.emailTo" must be a well-formed email address that is not null or blank.
Alarms
Create Alarms
Create an Alarm. All of the following properties must be provided: "name" and "expression" ("comparisonThreshold", "metric" and "source").
"name": the 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 to be applied for the Alarm
'range': required when setting a 'rangeAggregation'
Update Alarms
Update an Alarm. All the following properties must be provided: "name" and "expression" ("comparisonThreshold", "metric" and "source").
"name": the 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 to be applied for the Alarm
'range': required when setting a 'rangeAggregation'