Product Documentation

Accès aux données à l'aide de l'API

Oct 21, 2016
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/v1. Vous pouvez également utiliser SSL pour sécuriser les points de terminaison ; voir Sécurisation de points de terminaison à l'aide de SSL pour plus d'informations.
  1. Les points de terminaison Methods exposent 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, tels que les requêtes sur les pages Tableau de bord et Tendances. L'URI de l'API Methods est : http://{dc-host}/Citrix/Moniteur/OData/v1/Methods
  2. 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 de colonnes, mais ne fournit pas les mêmes avantages de performances associés aux opérations de service hautement spécifiques. L'URI de l'API Data est : http://{dc-host}/Citrix/Moniteur/OData/v1/Data

Authentification

Pour utiliser l'API Monitor Service OData, vous devez être un administrateur XenDesktop. Pour appeler l’API vous avez besoin des privilèges en lecture seule ; toutefois, les données retournées sont déterminées par les rôles et les permissions de l'administrateur XenDesktop. Par exemple, les administrateurs du groupe de mise à disposition peuvent appeler l’API du service Monitor, mais les données qu'ils peuvent obtenir sont contrôlées par l'accès au groupe de mise à disposition configuré à l'aide de Citrix Studio. Pour plus d'informations sur les rôles et les permissions de l'administrateur XenApp ou XenDesktop, consultez la section Administration déléguée.

Requête de données

L'API du service Monitor de l'API du service est un API REST qui peut être accédé à l'aide d'un consommateur OData. Les consommateurs OData sont des applications qui consomment des données exposées à l'aide du protocole OData. Les consommateurs OData varient en sophistication, d'un simple navigateur Web à des applications personnalisées qui peuvent bénéficier de toutes les fonctionnalités du protocole OData. Pour de plus amples informations sur les consommateurs OData, consultez : http://www.odata.org/ecosystem#consumers.

Chaque partie du modèle de données du service service Monitor est accessible et peut être filtrée sur l'adresse URL. OData fournit un langage de requête au format de l'adresse URL que vous utilisez pour récupérer des entrées à partir d'un service. Pour de plus amples informations, veuillez consulter http://msdn.microsoft.com/en-us/library/ff478141.aspx.

La requête est traitée du côté serveur et peut être filtrée davantage en utilisant le protocole OData du côté client.

Remarque : les énumérations ne sont pas prises en charge dans le protocole OData ; les entiers sont utilisés à la place. Pour déterminer les valeurs retournées par l'API Monitor Service OData, consultez la section Déterminer les valeurs d'énumération (enum).

Catégories de données

Le service Monitor collecte les données, notamment l'utilisation de la session utilisateur, les détails des performances de l'ouverture de session utilisateur, les détails de l'équilibrage de charge de la session, et les informations de connexion et d'échec de machine. Les données sont agrégées différemment en fonction de leur catégorie. La compréhension de l'agrégation des valeurs de données présentées à l'aide de l'API OData Method est critique à l'interprétation des données. Par exemple :

  • Des sessions connectées et des échecs de machine se produisent sur une certaine période de temps, par conséquent, elles sont exposées en tant que maximums sur une période de temps
  • LogOn Duration est une mesure de durée, par conséquent est exposé comme une moyenne sur une période de temps
  • LogOn Count et Connection Failures sont les nombre d'occurrences sur une période de temps, et par conséquent sont exposés en tant que sommes sur une période de temps

Évaluation de données simultanées

Les sessions doivent se chevaucher pour être considérées comme simultanées. Toutefois, lorsque l'intervalle de temps est de 1 minute, toutes les sessions de cette minute (si elles se chevauchent ou non) sont considérées comme simultanées, par exemple la taille de l'intervalle est si petite que la surcharge de performances impliquée dans le calcul de la précision ne vaut pas la valeur ajoutée. Si les sessions se produisent dans la même heure, mais pas dans la même minute, elles ne sont pas considérées comme se chevauchant.