Product Documentation

GetSessionSummary

Nov 06, 2015

获取数据点,采用 DateTime 值对列表的方式来表示指定时间段内的并发连接会话趋势。每个点表示在指定时间间隔内的最大并发连接会话数。

参数名称 类型 备注
startDate DateTime 要查询其并发会话数的时间段的起始时间。必须采用 UTC 时间。
endDate DateTime 要查询其并发会话数的时间段的结束时间。必须采用 UTC 时间。
sessionSupportFilter 字符串 限制查询结果的计算机类型整数列表,以逗号分隔 (Single=1, Multiple=2, Unknown=0)。如果未指定过滤器,默认值为所有类型。
desktopGroupFilter 字符串 限制查询结果的交付组 UID 列表(以逗号分隔)。如果未指定任何值,将返回所有交付组。
connectionStateFilter 字符串 限制查询结果的连接状态整数列表,以逗号分隔 (1=Connected, 2=Disconnected)。如果未指定,默认值为两个整数。

返回结果

SessionSummary 对象的 IQueryable 列表 - IQueryable。

每个 SessionSummary 中包含以下部分:

  • DesktopGroup(名称和 Uid)
  • AverageSessionCount (double)
  • 指定时间段内的平均并发会话数。该值为使用适用粒度的时间段内峰值的平均值
  • AverageUserCount (double)
  • 指定时间段内的平均连接用户数
  • PeakUserCount (int)
  • 指定时间段内任一点的连接用户数峰值
  • UniqueUserCount (int)
  • 指定时间段内的唯一用户总数
  • AverageHoursPerDay (double)
  • 会话的平均时长(每天每个用户的小时数)
  • DesktopGroup(名称和 Uid)

示例

获取所有会话 24 小时内所有会话摘要对象的列表。

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

获取服务器操作系统计算机会话 24 小时内摘要对象的列表。

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