Product Documentation

Methoden

Sep 29, 2015

In den folgenden Abschnitten werden die von der API verfügbar gemachten Methoden beschrieben. Neben den Methoden werden die angegebenen Parameter und die vom API-Aufruf zurückgegebenen Elemente erläutert. Zudem werden Beispiele für Abfragen gegeben.

Weitere Informationen zur Angabe der Zeitintervalle finden Sie unter Info über die Zeit und Datumsbereiche. Weitere Informationen zu den von der Überwachungsdienst-OData-API zurückgegebenen Werten siehe Bestimmen der Enumerationswerte.

GetAverageLogOnBreakdown

Ruft die durchschnittliche Anmeldedauer für den angegebenen Zeitraum, die Benutzer-ID und den Parameter "desktopGroupUid" ab.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Durchschnitt abgerufen wird. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den der Durchschnitt abgerufen wird. Dies muss eine UTC-Angabe sein.
userSid Zeichenfolge Benutzer-SID, auf die der Durchschnitt beschränkt wird.
desktopGroupUid GUID Desktopgruppen-UID, auf die der Durchschnitt beschränkt wird.

Zurückgegebene Elemente

Ein IQueryable von LogOnBreakdown-Objekten, die für jeden Anmeldungsschritt Folgendes enthalten:

Eigenschaft Typ Anmerkungen
LogonStepItems List Liste der LogOnStepItems. Jeder LogonStepItem besitzt einen LogonStep (mögliche Werte sind Brokering=1, VMStart=2, HDX=3, Authentication=4, Gpos=5, LogonScripts=6, ProfileLoad=7, Interactive=8, Total=0) und eine Duration (Nullable) in Millisekunden. Wenn keine Daten für einen Schritt verfügbar sind, wird die Dauer mit NULL zurückgegeben.
BreakdownType int Typ der Aufschlüsselung. UsersLastSession=1, UsersSessionAverage=2, DesktopGroupAverage=3
Hinweis: Die HDX-Dauer ist eine neue Metrik, die Änderungen am ICA-Protokoll erfordert. Das bedeutet, dass wenn die neue Version des Clients nicht verwendet wird, als Metriken NULL zurückgegeben wird.

Beispiel

Ruft die durchschnittliche Anmeldedauer am 15. März, für diese Benutzer-ID und desktopGroupUid ab.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetAverageLogOnBreakdown?startDate=datetime'2012-03-15T00:00:00'&endDate=datetime'2012-03-30T00:00:00'&userSid='User%20Sid'&desktopGroupUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&$expand=LogOnStepItems

GetAverageLogOnDuration

Ruft den Trend der durchschnittlichen Anmeldedauer für den angegebenen Zeitraum ab. Abgedeckt werden nur erfolgreiche Anmeldungen (d. h. die einen LogOnStartDate- und einen LogOnEndDate-Eintrag in der Datenbank haben).

Parametername Typ Anmerkungen
start DateTime Beginn des Zeitraums, für den der Trend der durchschnittlichen Anmeldedauer abgefragt wird. Dies muss eine UTC-Angabe sein.
end DateTime Ende des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.

Zurückgegebene Elemente

Double, das die durchschnittliche Anmeldedauer für den angegebenen Zeitraum repräsentiert.

Beispiel

Ruft die durchschnittliche Anmeldedauer für eine Stunde für alle Bereitstellungsgruppen ab.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetAverageLogOnDuration?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:24:00'

GetConcurrentSessionsTrend

Ruft Datenpunkte für den angegebenen Zeitraum ab zur Darstellung eines Trends der gleichzeitigen Sitzungen in Form einer Liste von DateTime/Wert-Paaren. Jeder Punkt stellt die maximale Anzahl gleichzeitiger Sitzungen während des angegebenen Intervalls dar. Der letzte Punkt des Trends kann die Anzahl aktueller Benutzer im System darstellen.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den die gleichzeitigen Sitzungen abgefragt werden. Dies muss eine UTC-Angabe sein. Inklusiv.
endDate DateTime Ende des Zeitraums, für den die gleichzeitigen Sitzungen abgefragt werden. Dies muss eine UTC-Angabe sein. Inklusiv.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.

Zurückgegebene Elemente

IQueryable-Liste von TrendItem-Objekten – IQueryable, aufsteigend nach Datum sortiert.

Jedes TrendItem-Objekt enthält eine UTC-Datumseigenschaft (DateTime) und eine Werteigenschaft (double) zum Zeichnen des Trends.

Beispiel

Ruft den Trend gleichzeitiger Sitzungen über eine Stunde ab (Datenpunkt pro Minute):

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConcurrentSessionsTrend?startDate=datetime'2012-06-05T12:26:00'&endDate=datetime'2012-06-05T13:26:00'&intervalLength=1

GetConnectedUsersTrend

Ruft den Trend verbundener Benutzer für Serverbetriebssystemmaschinen während des angegebenen Zeitraums ab. Jeder Datenpunkt des Trends repräsentiert die Gesamtzahl der mit Serverbetriebssystemmaschinen verbundenen Benutzer im letzten Intervall (intervalLength).

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Trend verbundener Benutzer abgefragt wird. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den der Trend verbundener Benutzer abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.
desktopGroupsFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die das Ergebnis beschränkt wird.
machineFilter string Durch Trennzeichen getrennte Liste der Maschinen-SIDs, auf die das Ergebnis beschränkt wird.

