Product Documentation

Überwachungsdienst-OData-API

Feb 29, 2016
Zusätzlich zur Anzeige von historischen Daten in der Citrix Director-Konsole können Sie Daten mit der Überwachungsdienst-OData-API abfragen. Sie können die API für Folgendes verwenden:
  • Analysieren historischer Trends für die Planung
  • Durchführen einer eingehenden Problembehandlung bei Verbindungs- und Maschinenfehlern
  • Extrahieren von Informationen für die Eingabe in andere Tools und Prozesse, z. B. wenn PowerPivot-Tabellen in Microsoft Excel für die Anzeige von Daten auf verschiedene Weise verwendet werden
  • Erstellen einer benutzerdefinierten Benutzeroberfläche auf der Basis der von der API bereitgestellten Daten

Die Überwachungsdienst-OData-API verwendet das Open Data-Protokoll (OData), ein Webprotokoll für die Abfrage und Aktualisierung von Daten, das auf Webtechnologien wie HTTP aufbaut. Weitere Informationen über das OData-Protokoll finden Sie unter http://www.odata.org.

Die Überwachungsdienst-API setzt mit den Windows Communication Foundation (WCF) Data Services auf SQL Server-Datenbanken auf, die während der Verarbeitung und Konsolidierung aufgefüllt werden. Bei Verwendung von WCF mit wsHttpBinding werden zwei Endpunkte verfügbar gemacht. Die Basisadresse ist http:// {dc-host}/Citrix/Monitor/OData/v2. Sie können Endpunkte auch mit TLS schützen (weitere Informationen finden Sie unter Schützen von Endpunkten mit TLS).
  1. Der Endpunkt "Data" gestattet direkten Lesezugriff auf die Datenbankentitäten, Zugriff ist mit der Abfragesprache OData möglich. Dieser Endpunkt gestattet einen sehr flexiblen Zugriff im Hinblick auf Filter- und Spaltenauswahl. Die URI der Data-API ist: http://{dc-host}/Citrix/Monitor/OData/v2/Data. Weitere Informationen über den Zugriff auf Monitor Service-Daten finden Sie unter Zugriff auf Daten mit der API.
  2. Der Endpunkt "Methods" macht Dienstvorgänge verfügbar, die von Citrix Director für das Abrufen von Daten verwendet werden, die eine komplexe Gruppierung und hohe Leistungsstandards erfordern (z. B. Abfragen für das Dashboard und Trend-Seiten). Die URI der Methods-API ist: http://{dc-host}/Citrix/Monitor/OData/v2/Methods. Methoden werden nur in Director selbst verwendet, d. h. nicht von der Mehrheit der Citrix Kunden. Sie werden daher hier nicht dokumentiert.

Neue Funktionen in diesem Release

Die in XenApp und XenDesktop 7.6 enthaltene API-Version bietet die folgenden neuen Features:
  • Hotfix-Bestand In der Ansicht "Benutzerdetails" oder „Maschine“ in Director können Sie eine Liste aller Citrix Hotfixes anzeigen, die auf einer Maschine installiert wurden. Sie können mit der API diese Daten extrahieren und benutzerdefinierte Berichte erstellen (z. B. Status der installierten Hotfixes über eine ganze Site) oder sie in eine Analyticsengine ziehen. Neue Klassen wurden eingeführt und die Maschinenklasse unterstützt nun die Nachverfolgung von auf dem Controller und VDAs installierten Citrix Hotfixes.
  • Anonyme Sitzungsproblembehandlung. Sitzungen können in Form gepoolter lokaler Benutzerkonten ausgeführt werden. Die API hat eine neue IsAnonymous-Eigenschaft für die Sitzungsklasse (Standardwert = FALSE).
  • Bericht über die Verwendung gehosteter Anwendungen. Director bietet neue Kapazitätsberichte zur Verwendung gehosteter Anwendungen über bestimmte Zeiträume. Mit der API können Sie Berichte zu den Details jeder in einer Benutzersitzung ausgeführten Anwendungsinstanz erstellen.

Alle die Daten betreffenden Updates sind in der API-Referenz unter http://support.citrix.com/help/monitorserviceapi/7.6/ vollständig dokumentiert.

Die Methode "GetSessionSummary" ist seit diesem Release veraltet.