Product Documentation

GetLogonDurationAverageTrend

Oct 21, 2016

Obtient la tendance de la durée d'ouverture de session moyenne pour la fenêtre de temps spécifiée, avec des moyennes mobiles groupées selon l'intervalle spécifié. Chaque point de données dans la tendance possède une durée moyenne d’ouverture de session et une répartition de chaque intervalle dans le groupByInterval.

Nom de paramètre Type Commentaires
start DateTime Début de la fenêtre de temps à interroger pour la tendance de durée d'ouverture de session. Doit être UTC.
end DateTime Fin de la fenêtre de temps à interroger pour la tendance de durée d'ouverture de session. Doit être UTC.
groupByInterval int Manière dont les moyennes sont déployées. Options : TimeOfDay=1, DayOfWeek=2, Month=3, Year=4. Obligatoire.
desktopGroupsFilter chaîne Liste séparée par des virgules d'UID de groupe de mise à disposition pour lesquels limiter les résultats de tendance.

Retours

Une liste de GroupedLogOnDurationTrendItem

Nom de la propriété Type Commentaires
GroupByDate int Représente le groupe par date (4=4am, 2007=année 2007 selon le groupByInterval entré).

Nombre de points retournés :

GroupByInterval=TimeOfDay (1) : 24 points (0-23)

0=24 h, 1=AM, 2=2AM... 23=11PM

GroupByInterval=DayOfWeek (2) : 7 points (0-6)

0=Dimanche, 1=lundi... 6=Samedi

GroupByInterval=Month (3) : 12 points (0-11)

0=Janvier, 1=février... 11=décembre

GroupByInterval=Year (4) : nombre d'années comprises dans la plage startDate/endDate.

Ordre de Points : les données retournées sont toujours classées par GroupByDate, quels que soient les dates de début et de fin transmises à l'API.

La valeur nullable

Durée totale moyenne d’ouverture de session en millisecondes et durée moyenne de chaque étape pour ce groupe.

Répartition Collection

Collection d'objets LogOnStepItem qui contiennent chacun :

Duration (Nullable ) qui est la durée moyenne, en millisecondes, de cette étape et LogOnStep (int) qui retourne la valeur enum du nombre entier de l'étape d'ouverture de session (fait référence à l'enum LogOnStep)

Exemple

Obtient une moyenne de 7 jours par heure de la journée (heure) de la tendance de durée d'ouverture de session (en millisecondes) pour les deux groupes de mise à disposition spécifiés. Ceci retourne un élément de tendance pour chaque heure de la journée qui est la durée moyenne d’ouverture de session pour cette heure de la journée dans le délai spécifié (24 points de données retournés).

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetDurationAverageTrend?start=datetime'2011-09-23T00:00:00'&end=datetime'2011-10-01T00:00:00'groupByInterval=1&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'