Zurückgegebene Elemente

Ein IQueryable von Objekten mit folgendem Inhalt:

Eigenschaft Typ Anmerkungen
ConnectedUsersTrend List TrendItem enthält ein UTC-Datum (DateTime) und eine Anzahl (int) für die maximale Anzahl der verbundenen Benutzer im Intervall.

Beispiele

Ruft einen 24-Stunden-Trend (Datenpunkt alle 15 Minuten) der verbundenen Benutzer für die beiden angegebenen Bereitstellungsgruppen ab.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectedUsersTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

Ruft einen Wochentrend (Datenpunkt alle 4 Stunden) der verbundenen Benutzer ab.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectedUsersTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240

GetConnectionFailureTrend

Ruft den Trend der Verbindungsfehler für den angegebenen Zeitraum ab. Jeder Datenpunkt im Trend repräsentiert die Gesamtzahl der Verbindungsfehler im letzten Intervall (intervalLength-Parameter).

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.
desktopGroupsFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die das Ergebnis beschränkt wird.
connectionFailureTypeFilter string Durch Trennzeichen getrennte Liste der ganzen Zahlen für Verbindungsfehlertypen, auf die das Ergebnis beschränkt wird. Diese ganze Zahl entspricht der ConnectionFailureType-Enumeration.
sessionSupportFilter string Durch Trennzeichen getrennte Liste der Maschinentypen (Ganzzahl, Einzel = 1, Multi = 2, Unbekannt = 0), auf die das Ergebnis beschränkt wird. Erfolgt keine Angabe, werden beide Typen zurückgegeben.

Zurückgegebene Elemente

Ein IQueryable von TrendItem-Objekten.

Eigenschaft Typ Anmerkungen
FailureTrend List TrendItem enthält ein UTC-Datum (DateTime) und eine Anzahl (int) von Fehlern, die den Trend der Verbindungsfehler im angegebenen Zeitraum gemäß der festgelegten Filter darstellen.

Beispiele

Ruft einen 24-Stunden-Trend (Datenpunkt alle 15 Minuten) aller Typen von Fehlern bei Verbindungen mit Desktopbetriebssystemmaschinen für die beiden angegebenen Bereitstellungsgruppen ab.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrend?startdate=datetime'2011-09-30T00:00:00'&enddate=datetime'2011-10-

Ruft einen Wochentrend (Datenpunkt alle 4 Stunden) für 3 Typen von Verbindungsfehlern (aggregiert) für alle Bereitstellungsgruppen ab, für die der Benutzer Zugriff hat.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrend?startdate=datetime'2011-09-23T00:00:00'&enddate=datetime'2011-10-01T00:00:00'intervalLength=240&connectionFailureTypeFilter='2,3,4'

GetConnectionFailureTrendsByType

Ruft eine Liste der Verbindungsfehler nach Typ sowie einen Trend für jeden Typ für den angegebenen Zeitraum ab. Jeder Datenpunkt im Trend repräsentiert die Gesamtzahl der Verbindungsfehler im letzten Intervall (intervalLength-Parameter). Die Abfrage kann auf einen bestimmten Fehlertyp beschränkt oder es können alle Fehler abgefragt werden.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLength Int Intervall zwischen Datenpunkten in Minuten für den Trend.
connectionFailureType Int [ConnectionFailureType] Sofern festgelegt (>0), werden nur Verbindungsfehler dieses Typs zurückgegeben. Andernfalls (0) werden alle Fehlertypen zurückgegeben. Diese ganze Zahl entspricht der ConnectionFailureType-Enumeration.

Zurückgegebene Elemente

Ein IQueryable von ConnectionFailureTrend-Objekten, die für jeden ConnectionFailureType Folgendes enthalten.

Wenn alle Typen abgefragt werden, wird auch die Summe mit ConnectionFailureType = -1 zurückgegeben.

Enthält die Abfrage "$expand = FailureTrend", werden für jeden Fehlertyp die Eigenschaften "Trend" und "TotalFailureCount" abgerufen.

Enthält die Abfrage "$expand=DesktopGroupBreakdown", wird auch diese Eigenschaft abgerufen.

Eigenschaft Typ Anmerkungen
ConnectionFailureType int [ConnectionFailureType] Der Typ des Verbindungsfehlers (aus der Enumeration "ConnectionFailureType").
FailureTrend List TrendItem enthält ein UTC-Datum (DateTime) und einen Wert (nullable double), die den Trend der Verbindungsfehler des angegebenen Typs über den angegebenen Zeitraum darstellen.
TotalFailureCount int Die Gesamtzahl der Fehler im angegebenen Zeitraum.
DesktopGroupBreakdown List DesktopGroupBreakdown enthält ein DesktopGroup-Objekt (dieses muss im "expand" enthalten sein, damit es zurückgegeben wird) und Count (int), das die Gesamtzahl der Fehler im angegebenen Zeitraum darstellt.

