Product Documentation

GetSessionSummary

Oct 21, 2016

Obtient les points de données pour représenter une tendance de sessions simultanées (connectées) comme une liste de DateTime/paires de valeurs pour la période de temps spécifiée. Chaque point représente le nombre maximal de sessions simultanées connectées via l'intervalle spécifié.

Nom de paramètre Type Commentaires
startDate DateTime Début de la fenêtre de temps à interroger pour les sessions simultanées. Doit être UTC.
endDate DateTime Fin de la fenêtre de temps à interroger pour les sessions simultanées. Doit être UTC.
sessionSupportFilter chaîne Liste délimitée par des virgules des entiers de type de machine pour lesquels limiter la requête (unique=1, multiple=2, inconnu=0). La valeur par défaut est tous les types, si aucun filtre n'est spécifié.
desktopGroupFilter chaîne Liste délimitée par des virgules d'UID de groupe de mise à disposition pour lesquels limiter la requête. Si aucune valeur n'est spécifiée, tous les groupes de mise à disposition sont retournés.
connectionStateFilter chaîne Liste délimitée par des virgules des entiers de l’état de connexion pour lesquels limiter la requête (1=Connecté, 2=Déconnecté). Si ce paramètre n'est pas spécifié, la valeur par défaut correspond aux deux.

Retours

Liste IQueryable des objets SessionSummary : IQueryable.

Chaque SessionSummary contient les éléments suivants :

  • DesktopGroup (nom et Uid)
  • AverageSessionCount (double)
  • Nombre moyen de sessions simultanées pour la période de temps spécifiée. Ceci est la moyenne des valeurs maximales pour la période de temps utilisant la précision disponible pour cette période
  • AverageUserCount (double)
  • Nombre moyen d'utilisateurs connectés pour la période spécifiée
  • PeakUserCount (int)
  • Pic du nombre d'utilisateurs connectés à tout moment dans la période spécifiée
  • UniqueUserCount (int)
  • Nombre total d’utilisateurs uniques pendant la période spécifiée
  • AverageHoursPerDay (double)
  • Durée moyenne d'une session (heures par utilisateur et par jour)
  • DesktopGroup (nom et Uid)

Exemple

Obtient une liste de tous les objets de synthèse de session sur 24 heures pour toutes les sessions.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionSummary?startdate=datetime'2011-09-30T00:00:00'&enddate=datetime'2011-10-01T00:00:00'

Obtient une liste de synthèse des objets sur 24 heures pour les sessions de machines avec OS de serveur

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionSummary?startdate=datetime'2011-09-30T00:00:00'&enddate=datetime'2011-10-01T00:00:00'&sessionSupportFilter='2'