Product Documentation

API de OData de Monitor Service

Jul 07, 2016
Además de utilizar la consola de Citrix Director para mostrar datos históricos, puede consultar datos con la API de Monitor Service. Puede usar la API para:
  • Analizar tendencias históricas para planificaciones futuras
  • Realizar informes de error detallados sobre problemas de máquina y conexión
  • Extraer información para insertarla en otras herramientas y procesos; por ejemplo, mediante las tablas de PowerPivot de Microsoft Excel para mostrar los datos de diferentes formas
  • Generar una interfaz de usuario personalizada en la parte superior de los datos que proporciona la API

La API de Monitor Service usa el protocolo Open Data (OData), un protocolo Web para consultar y actualizar datos, integrado en tecnologías Web como HTTP. Para obtener más información acerca del protocolo OData, consulte http://www.odata.org.

La API de Monitor Service está construida encima de las bases de datos de SQL Server con Windows Communication Foundation (WCF) Data Services, el cual se rellena durante el procesamiento y la consolidación. Al usar WCF con wsHttpBinding, quedan expuestos dos puntos finales. La dirección base es: http://{dc-host}/Citrix/Monitor/OData/v2. También puede usar TLS para proteger los dispositivos de punto final. Consulte Protección de puntos finales mediante TLS para obtener más información.
  1. El punto final de Datos expone el acceso de solo lectura directamente a las entidades de bases de datos y se puede acceder a él mediante el lenguaje de consultas de OData. Este punto final permite un acceso muy flexible en las condiciones de filtrado y la selección de columna. El URI de la API de Datos es: http://{dc-host}/Citrix/Monitor/OData/v2/Data. Para obtener más información acerca del acceso a los datos de Monitor Service, consulte Acceso a datos usando la API.
  2. El punto final de Métodos expone las operaciones de servicio que usa Citrix Director para recuperar datos que requieren una agrupación compleja y unos estándares de alto rendimiento, tales como las consultas en las páginas de Panel de mandos y de Tendencias. El URI de la API de Métodos es: http://{dc-host}/Citrix/Monitor/OData/v2/Methods. Los métodos se pueden usar solo en Director en sí, por lo que la mayoría de los clientes Citrix no los usa. Por lo tanto, no se documentan aquí.

Novedades de esta versión

La versión de la API incluida con XenApp y XenDesktop 7.6 ofrece las siguientes características nuevas:
  • Inventario de revisiones hotfix. Mediante las vistas Máquina o Detalles del usuario en Director, puede ver una lista de todos los hotfix de Citrix que se han instalado en una máquina. Puede usar la API para extraer estos datos y crear informes personalizados (por ejemplo, el estado de las revisiones hotfix instaladas en todo el sitio) o pasarlos a un motor de análisis. Se han introducido nuevas clases y la clase Machine se ha ampliado para dar respaldo al seguimiento de revisiones hotfix de Citrix instaladas en los Controllers y VDA.
  • Solución de problemas de las sesiones anónimas. Las sesiones pueden ejecutarse como un conjunto agrupado de cuentas de usuario locales. La API tiene una nueva propiedad, IsAnonymous, para la clase Session (el valor predeterminado es FALSE).
  • Informes de uso de aplicaciones alojadas. Director proporciona nuevos informes de capacidad que muestran el uso de aplicaciones alojadas a lo largo del tiempo. La API permite en crear informes detallados sobre cada instancia de aplicación que se ejecuta en una sesión de usuario.

Todas las actualizaciones de datos están totalmente documentadas en la Referencia para API en http://support.citrix.com/help/monitorserviceapi/7.6/.

El método GetSessionSummary ha quedado obsoleto en esta versión.