Beispiele

Ruft unter Aufschlüsselung nach Bereitstellungsgruppe den Trend aller Fehlertypen für den Zeitraum vom 14. November 05:00 Uhr (UTC) bis zum 14. November 07:00 Uhr (UTC) mit einem Datenpunkt alle 30 Minuten ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&intervalLength=30&connectionFailureType=0&$expand=FailureTrend,DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Ruft unter Aufschlüsselung nach Bereitstellungsgruppe den Trend des Fehlertyps 4 (keine Kapazität verfügbar) für den Zeitraum vom 14. November 05:00 Uhr (UTC) bis zum 14. November 07:00 Uhr (UTC) ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&connectionFailureType=4&$expand=DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Ruft den Trend aller Fehlertypen für den Zeitraum vom 14. November 00:00 Uhr (UTC) bis zum 14. November 23:00 Uhr (UTC) mit einem Datenpunkt alle 60 Minuten ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T00:00:00'&endDate=datetime'2011-11-14T23:00:00'&intervalLength=60&connectionFailureType=0&$expand=FailureTrend

GetConnectionFailureTrendsByTypeLatest

Aktualisiert: 2013-11-11

Ruft eine Liste der Verbindungsfehler nach Typ sowie einen Trend für jeden Typ für die angegebene Zahl Intervalle bis zum aktuellen Zeitpunkt (UTC-Serverzeit) ab. Jeder Datenpunkt im Trend repräsentiert die Gesamtzahl der Verbindungsfehler im letzten Intervall (intervalLength-Parameter). Die Abfrage kann auf einen bestimmten Fehlertyp beschränkt oder es können alle Fehler abgefragt werden.

Parametername Typ Anmerkungen
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.
numberOfIntervals int Anzahl der angeforderten Datenpunkte. Dient zusammen mit intervalLength zum Berechnen von StartDate.
connectionFailureType int [ConnectionFailureType] Sofern festgelegt (>0), werden nur Verbindungsfehler dieses Typs zurückgegeben. Andernfalls (0) werden alle Fehlertypen zurückgegeben. Diese ganze Zahl entspricht der ConnectionFailureType-Enumeration.

Zurückgegebene Elemente:

Ein IQueryable von ConnectionFailureTrend-Objekten, die für jeden ConnectionFailureType Folgendes enthalten.

Wenn alle Typen abgefragt werden, wird auch die Summe mit ConnectionFailureType = -1 zurückgegeben.

Enthält die Abfrage "$expand = FailureTrend", werden für jeden Fehlertyp die Eigenschaften "Trend" und "TotalFailureCount" abgerufen.

Enthält die Abfrage "$expand=DesktopGroupBreakdown", wird auch diese Eigenschaft abgerufen.

Eigenschaft Typ Anmerkungen
ConnectionFailureType int [ConnectionFailureType] Der Typ des Verbindungsfehlers (aus der Enumeration "ConnectionFailureType").
FailureTrend List TrendItem enthält ein UTC-Datum (DateTime) und einen Wert (nullable double), die den Trend der Verbindungsfehler des angegebenen Typs über den angegebenen Zeitraum darstellen.
TotalFailureCount int Die Gesamtzahl der Fehler im angegebenen Zeitraum.
DesktopGroupBreakdown List DesktopGroupBreakdown enthält ein DesktopGroup-Objekt (dieses muss im "expand" enthalten sein, damit es zurückgegeben wird) und Count (int), das die Gesamtzahl der Fehler im angegebenen Zeitraum darstellt.

Beispiele

Ruft unter Aufschlüsselung nach Bereitstellungsgruppe den Fehlertrend für die letzten 60 Minuten mit einem Datenpunkt pro Minute ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=1&numberOfIntervals=60&connectionFailureType=0&$expand=FailureTrend,DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Ruft unter Aufschlüsselung nach Bereitstellungsgruppe den Trend des Fehlertyps 4 (keine Kapazität verfügbar) für die letzten 30 Minuten ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=1&numberOfIntervals=30&connectionFailureType=4&$expand=DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Ruft den Fehlertrend für alle Fehlertypen für die letzten 24 Stunden mit einem Datenpunkt pro Stunde ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=60&numberOfIntervals=24&connectionFailureType=0&$expand=FailureTrend

GetLastSessionLogOnBreakdown

Ruft die Aufschlüsselung der Anmeldungen für Benutzer und Bereitstellungsgruppen ab. Gibt die aktuelle Benutzersitzung, sofern vorhanden, zurück.

Parametername Typ Verbindlich? Anmerkungen
userSid Zeichenfolge Ja ID des Benutzers, für den Informationen angefordert werden.
desktopGroupUid GUID Ja Abgefragte Bereitstellungsgruppe.
machineUid Zeichenfolge Nein Maschine, auf der die letzte Sitzung ausgeführt wurde. Dies ist möglicherweise nicht verfügbar.

Zurückgegebene Elemente

Ein IQueryable von LogOnBreakdown-Objekten, die für jeden Anmeldungsschritt Folgendes enthalten:

Eigenschaft Typ Anmerkungen
LogonStepItems List Liste der LogOnStepItems. Jeder LogonStepItem besitzt einen LogonStep (mögliche Werte sind Brokering=1, VMStart=2, HDX=3, Authentication=4, Gpos=5, LogonScripts=6, ProfileLoad=7, Interactive=8, Total=0) und eine Duration (Nullable) in Millisekunden. Wenn keine Daten für einen Schritt verfügbar sind, wird die Dauer mit NULL zurückgegeben.
BreakdownType int Typ der Aufschlüsselung – UsersLastSession = 1, UsersSessionAverage = 2, DesktopGroupAverage = 3

Beispiel

Ruft die Anmeldeaufschlüsselung für Benutzer und Bereitstellungsgruppe ab. Gibt die aktuelle Benutzersitzung, falls vorhanden, zurück.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLastSessionLogOnBreakdown?userSid='User%20Sid'&desktopGroupUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&machineUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&$expand=LogOnStepItems

GetEffectiveLoadIndexTrend

Ruft den Load Evaluation Index-Trend (LEI) für Serverbetriebssystemmaschinen für den angegebenen Zeitraum (in Minuten) ab. Jeder Datenpunkt repräsentiert den durchschnittlichen Lastindex für das jeweilige Intervall. Es wird ein IQueryable von LoadIndexTrendItems zurückgegeben, das den effektiven Lastindex und die Aufschlüsselung nach einzelnen Typen (CPU, Arbeitsspeicher, Datenträger, Netzwerk, Sitzungszahl) darstellt.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Lastindextrend abgefragt wird. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den der Lastindextrend abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.
desktopGroupsFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die das Ergebnis beschränkt wird.
machineFilter string Durch Trennzeichen getrennte Liste der Maschinen-SIDs, auf die das Ergebnis beschränkt wird. Erwartet MultiSession-Maschinen.

Zurückgegebene Elemente

Ein IQueryable von Objekten mit folgendem Inhalt:

Eigenschaft Typ Anmerkungen
LoadIndexTrend List LoadIndexTrendItem enthält ein UTC-Datum (DateTime) und eine ganze Zahl für den gesamten LEI sowie ganze Zahlen für die einzelnen LEI-Bestandteile (CPU, Arbeitsspeicher, Datenträger, Netzwerk, Sitzungszahl) in einem separaten Objekt (sofern "$expand=Breakdown" in der Abfrage festgelegt wurde).

Beispiele

Ruft einen 24-Stunden-Trend (Datenpunkt alle 15 Minuten) des Lastindextrends unter Aufschlüsselung nach den beiden angegebenen Bereitstellungsgruppen ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetEffectiveLoadIndexTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'&$expand=Breakdown

Ruft einen wöchentlichen Lastindextrend (Datenpunkt alle 4 Stunden) ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetEffectiveLoadIndexTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240&$expand=Breakdown

GetLoadIndexTrend

Aktualisiert: 2013-07-24

Ruft den Load Evaluation Index-Trend (LEI) für Serverbetriebssystemmaschinen für den angegebenen Zeitraum nach LEI-Typen ab. Jeder Datenpunkt im Trend zeigt den gesamten LEI sowie die Aufschlüsselung nach Lastindextyp (CPU, Arbeitsspeicher, Datenträger, Netzwerk, Sitzungszahl).

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Lastindextrend abgefragt wird. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den der Lastindextrend abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend
desktopGroupsFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die das Ergebnis beschränkt wird.
machineFilter string Durch Trennzeichen getrennte Liste der Maschinen-SIDs, auf die das Ergebnis beschränkt wird. Erwartet MultiSession-Maschinen.
indexTypeFilter string Durch Trennzeichen getrennte Liste der einzuschließenden Lastindextypen (effektiv, CPU, Netzwerk, Arbeitsspeicher, Datenträger Sitzungszahl). Entspricht der LoadIndexType-Enumeration. Eine leere oder NULL-Zeichenfolge gibt alle Typen zurück.

Zurückgegebene Elemente

Ein IQueryable von Objekten, das für jeden festgelegten Indextyp Folgendes enthält:

Eigenschaft Typ Anmerkungen
LoadIndexType int [LoadIndexType] entspricht der LoadIndexType-Enumeration.
LoadIndexTrend List TrendItem enthält ein UTC-Datum (DateTime) und eine ganze Zahl für den Index.

Beispiele

Ruft einen 24-Stunden-Trend (Datenpunkt alle 15 Minuten) des Lastindextrends unter Aufschlüsselung nach den beiden angegebenen Bereitstellungsgruppen ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLoadIndexTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

Ruft einen LEI-Wochentrend (Datenpunkt alle 4 Stunden) unter Aufschlüsselung ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLoadIndexTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240

GetLogOnCountTrend

Ruft den Anmeldedauertrend (Durchschnitt) gruppiert nach Intervall (Uhrzeit, Wochentag, etc.) für den angegebenen Zeitraum ab. Abgedeckt werden nur erfolgreiche Anmeldungen (d. h. die einen LogOnStartDate- und einen LogOnEndDate-Eintrag in der Datenbank haben).

