Product Documentation

GetLogonDurationAverageTrend

Nov 06, 2015

获取指定时间段内的平均登录时长趋势,以及按指定时间间隔分组的平均值。针对该趋势中的每个数据点,统计平均登录时长和 groupByInterval 中每个时间间隔的细分。

参数名称 类型 备注
start DateTime 要查询其登录时长趋势的时间段的起始时间。必须采用 UTC 时间。
end DateTime 要查询其登录时长趋势的时间段的结束时间。必须采用 UTC 时间。
groupByInterval int 平均值的汇总方式。选项:TimeOfDay=1、DayOfWeek=2、Month=3、Year=4。必需。
desktopGroupsFilter 字符串 限制趋势结果的交付组 UID 列表(以逗号分隔)。

返回结果

GroupedLogOnDurationTrendItem 列表

属性名称 类型 备注
GroupByDate int 表示按日期显示的分组(4=4am、2007=2007 年,取决于用户输入的 groupByInterval 值)。

返回的点数:

GroupByInterval=TimeOfDay (1):24 个点 (0-23)

0=12AM,1=AM,2=2AM ... 23=11PM

GroupByInterval=DayOfWeek (2):7 个点 (0-6)

0=星期日,1=星期一 ... 6=星期六

GroupByInterval=Month (3):12 个点 (0-11)

0=1 月,1=2 月 ... 11=12 月

GroupByInterval=Year (4):但是,startDate/endDate 范围中包含多个年份。

数据点的顺序:数据返回时始终按 GroupByDate 排序,而不考虑传递到 API 的开始日期和结束日期。

Value Nullable

平均总登录时长(以毫秒为单位)和为该组执行每个步骤所需的平均时长。

Breakdown Collection

LogOnStepItem 对象的集合,每个对象包含:

持续时间 (Nullable),指执行此步骤所需的平均时长(以毫秒为单位);LogOnStep (int),将返回登录步骤的整数枚举值(即 LogOnStep 枚举)

示例

获取 7 天内两个指定交付组按一天中具体时刻(小时)的平均登录时长趋势(以毫秒为单位)。将返回达到平均登录时长的日期在指定时间范围内每小时的趋势项(返回 24 个数据点)。

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'