Product Documentation

方法

Oct 12, 2015

以下主题描述了 API 的使用方法。在介绍每种方法时,还提供了相应的参数以及 API 调用返回的结果。此外,还显示了查询示例。

有关如何指定时间间隔的详细信息,请参阅关于时间和日期范围。有关 Monitor Service OData API 返回值的详细信息,请参阅确定枚举值

GetAverageLogOnBreakdown

获取指定时间段、用户 ID 和 desktopGroupUid 的平均登录时长。

参数名称 类型 备注
startDate DateTime 要获取其平均登录时长的时间段的起始时间。必须是 UTC DateTime。
endDate DateTime 要获取其平均登录时长的时间段的结束时间。必须是 UTC DateTime。
userSid 字符串 限制平均登录时长的用户 Sid。
desktopGroupUid Guid 限制平均登录时长的 DesktopGroup Uid。

返回结果

包含了每个登录步骤的以下信息的 LogOnBreakdown 对象的 IQueryable:

属性名称 类型 备注
LogonStepItems List LogOnStepItems 列表。每个 LogonStepItem 都包含 LogonStep(值可为 Brokering=1、VMStart=2、HDX=3、Authentication=4、Gpos=5、LogonScripts=6、ProfileLoad=7、Interactive=8、Total=0)和时长 (Nullable)(以毫秒为单位)。如果该步骤没有可用的数据,则时长为空。
BreakdownType int Breakdown 类型。UsersLastSession=1、UsersSessionAverage=2、DesktopGroupAverage=3
注意:HDX 持续时间是一个需要更改 ICA 协议的新指标。这意味着:如果未使用新版本的客户端,则返回指标为空。

示例

获取此用户 ID 和 desktopGroupUid 在 3 月 15 日的平均登录时长。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetAverageLogOnBreakdown?startDate=datetime'2012-03-15T00:00:00'&endDate=datetime'2012-03-30T00:00:00'&userSid='User%20Sid'&desktopGroupUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&$expand=LogOnStepItems

GetAverageLogOnDuration

获取指定时间段的平均登录时长趋势。仅包含已成功完成的登录(在数据库中同时具有 LogOnStartDate 和 LogOnEndDate)。

参数名称 类型 备注
start DateTime 要查询其平均登录时长趋势的时间段的起始时间。必须采用 UTC 时间。
end DateTime 要查询其连接故障趋势的时间段的结束时间。必须采用 UTC 时间。

返回结果

表示指定时间段内平均登录时长的双精度值。

示例

获取所有交付组的指定小时内的平均登录时长。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetAverageLogOnDuration?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:24:00'

GetConcurrentSessionsTrend

获取指定时间段内表示为 DateTime/值对列表的并发会话趋势的数据点。每个数据点都表示指定时间间隔内最大的并发会话数。趋势中最后一个数据点可表示系统中的当前用户数。

参数名称 类型 备注
startDate DateTime 要查询其并发会话数的时间段的起始时间。必须采用 UTC 时间。闭区间。
endDate DateTime 要查询其并发会话数的时间段的结束时间。必须采用 UTC 时间。闭区间。
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)。

返回结果

TrendItem 对象的 IQueryable 列表 - IQueryable 按日期升序排序。

每个 TrendItem 包含一个 UTC 日期 (DateTime) 属性和一个用于绘制趋势的值属性 (double)。

示例

获取并发会话的 1 小时趋势(每分钟为一个数据点):

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConcurrentSessionsTrend?startDate=datetime'2012-06-05T12:26:00'&endDate=datetime'2012-06-05T13:26:00'&intervalLength=1

GetConnectedUsersTrend

获取指定时间段内服务器操作系统计算机的连接用户趋势。趋势中的每个数据点包含在最后一个时间间隔 (intervalLength) 内连接到服务器操作系统计算机的用户总数。

参数名称 类型 备注
startDate DateTime 要查询其连接用户趋势的时间段的起始时间。必须采用 UTC 时间。
endDate DateTime 要查询其连接用户趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)。
desktopGroupsFilter 字符串 限制趋势结果的交付组 UID 列表(以逗号分隔)。
machineFilter 字符串 限制趋势结果的计算机 Sid 列表(以逗号分隔)。

返回结果

包含以下内容的 IQueryable 对象:

属性名称 类型 备注
ConnectedUsersTrend List TrendItem 包含一个 UTC 日期 (DateTime) 和一个用于表示该时间间隔内最大连接用户数量的计数 (int)。

示例

为两个指定交付组获取连接用户趋势的 24 小时趋势(每 15 分钟一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectedUsersTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

获取连接用户趋势的为期一周的趋势(每 4 小时一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectedUsersTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240

GetConnectionFailureTrend

获取指定时间段的连接故障趋势。趋势中的每个数据点表示在最后一个时间间隔(由 intervalLength 参数确定)内的连接故障总次数。

参数名称 类型 备注
startDate DateTime 要查询其连接故障趋势的时间段的起始时间。必须采用 UTC 时间。
endDate DateTime 要查询其连接故障趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)。
desktopGroupsFilter 字符串 限制趋势结果的交付组 UID 列表(以逗号分隔)。
connectionFailureTypeFilter 字符串 限制趋势结果的连接故障类型 int 列表(以逗号分隔)。此整数与 ConnectionFailureType 枚举相对应。
sessionSupportFilter 字符串 限制趋势结果的计算机类型 int 列表,以逗号分隔 (Single=1, Multiple=2, Unknown=0) 。两种类型都没有返回值。

返回结果

TrendItem 对象的 IQueryable

属性名称 类型 备注
FailureTrend List TrendItem 包含一个 UTC 日期 (DateTime) 和一个用于指示指定过滤器在指定时间段内连接故障趋势的故障计数 (int)。

示例

为使用桌面操作系统计算机类型指定的两个交付组的所有连接故障类型获取 24 小时趋势(每 15 分钟一个数据点)。

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

为所有用户可以访问的交付组的 3 种连接故障类型(已聚合)获取为期一周的趋势(每 4 小时一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrend?startdate=datetime'2011-09-23T00:00:00'&enddate=datetime'2011-10-01T00:00:00'intervalLength=240&connectionFailureTypeFilter='2,3,4'

GetConnectionFailureTrendsByType

按类型获取指定时间段内的连接故障次数列表,以及每种类型的趋势。趋势中的每个数据点表示在最后一个时间间隔(由 intervalLength 参数确定)内的连接故障总次数。可以指定用于限制查询的特定故障类型或获取所有故障类型。

参数名称 类型 备注
startDate DateTime 要查询其连接故障趋势的时间段的起始时间。必须采用 UTC 时间。
endDate DateTime 要查询其连接故障趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLength Int 趋势的数据点之间的时间间隔(以分钟为单位)。
connectionFailureType Int 如果提供了 [ConnectionFailureType](值大于 0),结果中将仅返回此连接故障类型。否则(空值或 0 值),将返回所有故障类型列表。此整数与 ConnectionFailureType 枚举相对应。

返回结果

ConnectionFailureTrend 对象的 IQueryable,包含每个 ConnectionFailureType 的以下信息。

如果请求所有类型,则将返回总和及 ConnectionFailureType = -1。

如果查询中包含 $expand=FailureTrend,则会检索每种故障类型的趋势和 TotalFailureCount 属性。

如果查询中包含 $expand=DesktopGroupBreakdown,还会检索每种故障类型的此属性。

属性名称 类型 备注
ConnectionFailureType int [ConnectionFailureType] 连接故障类型(来自于枚举 ConnectionFailureType)。
FailureTrend List TrendItem 包含一个 UTC 日期 (DateTime) 和一个用于指定此故障类型在指定时间段内连接故障趋势的值(可为空值的双精度值)。
TotalFailureCount int 指定时间段的故障总数。
DesktopGroupBreakdown List DesktopGroupBreakdown 包含 DesktopGroup 对象(必须包含在扩展中才能返回)和计数 (int),用来表示指定时间段内的故障总数。

示例

按每 30 分钟一个数据点检索 11 月 14 日上午 5 点 (UTC) 到 11 月 14 日上午 7 点 (UTC) 时间段内所有故障类型的交付组细分和故障趋势:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&intervalLength=30&connectionFailureType=0&$expand=FailureTrend,DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

仅检索 11 月 14 日上午 5 点 (UTC) 到 11 月 14 日上午 7 点 (UTC) 时间段内故障类型 4(无可用容量)的交付组细分

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&connectionFailureType=4&$expand=DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

按每 1 小时一个数据点检索 11 月 14 日午夜 12 点 (UTC) 到 11 月 14 日下午 11 点 (UTC) 时间段内所有故障类型的故障趋势:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T00:00:00'&endDate=datetime'2011-11-14T23:00:00'&intervalLength=60&connectionFailureType=0&$expand=FailureTrend

GetConnectionFailureTrendsByTypeLatest

更新日期:2013/11/11

按类型获取从现在(UTC 服务器时间)开始的指定时间间隔数的连接故障次数列表,以及每种类型的趋势。趋势中的每个数据点表示在最后一个时间间隔(由 intervalLength 参数确定)内的连接故障总次数。可以指定用于限制查询的特定故障类型或获取所有故障类型。

参数名称 类型 备注
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)。
numberOfIntervals int 请求数据点的数量。与 intervalLength 结合使用以计算 StartDate。
connectionFailureType int [ConnectionFailureType] 如果提供了此参数(值大于 0),结果中将仅返回此连接故障类型。否则(空值或 0 值),将返回所有故障类型列表。此整数与 ConnectionFailureType 枚举相对应。

返回结果

ConnectionFailureTrend 对象的 IQueryable,包含每个 ConnectionFailureType 的以下信息。

如果请求所有类型,则将返回总和及 ConnectionFailureType = -1。

如果查询中包含 $expand=FailureTrend,则会检索每种故障类型的趋势和 TotalFailureCount 属性。

如果查询中包含 $expand=DesktopGroupBreakdown,还会检索每种故障类型的此属性。

属性名称 类型 备注
ConnectionFailureType int [ConnectionFailureType] 连接故障类型(来自于枚举 ConnectionFailureType)。
FailureTrend List TrendItem 包含一个 UTC 日期 (DateTime) 和一个用于指定此故障类型在指定时间段内连接故障趋势的值(可为空值的双精度值)。
TotalFailureCount int 指定时间段的故障总数。
DesktopGroupBreakdown List DesktopGroupBreakdown 包含 DesktopGroup 对象(必须包含在扩展中才能返回)和计数 (int),用来表示指定时间段内的故障总数。

示例

按每分钟一个数据点检索过去 60 分钟内的交付组细分和故障趋势:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=1&numberOfIntervals=60&connectionFailureType=0&$expand=FailureTrend,DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

仅检索过去 30 分钟内故障类型 4(无可用容量)的交付组细分

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=1&numberOfIntervals=30&connectionFailureType=4&$expand=DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

按每小时一个数据点检索过去 24 小时内所有故障类型的故障趋势:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=60&numberOfIntervals=24&connectionFailureType=0&$expand=FailureTrend

GetLastSessionLogOnBreakdown

获取用户和交付组的登录细分。返回当前用户会话(如果存在)。

参数名称 类型 是否必需? 备注
userSid 字符串 请求用户信息的用户 ID。
desktopGroupUid Guid 查询的交付组。
machineUid 字符串 运行上次会话的计算机。此参数可能不可用。

返回结果

包含了每个登录步骤的以下信息的 LogOnBreakdown 对象的 IQueryable:

属性名称 类型 备注
LogonStepItems List LogOnStepItems 列表。每个 LogonStepItem 都包含 LogonStep(值可为 Brokering=1、VMStart=2、HDX=3、Authentication=4、Gpos=5、LogonScripts=6、ProfileLoad=7、Interactive=8、Total=0)和时长 (Nullable)(以毫秒为单位)。如果该步骤没有可用的数据,则时长为空。
BreakdownType int 细分类型 - UsersLastSession=1、UsersSessionAverage=2、DesktopGroupAverage=3

示例

获取用户和交付组的登录细分。返回当前用户会话(如果存在)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLastSessionLogOnBreakdown?userSid='User%20Sid'&desktopGroupUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&machineUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&$expand=LogOnStepItems

GetEffectiveLoadIndexTrend

获取指定时间段内(以分钟为单位)服务器操作系统计算机的负载评估指数 (LEI) 趋势。每个数据点都表示此时间间隔内的平均负载指数。返回 LoadIndexTrendItems 的 IQueryable,它表示有效负载指数和按各个类型的细分(CPU、内存、磁盘、网络、会话计数)。

参数名称 类型 备注
startDate DateTime 要查询其负载指数趋势的时间段的起始时间。必须采用 UTC 时间。
endDate DateTime 要查询其负载指数趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)。
desktopGroupsFilter 字符串 限制趋势结果的交付组 UID 列表(以逗号分隔)。
machineFilter 字符串 限制趋势结果的计算机 Sid 列表(以逗号分隔)。需要使用多会话计算机。