ParameternameTypAnmerkungen
startDateTimeBeginn des Zeitraums, für den der durchschnittliche Anmeldedauertrend abgefragt wird. Dies muss eine UTC-Angabe sein.
endDateTimeEnde des Zeitraums, für den der Anmeldedauertrend abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLengthintIntervall zwischen Datenpunkten in Minuten für den Trend.

Zurückgegebene Elemente

Ein IQueryable von TrendItem-Objekten. TrendItem enthält ein UTC-Datum (DateTime) und einen Wert zur Darstellung des Trends durchschnittlicher Anmeldezahlen in dem festgelegten Zeitraum.

Beispiel

Ruft Daten für einen Zeitraum von einer Stunde ab mit einem Datenpunkt pro Minute, der die Gesamtzahl der Anmeldungen für diese Minute darstellt. Gab es während der betreffenden Minute keine Anmeldungen , ist der Wert im TrendItem "Null".

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnCountTrend?startDate=datetime'2012-06-05T12:24:00'&endDate=datetime'2012-06-05T13:24:00'&intervalLength=1

GetLogOnCountTrendFiltered

Ruft den Trend der Anmeldezahlen für den angegebenen Zeitraum ab. Jeder Datenpunkt im Trend repräsentiert die Gesamtzahl der Anmeldungen im letzten Intervall (intervalLength-Parameter). Abgedeckt werden nur erfolgreiche Anmeldungen (d. h. die einen LogOnStartDate- und einen LogOnEndDate-Eintrag in der Datenbank haben).

ParameternameTypAnmerkungen
startDateDateTimeBeginn des Zeitraums, für den der Trend der Anmeldeanzahl abgefragt wird. Dies muss eine UTC-Angabe sein.
endDateDateTimeEnde des Zeitraums, für den der Trend der Anmeldeanzahl abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLengthintIntervall zwischen Datenpunkten in Minuten für den Trend.
desktopGroupsFilterstringDurch Trennzeichen getrennte Liste der Desktopgruppen-UIDs, auf die das Ergebnis beschränkt wird.

Zurückgegebene Elemente

Eine Liste mit TrendItems:

EigenschaftTypAnmerkungen
LogonCountTrendListDas LogonDurationTrendItem enthält ein UTC-Datum (DateTime) und eine Zahl (int) für die Anzahl der Anmeldungen zu dem festgelegten Datum.

Beispiel

Ruft einen 24-Stunden-Trend (Datenpunkt alle 15 Minuten) der Anmeldeanzahlen (in Millisekunden) für die beiden festgelegten Bereitstellungsgruppen ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnCountTrendFiltered?start=datetime'2011-09-30T00:00:00'&end=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

Ruft einen Wochentrend (Datenpunkt alle 4 Stunden) des Trends der Anmeldedauer (in Millisekunden) ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnCountTrendFiltered?start=datetime'2011-09-23T00:00:00'&end=datetime'2011-10-01T00:00:00'intervalLength=240

GetLogOnDurationAverageTrend

Ruft den Trend der durchschnittlichen Anmeldedauer für den angegebenen Zeitraum ab, wobei die Durchschnittswerte nach Intervall gruppiert werden. Jeder Datenpunkt liefert die durchschnittliche Anmeldedauer und eine Aufschlüsselung nach Intervall gemäß groupByInterval.

Parametername Typ Anmerkungen
start DateTime Beginn des Zeitraums, für den der durchschnittliche Anmeldedauertrend abgefragt wird. Dies muss eine UTC-Angabe sein.
end DateTime Ende des Zeitraums, für den der Anmeldedauertrend abgefragt wird. Dies muss eine UTC-Angabe sein.
groupByInterval int Art des für die Aufschlüsselung verwendeten Intervalls. Optionen: TimeOfDay=1, DayOfWeek=2, Month=3, Year=4. Pflichteingabe.
desktopGroupsFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die das Ergebnis beschränkt wird.

Zurückgegebene Elemente

Eine Liste von GroupedLogOnDurationTrendItem

Eigenschaft Typ Anmerkungen
GroupByDate int Repräsentiert die Aufschlüsselung (4 = 04:00 Uhr, 2007 = Jahr 2007, abhängig von der Eingabe für groupByInterval).

Zahl zurückgegebener Datenpunkte:

GroupByInterval=TimeOfDay (1): 24 Punkte (0-23)

0 = 00:00 Uhr, 1 = 01:00 Uhr, 2 = 02:00 Uhr... 23 = 23:00 Uhr

GroupByInterval=DayOfWeek (2): 7 Punkte (0-6)

0 = Sonntag, 1 = Montag... 6 = Samstag

GroupByInterval=Month (3): 12 Punkte (0-11)

0 = Januar, 1 = Februar... 11 = Dezember

GroupByInterval=Year (4): je nach Anzahl der Jahre innerhalb des startDate/endDate-Bereichs.

Reihenfolge der Punkte: Die Daten werden immer geordnet nach GroupByDate zurückgegeben, unabhängig vom an die API übergebenem Start- und Enddatum.

Value Nullable

Durchschnittliche Gesamt-Anmeldedauer in Millisekunden und durchschnittliche Dauer der einzelnen Schritte für die Gruppe.

Breakdown Collection

Sammlung von LogOnStepItem-Objekten, die Folgendes enthalten:

