Product Documentation

Acceso a datos usando la API

Nov 11, 2015

El siguiente tema explica cómo obtener acceso a los datos mediante la API de Monitor Service OData.

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/v1. También puede usar SSL para proteger los dispositivos de punto final. Consulte Protección de puntos finales mediante SSL para obtener más información.
  1. 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/v1/Methods.
  2. 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 términos de filtrado y selección de columnas, pero no ofrece los mismos beneficios de rendimiento asociados a las operaciones de servicio de alta especificidad. El URI de la API de Datos es: http://{dc-host}/Citrix/Monitor/OData/v1/Data

Autenticación

Para usar la API de OData de Monitor Service, debe ser un administrador de XenApp o XenDesktop. Para llamar a la API necesita privilegios de solo lectura; sin embargo, los datos devueltos vienen determinados por los roles y los permisos de administrador de XenApp o XenDesktop. Por ejemplo, los administradores de grupos de entrega pueden llamar a la API de Monitor Service, pero los datos que pueden obtener están controlados por el acceso a grupos de entrega configurado con Citrix Studio. Para obtener más información sobre los roles y permisos de administrador de XenApp o XenDesktop, consulte Administración delegada.

Consulta de datos

La API de Monitor Service es una API basada en REST a la que se puede acceder con un consumidor de OData. Los consumidores de OData son aplicaciones que consumen datos expuestos mediante el protocolo OData. Los consumidores de OData varían en complejidad; desde los exploradores Web más simples hasta aplicaciones personalizadas que pueden beneficiarse de todas las funciones del protocolo OData. Para obtener más información acerca de los consumidores de OData, consulte http://www.odata.org/ecosystem#consumers.

Cada parte del modelo de datos de Monitor Service es accesible y se puede filtrar en la URL. OData ofrece un lenguaje de consulta en el formato de la URL que puede utilizar para recuperar las entradas de un servicio. Para obtener más información, consulte http://msdn.microsoft.com/en-us/biblioteca/ff478141.aspx.

La consulta se procesa en el lado del servidor y se puede filtrar más mediante el protocolo OData en el lado del cliente.

Nota: Las enumeraciones no son compatibles con el protocolo OData; en su lugar, se utilizan enteros. Para determinar los valores devueltos por la API de Monitor Service OData, consulte Determinación de los valores de enumeración.

Categorías de datos

Monitor Service recopila una serie de datos, incluidos el uso de las sesiones de usuario, la información del rendimiento de los inicios de sesión de usuario, la información del equilibrio de carga de las sesiones y la información de fallos de conexión y de las máquinas. Los datos se agregan de forma diferente en función de la categoría. Para interpretar los datos, es fundamental comprender la agregación de los valores de los datos presentados mediante las API de Método de OData. Por ejemplo:

  • Las sesiones conectadas y los fallos de máquina se producen durante un período de tiempo, por lo que se exponen como máximos a lo largo de ese período de tiempo
  • La duración del inicio de sesión es una medida de tiempo, por lo que se expone como el promedio de un período de tiempo
  • Los recuentos de inicio de sesión y los fallos de conexión son el número de repeticiones en un período de tiempo, por lo que se exponen como sumas a lo largo de un período de tiempo

Evaluación de datos simultáneos

Las sesiones deben superponerse para considerarse simultáneas. No obstante, cuando el intervalo de tiempo es de 1 minuto, todas las sesiones en ese minuto (se superpongan o no) se consideran simultáneas; es decir, el tamaño del intervalo es tan pequeño que el valor agregado no compensa la sobrecarga de rendimiento para calcular el valor preciso. Si las sesiones se producen en la misma hora, pero no en el mismo minuto, no se consideran superpuestas.