Product Documentation

GetConnectionFailureTrendsByType

Nov 06, 2015

按类型获取指定时间段内的连接故障次数列表,以及每种类型的趋势。趋势中的每个数据点表示在最后一个时间间隔(由 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