Duration (Nullable), d. h. die durchschnittliche Dauer des Schritts in Millisekunden, und LogOnStep (int), d. h. der ganzzahlige Enumerationswert des Anmeldeschritts (bezieht sich auf die LogOnStep-Enumeration).

Beispiel

Ruft einen 7-Tage-Durchschnitt nach Tageszeit (Stunde) des Anmeldedauertrends (in Millisekunden) für die beiden festgelegten Bereitstellungsgruppen ab. Damit wird ein TrendItem für jede Stunde des Tages mit der durchschnittlichen Anmeldedauer für diese Stunde für den festgelegten Zeitraum (24 Datenpunkte) zurückgegeben.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetDurationAverageTrend?start=datetime'2011-09-23T00:00:00'&end=datetime'2011-10-01T00:00:00'groupByInterval=1&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

GetLogOnDurationDetailsTrend

Ruft den Trend der Anmeldedauer für den angegebenen Zeitraum ab. Jeder Datenpunkt liefert die Gesamtdauer der Anmeldung und eine Aufschlüsselung für jeden Schritt.

ParameternameTypAnmerkungen
startDateDateTimeBeginn des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
endDateDateTimeEnde des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLengthintIntervall zwischen Datenpunkten in Minuten für den Trend.
desktopGroupsFilterstringDurch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die das Ergebnis beschränkt wird.

Zurückgegebene Elemente

Eine Liste mit LogonDurationTrendItems:

EigenschaftTypAnmerkungen
LogonDurationTrendListLogOnDurationTrendItem enthält ein UTC-Datum (DateTime) und ein Double für die durchschnittliche Anmeldedauer in Millisekunden während des Zeitraums. Außerdem enthält es eine Aufschlüsselung der Dauer der einzelnen Anmeldeschritte für jeden Datenpunkt.

Beispiel

Ruft einen 24-Stunden-Trend (Datenpunkt alle 15 Minuten) der Anmeldedauer (in Millisekunden) für die beiden festgelegten Bereitstellungsgruppen ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationDetailsTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

Ruft einen Wochentrend (Datenpunkt alle 4 Stunden) des Trends der Anmeldedauer (in Millisekunden) ab:

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationDetailsTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240

GetLogOnDurationTrend

Ruft den Trend der Anmeldedauer (Durchschnitt) für den angegebenen Zeitraum ab.

ParameternameTypAnmerkungen
startDateTimeBeginn des Zeitraums, für den der durchschnittliche Anmeldedauertrend abgefragt wird. Dies muss eine UTC-Angabe sein.
endDateTimeEnde des Zeitraums, für den der durchschnittliche Anmeldedauertrend abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLengthintIntervall zwischen Datenpunkten in Minuten für den Trend.

Zurückgegebene Elemente

Ein IQueryable von TrendItem-Objekten. TrendItem enthält ein UTC-Datum (DateTime) und einen Wert (in Millisekunden), der den Trend der durchschnittlichen Anmeldedauer im angegebenen Zeitraum darstellt.

Beispiele

Ruft Daten für einen Zeitraum von einer Stunde ab mit einem Datenpunkt pro Minute, der die durchschnittliche Anmeldedauer für die Minute darstellt. Gab es während der betreffenden Minute keine Anmeldungen , ist der Wert im TrendItem "NaN" (keine Zahl).

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationTrend?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:24:00'&intervalLength=1

Ruft einen einzelnen Datenpunkt ab, der die durchschnittliche Anmeldedauer für die Stunde darstellt.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationTrend?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:23:00'&intervalLength=60

GetMachineFailureTrend

Ruft den Trend der Anzahl gleichzeitiger Maschinenfehler für den angegebenen Zeitraum ab. Jeder Datenpunkt repräsentiert die maximale Anzahl der Maschinen mit einem Fehler zu einem beliebigen Zeitpunkt im letzten Intervall (intervalLength-Parameter). Die Abfrage kann auf einen bestimmten Maschinenfehlertyp beschränkt oder es können alle Fehler abgefragt werden.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den der Trend der Verbindungsfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.
desktopGroupsFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die das Ergebnis beschränkt wird.
machineFailureTypeFilter string Durch Trennzeichen getrennte Liste der ganzen Zahlen für Verbindungsfehlertypen, auf die das Ergebnis beschränkt wird. Diese ganze Zahl entspricht der MachineFaultStateCode-Enumeration. Wird dies nicht angegeben, werden alle Typen im Trend aggregiert zurückgegeben.
sessionSupportFilter int Durch Trennzeichen getrennte Liste der Maschinentypen (ganze Zahl, Einzel = 1, Multi = 2, Unbekannt = 0), auf die das Ergebnis beschränkt wird. Erfolgt keine Angabe, werden alle Typen zurückgegeben.

Zurückgegebene Elemente

Eine Liste von TrendItem-Objekten (FailureTrend).

Eigenschaft Typ Anmerkungen
FailureTrend List TrendItem enthält ein UTC-Datum (DateTime) und eine Anzahl (int) von Fehlern, die den Trend der Maschinenfehler im angegebenen Zeitraum gemäß der festgelegten Filter darstellen.

