Product Documentation

API Monitor Service OData

Jun 20, 2017
En plus d'utiliser la console Citrix Director pour afficher les données d'historique, vous pouvez interroger les données à l'aide de l'API de Monitor Service. Vous pouvez utiliser l'API pour :
  • Analyser des tendances historiques pour la planification
  • Effectuer une résolution des problèmes détaillées des échecs de connexion et de machine
  • Extraire des informations afin de les envoyer dans d'autres outils et processus ; par exemple, à l'aide des tables PowerPivot de Microsoft Excel pour afficher les données de différentes manières
  • Créer une interface utilisateur personnalisée en plus des données offertes par l'API

L'API de Monitor Service utilise le protocole OData (Open Data), qui est un protocole Web pour l'interrogation et la mise à jour des données, construit sur des technologies Web telles que HTTP. Pour de plus amples informations sur le protocole OData, consultez : http://www.odata.org.

Le service Moniteur de l'API est créé sur des bases de données SQL Server à l'aide de Windows Communication Foundation (WCF) Data Services qui sont remplis pendant le traitement et la consolidation. Deux points de terminaison sont exposés à l'aide de WCF avec wsHttpBinding. L'adresse de base est : http://{dc-host}/Citrix/Monitor/OData/v2. Vous pouvez également utiliser TLS pour sécuriser les points de terminaison ; voir Sécurisation de points de terminaison à l'aide de TLS pour plus d'informations.
  1. Le point de terminaison des données expose l'accès en lecture seule directement vers les entités de la base de données et est accessible à l’aide du langage de requête OData. Ce point de terminaison permet un accès très assoupli en termes de filtrage et de sélection des colonnes. L'URI de l'API Data est : http://{dc-host}/Citrix/Monitor/OData/v2/Data. Pour de plus amples informations sur l'accès aux données du service Monitor, consultez la section Accès aux données à l'aide de l'API.
  2. Le point de terminaison Methods expose les opérations de service qui sont utilisées par Citrix Director pour récupérer des données qui nécessitent un regroupement complexe et des performances élevées standards, telles que les requêtes sur les pages Tableau de bord et Tendances. L'URI de l'API Methods est : http://{dc-host}/Citrix/Monitor/OData/v2/Methods. Les méthodes sont uniquement utilisées dans Director lui-même et ne sont pas utilisées par la plupart des clients Citrix. Par conséquent, elles ne sont pas documentées ici.

Nouveautés de cette version

La version de l'API incluse avec XenApp et XenDesktop 7.6 offre les nouvelles fonctionnalités suivantes :
  • Inventaire des corrections à chaud. À l'aide de la vue Détails de l'utilisateur ou de la vue Machine dans Director, vous pouvez afficher une liste de toutes les corrections à chaud Citrix qui ont été installées sur une machine. Vous pouvez utiliser l'API pour extraire ces données et créer des rapports personnalisés (par exemple, l'état des correctifs installés sur un site entier) ou les extraire dans un moteur d'analyse. De nouvelles classes ont été introduites et la classe de Machine a été étendue pour prendre en charge le suivi des corrections Citrix installées sur le Controller et les VDA.
  • Résolution des problèmes de sessions anonymes. Les sessions peuvent être exécutées comme un ensemble de comptes d’utilisateur local regroupés. L'API possède une nouvelle propriété IsAnonymous pour la classe Session (valeur par défaut FALSE).
  • Création de rapports d'utilisation des applications hébergées. Director offre de nouveaux rapports de capacité qui affichent l'utilisation des applications hébergées dans le temps. L'API vous permet de créer des rapports sur les détails de chaque instance d'application en cours d'exécution dans une session utilisateur.

Toutes les mises à jour apportées aux données sont complètement documentées dans l'API de référence à l'adresse http://support.citrix.com/help/monitorserviceapi/7.6/.

La méthode GetSessionSummary est obsolète dans cette version.