Product Documentation

使用 API 访问数据

Oct 12, 2015

以下主题介绍如何使用 Monitor Service OData API 访问数据。

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

身份验证

要使用 Monitor Service OData API,您必须是 XenApp 或 XenDesktop 管理员。要调用 API,您需要具有只读权限;但是,返回的数据由 XenApp 或 XenDesktop 管理员角色和权限决定。例如,交付组管理员可以调用 Monitor Service API,但他们可以获取的数据由使用 Citrix Studio 设置的交付组访问权限控制。有关 XenApp 或 XenDesktop 管理员角色和权限的详细信息,请参阅委派管理

查询数据

Monitor Service API 是一款基于 REST 的 API,可以使用 OData 使用者程序进行访问。OData 使用者程序是占用使用 OData 协议显示的数据的应用程序。从简单的 Web 浏览器到可利用 OData 协议的所有功能的自定义应用程序,OData 使用者程序的复杂程度各不相同。有关 OData 使用者程序的详细信息,请参阅:http://www.odata.org/ecosystem#consumers

每一部分 Monitor Service 数据模型都可访问,并且可根据 URL 过滤。OData 以 URL 格式提供查询语言,可用于从服务检索条目。有关详细信息,请参阅:http://msdn.microsoft.com/en-us/library/ff478141.aspx

查询在服务器端进行处理,并且可以使用客户端上的 OData 协议进行进一步过滤。

注意:OData 协议不支持枚举;在其位置使用整数。要确定 Monitor Service OData API 返回的值,请参阅确定枚举值

数据类别

Monitor Service 收集多种数据,其中包括用户会话使用情况、用户登录性能详细信息、会话负载平衡详细信息,以及连接和计算机故障信息。根据其类别,数据以不同的方式聚合。了解使用 OData Method API 提供的数据值的聚合是解释数据的关键。例如:

  • 一段时间内发生的连接的会话故障和计算机故障,因此它们显示为一段时间内的最大值
  • 登录持续时间是时间长度的度量,因此它们显示为一段时间内的平均值
  • 登录计数和连接故障是一段时间内这类事件的计数,因此它们显示为一段时间内的总数

并发数据评估

会话必须重叠才能视为并发。但是,当时间间隔为 1 分钟时,该时间内的所有会话(无论会话是否重叠)都将被视为并发,即时间间隔太小,计算精确度时涉及的性能开销不值得所添加的值。如果会话发生在同一小时,但不同分钟内,则不会被视为重叠。