Beispiel

Ruft einen 24-Stunden-Trend (Datenpunkt alle 15 Minuten) aller Typen von Maschinenfehlern mit Desktopbetriebssystemmaschinen für die beiden angegebenen Bereitstellungsgruppen ab.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&sessionSupportFilter='1'&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

Ruft einen 24-Stunden-Trend (Datenpunkt alle 2 Stunden) der Maschinenfehler des Typs "Konnte nicht gestartet werden" und "Beim Starten hängen geblieben" für alle Bereitstellungsgruppen und alle Sitzungstypen ab.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240&machineFailureTypeFilter='2,3'

GetMachineFailureTrendsByType

Ruft eine Liste der Maschinenfehler- und Erfolgsquoten nach Typ mit einem Trend für jeden Typ für den angegebenen Zeitraum ab. Jeder Datenpunkt repräsentiert die Gesamtanzahl der Maschinen in einem Fehlerstatus im letzten Intervall (intervalLength-Parameter). Die Abfrage kann auf einen bestimmten Fehlertyp beschränkt oder es können alle Fehler abgefragt werden.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den der Trend der Maschinenfehler abgefragt wird. Dies muss eine UTC-Angabe sein. Nicht erforderlich, wenn keine Trends abgerufen werden.
endDate DateTime Ende des Zeitraums, für den der Trend der Maschinenfehler abgefragt wird. Dies muss eine UTC-Angabe sein.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.
machineFailureType int (MachineFailureType) Sofern festgelegt (>0), werden nur Maschinenfehler dieses Typs zurückgegeben. Andernfalls (0) werden alle Fehlertypen zurückgegeben. Diese ganze Zahl entspricht der MachineFailureType-Enumeration.
sessionSupport int (SessionSupport) Nullable int. Sofern nicht angegeben, werden alle sessionSupport-Typen zurückgegeben. Einzel = 1, Multi = 2, Unbekannt = 0

Zurückgegebene Elemente

Ein IQueryable von MachineFailureTrend-Objekten, die für jeden MachineFailureTrend Folgendes enthalten.

Wenn alle Typen abgefragt werden, wird auch die Summe mit MachineFailureTrend = -1 zurückgegeben.

Enthält die Abfrage "$expand = FailureTrend", werden für jeden Fehlertyp die Eigenschaften "Trend" und "TotalFailureCount" abgerufen.

Enthält die Abfrage "$expand=DesktopGroupBreakdown", wird auch diese Eigenschaft abgerufen.

Eigenschaft Typ Anmerkungen
MachineFailureType int [MachineFailureType] Der Typ des Verbindungsfehlers (siehe Bestimmen der Enumerationswerte).
TotalFailureCount int Die Gesamtzahl der Fehler zum endDate-Datum.
FailureTrend List TrendItem enthält ein UTC-Datum (DateTime) und ein Count (double), das den Trend der Maschinenfehler des angegebenen Typs über den angegebenen Zeitraum darstellen.
DesktopGroupBreakdown List DesktopGroupBreakdown enthält ein DesktopGroup-Objekt und ein Count (int), das die Gesamtzahl der Maschinen in einem Fehlerzustand zum endDate-Datum darstellt.

Beispiele

Ruft unter Aufschlüsselung nach Bereitstellungsgruppe den Trend aller Maschinenfehlertypen für den Zeitraum vom 14. November 05:00 Uhr (UTC) bis zum 14. November 07:00 Uhr (UTC) mit einem Datenpunkt alle 30 Minuten für alle Serverbetriebssystemmaschinen (d. h. sessionSupport = 2) ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&intervalLength=30&machineFailureType=0&sessionSupport=2&$expand=FailureTrend,DesktopGroupBreakdown

Ruft unter Aufschlüsselung nach Bereitstellungsgruppe den Trend des Maschinenfehlertyps 3 (beim Starten hängen geblieben) für den Zeitraum vom 14. November 05:00 Uhr (UTC) bis zum 14. November 07:00 Uhr (UTC) für Desktopbetriebssystemmaschinen ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&machineFailureType=3&sessionSupport=1&$expand=FailureTrend

Ruft den Trend aller Fehlertypen für alle Maschinensitzungen für den Zeitraum vom 14. November 00:00 Uhr (UTC) bis zum 14. November 23:00 Uhr (UTC) mit einem Datenpunkt alle 60 Minuten ab:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T00:00:00'&endDate=datetime'2011-11-14T23:00:00'&intervalLength=60&machineFailureType=0&$expand=FailureTrend

GetSessionCountTrend

