Cette section aide les développeurs de logiciels qui souhaitent développer des applications en utilisant des outils de surveillance Dotcom-Monitor.
Il existe plusieurs façons d’afficher et d’interagir avec les données de surveillance au-delà de l’interface du site Web Dotcom-Monitor, notamment en utilisant le flux XML pour consommer des données et en interagissant avec l’API Dotcom-Monitor pour surveiller et mettre à jour les agents de surveillance installés.
Avec le flux XML, les développeurs peuvent s’abonner aux données souhaitées et les présenter dans leur propre format à l’aide de leurs propres rapports personnalisés. Voir L’utilisation de l’outil XML Reporting Service (XRS) pour plus de détails.
Les utilisateurs de l’API Dotcom-Monitor peuvent créer leurs propres scripts ou applications personnalisés pour interagir avec les paramètres et afficher les données surveillées dans leur propre environnement personnalisé. Notre système utilise l’API REST qui permet l’interaction avec le site Web Dotcom-Monitor par programmation en utilisant les méthodes les plus populaires pour travailler avec des données via des requêtes HTTP (S) (GET, POST, PUT, DELETE). Presque tous les objets Dotcom-Monitor sont accessibles via l’API REST et presque tous les aspects des fonctionnalités du service Dotcom-Monitor sont gérés. En utilisant les appels d’API, les développeurs peuvent créer et supprimer des appareils et des tâches, les reporter et les démarrer, créer et gérer des groupes d’alertes, des modèles, des filtres et des planificateurs, obtenir des informations sur l’état des appareils ainsi que de nombreuses autres options.
En général, l’API Dotcom-Monitor peut être utilisée dans les tâches suivantes :
- Intégration tierce avec la solution dotcom-monitor monitoring.
- Téléchargement et téléchargement de données.
- Modification des données.
Les actions les plus courantes exécutées via l’API REST :
- Accès aux listes de plates-formes de surveillance, d’appareils, de cibles, de planificateurs, d’emplacements, de groupes d’alertes, de filtres, de modèles d’alerte.
- Accès à des informations détaillées sur les plates-formes, les appareils et les cibles.
- Modification des appareils, des cibles, des planificateurs, des groupes et modèles d’alertes, des filtres.
- Création d’un nouvel objet dotcom-Monitor (périphériques, cibles, planificateurs, etc.).
- Gestion des objets d’audit.
L’API Dotcom-Monitor est divisée en 10 types de ressources :
- Plate-forme: Toutes les tâches de surveillance relèvent de l’une des cinq plates-formes différentes.
- Appareils: Un périphérique surveillé est un «ensemble» organisé de tâches de surveillance qui contient soit une seule tâche de surveillance, une séquence de tâches de surveillance, un script de surveillance qui comprend des tâches, ou une combinaison des trois.
- Tâches: Une tâche est une activité de surveillance unique, comme la surveillance d’une cible (URL, Serveur de messagerie, serveur FTP, etc.).
- Fréquence: Définit la fréquence d’exécution des sessions de suivi.
- Horaire: Un calendrier détaille quand une tâche sera ou ne sera pas exécuté.
- Lieu: Un emplacement de surveillance disponible au sein du réseau de surveillance mondial Dotcom-Monitor.
- Groupe d’alerte: La mise en place d’un groupe place les destinataires d’un rapport et/ou d’une alerte dans un groupe. Chaque destinataire du groupe peut avoir un modèle d’alerte unique.
- Modèle d’alerte: Le modèle définit le format des alertes.
- Filtre: Un filtre est un ensemble de règles qui déterminent comment les réponses de surveillance sont traitées et affichées.
- Vérification : Fournit des informations historiques sur chaque modification de compte.
Le tableau ci-dessous indique quel type de demande et action sont pris en charge par chaque type de ressource. Consultez la section Méthodes de surveillance pour obtenir des descriptions détaillées.
Type de | de la requête | URI(s) | Description |
---|---|---|---|
Plateforme | AVOIR | /Plates-formes | Retour de la liste des plateformes disponibles |
Appareil | AVOIR | /Dispositifs/{platform} | Obtenez la liste des appareils par plate-forme. |
AVOIR | /appareil/{deviceId} | Obtenir des informations sur l’appareil | |
PUBLIER | /devices ?verb=METTRE | Créer un nouvel appareil | |
METTRE | /Dispositifs | ||
PUBLIER | /device/{deviceId}/DisableAlert/ | Désactiver les alertes | |
PUBLIER | /appareil/{deviceId} | Modifier l’appareil | |
PUBLIER | /device/{deviceId} ?verb=delete | Supprimer l’appareil | |
SUPPRIMER | /appareil/{deviceId} | ||
Tâche | AVOIR | /device/{deviceid}/tasks | Obtenir la liste des tâches sous un appareil |
PUBLIER | /tasks ?verb=METTRE | Créer une nouvelle tâche | |
METTRE | /tâches | ||
AVOIR | /tâche/{TaskId} | Obtenir des informations sur la tâche | |
PUBLIER | /tâche/{TaskId} | Modifier la tâche | |
PUBLIER | /task/{TaskId} ?verb=delete | Supprimer la tâche | |
SUPPRIMER | /tâche/{TaskId} | ||
Fréquence | Avoir | /frequencies/{platform_name} | Obtenez freq disponible. par plate-forme. |
Programmateur | AVOIR | /Planificateurs | Obtenir la liste des planificateurs |
AVOIR | /Programmateur/{Scheduler_ID} | Obtenir des informations spécifiques sur le planificateur | |
PUBLIER | /schedulers ?verb=PUT | Créer un nouveau planificateur | |
METTRE | Planificateurs | ||
PUBLIER | /scheduler/{ ID du planificateur} | Modifier le planificateur | |
PUBLIER | /Scheduler/{Scheduler_Id} ?verb=delete | Supprimer le planificateur | |
SUPPRIMER | /Programmateur/{Scheduler_Id} | ||
Emplacement | AVOIR | /Lieux/{platform_name} | Obtenir la liste des emplacements disponibles |
d’alerte | AVOIR | /groupe | Obtenir la liste des groupes d’alertes |
PUBLIER | /groupes ?verb=PUT/groupes | Créer un groupe d’alertes | |
METTRE | groupes/groupes | ||
AVOIR | /Groupe/{Group_ID} | Obtenir des informations sur le groupe d’alertes | |
PUBLIER | /Groupe/{Group_ID} | Modifier le groupe d’alertes | |
PUBLIER | /Groupe/{Group_Id} ?verb=delete | Supprimer le groupe | |
SUPPRIMER | Groupe/{Group_Id} | ||
d’alerte | AVOIR | /Modèles | Obtenir la liste des modèles d’alerte |
PUBLIER | /templates ?verb=PUT/templates | Créer un modèle d’alerte | |
METTRE | /modèles/modèles | ||
AVOIR | /modèle/{Template_ID} | Obtenir des informations sur le modèle d’alerte | |
PUBLIER | /modèle/{Template_ID} | Modifier le modèle d’alerte | |
PUBLIER | /template/{Template_Id} ?verb=delete | Supprimer le modèle | |
SUPPRIMER | /modèle/{Template_Id} | ||
Filtre | AVOIR | /Filtres | Obtenir la liste des filtres |
PUBLIER | /filters ?verb=PUT | Créer un nouveau filtre | |
METTRE | /Filtres | ||
AVOIR | /filtre/{filter_ID} | Obtenir des informations spécifiques sur les filtres | |
PUBLIER | /filtre/{filter_ID} | Modifier le filtre | |
PUBLIER | /filter/{filter_ID} ?verb=delete | Supprimer le filtre | |
SUPPRIMER | /filtre/{filter_ID} | ||
Audit | AVOIR | /audit/liste | Obtenir la liste des objets audités pour l’utilisateur actuel au cours des dernières 24 heures. |
AVOIR | /audit/object/{exemple ID} | Obtenir le contenu de l’audit pour l’ID particulier | |
PUBLIER | /audit/liste | Obtenir une liste filtrée des objets audités. |