Cette page décrit les méthodes d’API disponibles pour manipuler des groupes de moniteurs.
Description de l’objet MonitorGroup
L’objet MonitorGroup suivant est utilisé dans les méthodes de l’API décrites ci-dessous :
| Nom | Description |
|---|---|
MonitorGroupGuid |
Identifiant unique pour ce groupe de moniteurs. |
Description |
Une chaîne contenant un nom descriptif |
IsAll |
Indique si ce groupe est le groupe système “Tous les moniteurs”. True ou False. |
Groupe « Tous les moniteurs »
Le groupe Tous les moniteurs (ce groupe peut avoir un nom différent en fonction de la langue de votre compte) est un groupe système contenant toujours tous les moniteurs. Vous ne pouvez apporter aucune modification à ce groupe. Le GUID de ce groupe est utile pour les opérations qui affectent un groupe entier, telles que le démarrage ou l’arrêt de tous les moniteurs ou alertes.
Endpoints pour la gestion des groupes de moniteurs
Les endpoints API suivants sont disponibles pour la création, la modification et la suppression de groupes de moniteurs ainsi que pour l’ajout ou la suppression de membres dans ces groupes.
| Type de requête | Endpoint | Utilisation |
|---|---|---|
| GET | /MonitorGroup |
Obtient tous les groupes de moniteurs |
| POST | /MonitorGroup |
Crée un nouveau groupe de moniteurs |
| GET | /MonitorGroup/{monitorGroupGuid} |
Obtient les détails d’un groupe de moniteurs |
| PUT | /MonitorGroup/{monitorGroupGuid} |
Met à jour un groupe de moniteurs existants |
| DELETE | /MonitorGroup/{monitorGroupGuid} |
Supprime un groupe de moniteurs |
| GET | /MonitorGroup/{monitorGroupGuid}/Members |
Obtient une liste de tous les moniteurs membres d’un groupe de moniteurs. |
| POST | /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} |
Ajoute le moniteur spécifié au groupe de moniteurs |
| DELETE | /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} |
Supprime le moniteur spécifié du groupe de moniteurs |
Opérations supplémentaires pour groupes de moniteurs
Les endpoints API suivants permettent d’effectuer des opérations sur tous les moniteurs contenus dans un groupe:
| Type de requête | Endpoint | Utilisation |
|---|---|---|
| POST | /MonitorGroup/{monitorGroupGuid}/StopAllMonitors |
Arrête tous les moniteurs du groupe de moniteurs spécifié |
| POST | /MonitorGroup/{monitorGroupGuid}/StartAllMonitors |
Démarre tous les moniteurs du groupe de moniteurs spécifié. |
| POST | /MonitorGroup/{monitorGroupGuid}/StopAllMonitorAlerts |
Arrête les alertes pour tous les moniteurs du groupe de moniteurs spécifié |
| POST | /MonitorGroup/{monitorGroupGuid}/StartAllMonitorAlerts |
Démarre les alertes pour tous les moniteurs du groupe de moniteurs spécifié |
| POST | /MonitorGroup/{monitorGroupGuid}/AddMaintenancePeriodToAllMembers |
Ajoute la période de maintenance fournie à tous les moniteurs du groupe spécifié |