返回结果

包含以下内容的 IQueryable 对象:

属性名称 类型 备注
LoadIndexTrend List LoadIndexTrendItem 包含一个 UTC 日期 (DateTime) 和一个总 LEI 的整数以及单独对象(查询中包含 $expand=Breakdown 时提供)中的各个 LEI 部分(CPU、内存、磁盘、网络、会话计数)的整数。

示例

为两个指定的交付组获取负载指数趋势和细分的 24 小时趋势(每 15 分钟一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetEffectiveLoadIndexTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'&$expand=Breakdown

获取负载指数趋势的为期一周的趋势(每 4 小时一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetEffectiveLoadIndexTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240&$expand=Breakdown

GetLoadIndexTrend

更新日期:2013/07/24

获取指定时间段内(以分钟为单位)受负载指数类型限制的服务器操作系统计算机的负载评估指数 (LEI) 趋势。趋势中每个数据点都具有总 LEI 以及每个负载指数类型的细分(CPU、内存、磁盘、网络、SessionCount)。

参数名称 类型 备注
startDate DateTime 要查询其负载指数趋势的时间段的起始时间。必须采用 UTC 时间。
endDate DateTime 要查询其负载指数趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)
desktopGroupsFilter 字符串 限制趋势结果的交付组 UID 列表(以逗号分隔)。
machineFilter 字符串 限制趋势结果的计算机 Sid 列表(以逗号分隔)。需要使用多会话计算机。
indexTypeFilter 字符串 要包括的负载指数列表(效力、CPU、网络、内存、磁盘、会话计数)(以逗号分隔)。对应于 LoadIndexType 枚举。空字符串将返回所有结果。

返回结果

包含每个指定指数类型的以下各项的 IQueryable 对象:

属性名称 类型 备注
LoadIndexType int [LoadIndexType] 对应于 LoadIndexType 枚举。
LoadIndexTrend List TrendItem 包含一个 UTC 日期 (DateTime) 和一个表示指数的整数。

示例

为两个指定的交付组获取负载指数趋势和细分的 24 小时趋势(每 15 分钟一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLoadIndexTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

获取负载指数趋势和细分的为期一周的趋势(每 4 小时一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLoadIndexTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240

GetLogOnCountTrend

在指定时间段内,获取按时间间隔(TimeOfDay、DayOfWeek 等)分组的登录时长趋势(平均值)。仅包含已成功完成的登录(在数据库中同时具有 LogOnStartDate 和 LogOnEndDate)。

参数名称类型备注
startDateTime要查询其平均登录时长趋势的时间段的起始时间。必须采用 UTC 时间。
endDateTime要查询其登录时长趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLengthint趋势的数据点之间的时间间隔(以分钟为单位)。

返回结果

TrendItem 对象的 IQueryable。TrendItem 包含一个 UTC 日期 (DateTime) 和一个表示指定起始时间到结束时间内的平均登录计数趋势的值。

示例

按每分钟一个数据点(表示这 1 分钟内的登录总次数)获取 1 小时的数据。如果在这 1 分钟内未进行登录TrendItem 的值为 0。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnCountTrend?startDate=datetime'2012-06-05T12:24:00'&endDate=datetime'2012-06-05T13:24:00'&intervalLength=1

GetLogOnCountTrendFiltered

获取指定时间段内的登录计数趋势。趋势中的每个数据点表示在最后一个时间间隔 (intervalLength) 内的总登录次数。仅包含已成功完成的登录(在数据库中同时具有 LogOnStartDate 和 LogOnEndDate)。

参数名称类型备注
startDateDateTime要查询其登录计数趋势的时间段的起始时间。必须采用 UTC 时间。
endDateDateTime要查询其登录计数趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLengthint趋势的数据点之间的时间间隔(以分钟为单位)。
desktopGroupsFilter字符串限制趋势结果的桌面组Uid的列表(以逗号分隔)。

返回结果

TrendItems 列表:

属性名称类型备注
LogonCountTrendListLogonDurationTrendItem 包含一个 UTC 日期 (DateTime) 和一个用于表示该日期内登录次数的计数 (int)。

示例

获取 24 小时内(每 15 分钟采集一个数据点)两个指定交付组的登录计数趋势(以毫秒为单位)。

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

获取一周内(每 4 小时采集一个数据点)的登录时长趋势(以毫秒为单位)。

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

GetLogOnDurationAverageTrend

获取指定时间段内的平均登录时长趋势,以及按指定时间间隔分组的平均值。针对该趋势中的每个数据点,统计平均登录时长和 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'

GetLogOnDurationDetailsTrend

获取指定时间段内的登录时长趋势。该趋势中的每个数据点均包含总登录时长和每个步骤的细分。

参数名称类型备注
startDateDateTime要查询其连接故障趋势的时间段的起始时间。必须采用 UTC 时间。
endDateDateTime要查询其连接故障趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLengthint趋势的数据点之间的时间间隔(以分钟为单位)。
desktopGroupsFilter字符串限制趋势结果的交付组Uid的列表(以逗号分隔)。

返回结果

LogonDurationTrendItem 列表:

属性名称类型备注
LogonDurationTrendListLogOnDurationTrendItem 包含一个 UTC 日期 (DateTime) 和一个用于表示当时平均登录时长的双精度值(以毫秒为单位)。还包含针对每个数据点每个登录步骤平均时长的细分。

示例

获取 24 小时内(每 15 分钟采集一个数据点)两个指定交付组的登录时长趋势(以毫秒为单位)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationDetailsTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

获取一周内(每 4 小时采集一个数据点)的登录时长趋势(以毫秒为单位)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationDetailsTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240

GetLogOnDurationTrend

获取指定时间段内的登录时长趋势(平均值)。

参数名称类型备注
startDateTime要查询其平均登录时长趋势的时间段的起始时间。必须采用 UTC 时间。
endDateTime要查询其平均登录时长趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLengthint趋势的数据点之间的时间间隔(以分钟为单位)。

返回结果

TrendItem 对象的 IQueryable。TrendItem 包含一个 UTC 日期 (DateTime) 和一个表示指定时间段内的平均登录时长趋势的值(以毫秒为单位)。

示例

按每分钟一个数据点(表示这 1 分钟内的平均登录时长)获取 1 小时的数据。如果在这 1 分钟内未进行登录,TrendItem 中的值为 NaN(而非数字)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationTrend?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:24:00'&intervalLength=1

获取该小时内表示平均登录登录时长的单个数据点。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationTrend?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:23:00'&intervalLength=60

GetMachineFailureTrend

获取指定时间段内的并发计算机故障趋势。趋势中的每个数据点表示在最后一个时间间隔(由 intervalLength 参数界定)内任意时间发生故障的最大计算机数。通过指定特定计算机故障类型,可以限制查询,或者获取所有故障类型。

参数名称 类型 备注
startDate DateTime 要查询其连接故障趋势的时间段的起始时间。必须采用 UTC 时间。
endDate DateTime 要查询其连接故障趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)。
desktopGroupsFilter 字符串 限制趋势结果的交付组 UID 列表(以逗号分隔)。
machineFailureTypeFilter 字符串 限制趋势结果的连接故障类型整数列表(以逗号分隔)。此整数与 MachineFaultStateCode 枚举相对应。如果未提供,返回此趋势中汇总的所有类型。
sessionSupportFilter int 限制趋势结果的计算机类型整数列表,以逗号分隔 (Single=1, Multiple=2, Unknown=0)。没有值能返回所有类型

返回结果

TrendItem 对象列表 (FailureTrend)。

属性名称 类型 备注
FailureTrend List TrendItem 包含一个 UTC 日期 (DateTime) 和一个用于指示指定过滤器在指定时间段内的计算机故障趋势的故障计数 (int)。

示例

获取 24 小时内指定桌面操作系统计算机类型的两个交付组所有类型的计算机故障的趋势(每 15 分钟采集一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&sessionSupportFilter='1'&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

获取 24 小时内所有交付组和会话类型,以及类型为“启动失败”和“启动时卡住”的计算机故障的趋势(每 2 小时采集一个数据点)。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240&machineFailureTypeFilter='2,3'

GetMachineFailureTrendsByType

按类型获取指定时间段内的计算机故障和成功次数列表,以及每种类型的趋势。趋势中的每个数据点表示在最后一个时间间隔(由 intervalLength 参数界定)内处于故障状态的计算机总数。可以指定某个特定的故障类型以限制查询,或者获取所有故障类型。

参数名称 类型 备注
startDate DateTime 要查询其计算机故障趋势的时间段的起始时间。必须采用 UTC 时间。如果不提取趋势,则不需要。
endDate DateTime 要查询其计算机故障趋势的时间段的结束时间。必须采用 UTC 时间。
intervalLength int 趋势的数据点之间的时间间隔(以分钟为单位)。
machineFailureType int (MachineFailureType) 如果提供了此参数(值大于 0),结果中将仅返回此计算机故障类型。否则(空值或 0 值),将返回所有故障类型列表。此整数与 MachineFailureType 枚举相对应。
sessionSupport int (SessionSupport) Nullable int。如果没有提供,则返回所有 sessionSupport 类型。Single=1,Multiple=2,Unknown=0

返回结果

MachineFailureTrend 对象的 IQueryable,包含每个 MachineFailureType 的以下信息。

如果请求所有类型,则将返回总和及 MachineFailureType = -1。

如果查询中包含 $expand=FailureTrend,则会检索每种故障类型的趋势和 TotalFailureCount 属性。

如果查询中包含 $expand=DesktopGroupBreakdown,还会检索每种故障类型的此属性。

属性名称 类型 备注
MachineFailureType int [MachineFailureType] 连接故障类型(请参阅:确定枚举值)。
TotalFailureCount int 在指定的 endDate 发生的故障总数。
FailureTrend List TrendItem 包含一个 UTC 日期 (DateTime) 和一个用于指示此故障类型在指定时间段内的计算机故障趋势的计数 (double)。
DesktopGroupBreakdown List DesktopGroupBreakdown 中包含 DesktopGroup 对象和计数 (int)。计数 (int) 表示在指定 endDate 处于故障状态的计算机总数。

示例

针对所有服务器操作系统计算机(即 sessionSupport =2),按每 30 分钟一个数据点检索 11 月 14 日上午 5 点 (UTC) 到 11 月 14 日上午 7 点 (UTC) 时间段内所有计算机故障类型的交付组细分和故障趋势:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&intervalLength=30&machineFailureType=0&sessionSupport=2&$expand=FailureTrend,DesktopGroupBreakdown

针对桌面操作系统计算机按交付组细分进行检索。检索仅针对计算机故障类型 3(启动时卡住),时间跨度从 11 月 14 日上午 5 点 (UTC) 到 11 月 14 日上午 7 点 (UTC):

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&machineFailureType=3&sessionSupport=1&$expand=FailureTrend

对所有计算机会话类型的所有故障类型,按故障趋势进行检索。时间跨度从 11 月 14 日午夜 12 点 (UTC) 到 11 月 14 日晚上 11 点 (UTC),每小时采集一个数据点:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T00:00:00'&endDate=datetime'2011-11-14T23:00:00'&intervalLength=60&machineFailureType=0&$expand=FailureTrend

GetSessionCountTrend

获取数据点,采用 DateTime 值对列表的方式来表示指定时间段内的并发连接会话趋势。每个点表示在指定时间间隔内的最大并发连接会话数。此值的计算方法如下,计算 DesktopGroups 的总和,然后取总和的最大值。

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

返回结果

TrendItem 对象的 IQueryable 列表 - IQueryable - 按日期升序排序。

每个 TrendItem 包含一个 UTC 日期 (DateTime) 属性和一个用于绘制趋势的值属性 (int)。

示例

获取 24 小时内的并发连接会话趋势,每小时采集一个数据点。每个数据点表示在最后一个时间间隔(这种情况下为 60 分钟)内统计的最大并发会话(仅限已连接的会话)数。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='1'

获取 24 小时内的并发断开连接的会话趋势,每小时采集一个数据点。每个数据点表示在最后一个时间间隔(这种情况下为 60 分钟)内统计的最大并发会话(仅限已断开连接的会话)数。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='2'

为桌面操作系统计算机和服务器操作系统计算机两种计算机类型,获取上周的并发会话(包括已连接的会话和已断开连接的会话)趋势,每 6 小时采集一个数据点。每个数据点表示在最后一个时间间隔(这种情况下为 6 小时)内统计的最大并发会话数。

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=360

GetSessionSummary

获取数据点,采用 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?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'

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

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'