Ruft Datenpunkte für den angegebenen Zeitraum ab zur Darstellung eines Trends der gleichzeitigen (verbundenen) Sitzungen in Form einer Liste von DateTime/Wert-Paaren. Jeder Punkt stellt die maximale Anzahl gleichzeitig verbundener Sitzungen während des angegebenen Intervalls dar. Dieser Wert wird als Summe von DesktopGroups und MAX der Summe berechnet.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den die gleichzeitigen Sitzungen abgefragt werden. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den die gleichzeitigen Sitzungen abgefragt werden. Dies muss eine UTC-Angabe sein.
intervalLength int Intervall zwischen Datenpunkten in Minuten für den Trend.
sessionSupportFilter string Durch Trennzeichen getrennte Liste der Maschinentypen (ganze Zahl, Einzel = 1, Multi = 2, Unbekannt = 0), auf die die Abfrage beschränkt wird. Erfolgt keine Angabe, werden alle Typen zurückgegeben.
connectionStateFilter string Liste durch Trennzeichen getrennter Verbindungsstatus (ganze Zahl, (1 = verbunden, 2 = getrennt), auf die die Abfrage beschränkt wird. Erfolgt keine Angabe, werden beide zurückgegeben.
desktopGroupFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die die Abfrage beschränkt wird. Erfolgt keine Angabe, werden alle Bereitstellungsgruppen zurückgegeben.

Zurückgegebene Elemente

IQueryable-Liste von TrendItem-Objekten – IQueryable, aufsteigend nach Datum sortiert.

Jedes TrendItem-Objekt enthält eine UTC-Datumseigenschaft (DateTime) und eine Werteigenschaft (int) zum Zeichnen des Trends.

Beispiel

Ruft einen 24-Stunden-Trend mit Datenpunkten für jede Stunde für gleichzeitig verbundene Sitzungen ab. Jeder Datenpunkt repräsentiert die maximale Anzahl von gleichzeitigen (nur verbundenen) Sitzungen im letzten Intervall (in diesem Fall 60 Minuten).

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='1'

Ruft einen 24-Stunden-Trend mit Datenpunkten für jede Stunde für gleichzeitig getrennte Sitzungen ab. Jeder Datenpunkt repräsentiert die maximale Anzahl von gleichzeitigen (nur getrennten) Sitzungen im letzten Intervall (in diesem Fall 60 Minuten).

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='2'

Ruft den Trend der vergangenen Woche ab, mit Datenpunkten alle 6 Stunden für gleichzeitige Sitzungen (verbunden und getrennt) für beide Maschinentypen (Desktopbetriebssystem- und Serverbetriebssystemmaschinen). Jeder Datenpunkt repräsentiert die maximale Anzahl von gleichzeitigen Sitzungen im letzten Intervall (in diesem Fall 6 Stunden).

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=360

GetSessionSummary

Ruft Datenpunkte für den angegebenen Zeitraum ab zur Darstellung eines Trends der gleichzeitigen (verbundenen) Sitzungen in Form einer Liste von DateTime/Wert-Paaren. Jeder Punkt stellt die maximale Anzahl gleichzeitig verbundener Sitzungen während des angegebenen Intervalls dar.

Parametername Typ Anmerkungen
startDate DateTime Beginn des Zeitraums, für den die gleichzeitigen Sitzungen abgefragt werden. Dies muss eine UTC-Angabe sein.
endDate DateTime Ende des Zeitraums, für den die gleichzeitigen Sitzungen abgefragt werden. Dies muss eine UTC-Angabe sein.
sessionSupportFilter string Durch Trennzeichen getrennte Liste der Maschinentypen (ganze Zahl, Einzel = 1, Multi = 2, Unbekannt = 0), auf die die Abfrage beschränkt wird. Standardmäßig werden alle Typen zurückgegeben, wenn kein Filter festgelegt wird.
desktopGroupFilter string Durch Trennzeichen getrennte Liste der Bereitstellungsgruppen-UIDs, auf die die Abfrage beschränkt wird. Wenn kein Wert angegeben wird, werden alle Bereitstellungsgruppen zurückgegeben.
connectionStateFilter string Liste durch Trennzeichen getrennter Verbindungsstatus (ganze Zahl, (1 = verbunden, 2 = getrennt), auf die die Abfrage beschränkt wird. Erfolgt keine Angabe, werden beide zurückgegeben.

Zurückgegebene Elemente

IQueryable-Liste von SessionSummary-Objekten – IQueryable.

Jedes SessionSummary-Objekt enthält Folgendes:

  • DesktopGroup (name und Uid)
  • AverageSessionCount (double)
  • Durchschnittliche Anzahl gleichzeitiger Sitzungen im angegebenen Zeitraum. Dies ist der Durchschnitt der Spitzenwerte in dem Zeitraum mit der für den Zeitraum möglichen Granularität.
  • AverageUserCount (double)
  • Durchschnittliche Anzahl der verbundenen Benutzer im angegebenen Zeitraum
  • PeakUserCount (int)
  • Spitzenwert der Anzahl der zu einem beliebigen Zeitpunkt im angegebenen Zeitraum verbundenen Benutzer
  • UniqueUserCount (int)
  • Die Gesamtzahl der eindeutigen Benutzer im angegebenen Zeitraum.
  • AverageHoursPerDay (double)
  • Durchschnittliche Sitzungsdauer (Stunden pro Benutzer pro Tag)
  • DesktopGroup (name und Uid)

Beispiel

Ruft eine Liste der SessionSummary-Objekte innerhalb von 24 Stunden für alle Sitzungen ab.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionSummary?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'

Ruft eine Liste der SessionSummary-Objekte innerhalb von 24 Stunden für Serverbetriebssystemmaschinen ab.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionSummary?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&sessionSupportFilter='2'