Product Documentation

Monitor Service OData API

Feb 23, 2016
除使用 Citrix Director 控制台显示历史数据外,还可以使用 Monitor Service API 查询数据。 您可以使用 API 执行以下操作:
  • 分析历史趋势以便进行未来规划
  • 对连接失败和计算机故障进行细致的故障排除
  • 提取信息以用于其他工具和流程;例如,可以使用 Microsoft Excel 的 PowerPivot 表以不同的方式显示数据
  • 基于 API 提供的数据构建自定义用户界面

Monitor Service API 使用开放数据协议 (OData)。此协议是一个用于查询和更新数据的 Web 协议,并基于诸如 HTTP 之类的 Web 技术而构建。 有关 OData 协议的详细信息,请参阅 http://www.odata.org

Monitor Service API 在使用 Windows Communication Foundation (WCF) Data Services(在处理和合并期间填充)的 SQL Server 数据库的基础上构建。 通过 wsHttpBinding 显示了两个使用 WCF 的端点。 基址为 http:// {dc-host}/Citrix/Monitor/OData/v2。 还可以使用 TLS 保护端点;有关详细信息,请参阅使用 TLS 保护端点安全
  1. 数据端点可显示对数据库实体的直接只读访问权限,并且可以使用 OData 查询语言进行访问。 根据过滤和列选择,本端点允许高度灵活的访问。 数据 API URI 为 http://{dc-host}/Citrix/Monitor/OData/v2/Data。 有关访问 Monitor Service 数据的详细信息,请参阅使用 API 访问数据
  2. 方法端点可显示 Citrix Director 用于检索需要复杂分组和高性能标准的数据的服务操作(例如“控制板”和“趋势”页上的查询)。 方法 API URI 为 http://{dc-host}/Citrix/Monitor/OData/v2/Methods。 方法仅在 Director 本身中使用,因而不供大多数 Citrix 客户使用。 所以,此处并未介绍这些方法。

此版本中有哪些新增功能?

XenApp 和 XenDesktop 7.6 附带的 API 版本提供以下新功能:
  • 修补程序清单。 在 Director 中使用“用户详细信息”视图或“计算机”视图,您会看到计算机上安装的所有 Citrix 修补程序的列表。 您可以使用 API 提取此数据并创建自定义报告(例如,整个站点上安装的修补程序的状态)或将其拉到分析引擎中。 引入了新类并且扩展了 Machine 类,可支持跟踪控制器和 VDA 上安装的 Citrix 修补程序。
  • 匿名会话故障排除。 会话可作为一组池本地用户帐户运行。 API 向 Session 类添加了新属性 IsAnonymous(默认值为 FALSE)。
  • 托管应用程序使用率报告。 Director 提供新的容量报告,可显示托管应用程序随时间变化的使用率。 API 允许您报告用户会话中运行的每个应用程序实例的详细信息。

以下位置的《API 参考》中完整介绍了所有数据更新:http://support.citrix.com/help/monitorserviceapi/7.6/

本版本已弃用 GetSessionSummary 方法。