Abrufen der Clusterintegrität

  • Artikel

Ruft die Integrität eines Service Fabric-Clusters ab.

Verwenden Sie „EventsHealthStateFilter“, um die Sammlung der Integritätsereignisse (HealthEvents), die für den Cluster gemeldet wurden, anhand des Integritätsstatus zu filtern. In ähnlicher Weise können Sie „NodesHealthStateFilter“ und „ApplicationsHealthStateFilter“ verwenden, um die Auflistung der zurückgegebenen Knoten und Anwendungen anhand ihres aggregierten Integritätsstatus zu filtern.

Anforderung

Methode Anforderungs-URI
GET /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout}

Parameter

Name type Erforderlich Standort
api-version Zeichenfolge Ja Abfrage
NodesHealthStateFilter integer Nein Abfrage
ApplicationsHealthStateFilter integer Nein Abfrage
EventsHealthStateFilter integer Nein Abfrage
ExcludeHealthStatistics boolean Nein Abfrage
IncludeSystemApplicationHealthStatistics boolean Nein Abfrage
timeout ganze Zahl (int64) Nein Abfrage

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.0" sein.

Die Rest-API-Version von Service Fabric basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Die Service Fabric-Runtime unterstützt mehrere Versionen der API. Dies ist die neueste unterstützte Version der API. Wenn eine niedrigere API-Version übergeben wird, unterscheidet sich die zurückgegebene Antwort möglicherweise von der in dieser Spezifikation dokumentierten.

Darüber hinaus akzeptiert die Runtime jede Version, die höher als die neueste unterstützte Version bis zur aktuellen Version der Runtime ist. Wenn also die neueste API-Version 6.0 ist, aber die Runtime 6.1 ist, akzeptiert die Runtime version 6.1 für diese API, um das Schreiben der Clients zu vereinfachen. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

NodesHealthStateFilter

Typ: integer
Erforderlich: Nein
Standard:

Ermöglicht es, die Knotenintegritäts-Zustandsobjekte, die im Ergebnis einer Dienstintegritätsabfrage zurückgegeben werden, anhand des Integritätszustands zu filtern. Die möglichen Werte für diesen Parameter entsprechen dem jeweiligen ganzzahligen Wert von einem der folgenden Integritätsstatus. Es werden nur Knoten zurückgegeben, die dem Filter entsprechen. Alle Knoten werden verwendet, um den aggregierten Integritätsstatus auszuwerten. Ist kein Filter angegeben, werden alle Einträge zurückgegeben. Ein Statuswert ist eine kennzeichenbasierte Enumeration, sodass der Wert eine Kombination der Werte sein kann, die mit dem bitweisen ODER-Operator abgerufen werden. Ist der angegebene Wert beispielsweise „6“, wird der Integritätszustand von Knoten zurückgegeben, für die „HealthState“ den Wert „OK (2)“ oder „Warning (4)“ aufweist.

  • Standard: Standardwert. Stimmt mit jedem Integritätsstatus (HealthState) überein. Der Wert ist gleich null.
  • None: Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine angegebene Statussammlung zurückzugeben. Der Wert ist "1".
  • Ok: Filter, der der Eingabe mit dem HealthState-Wert Ok entspricht. Der Wert ist "2".
  • Warnung: Filter, der eingaben mit dem HealthState-Wert Warning übereinstimmt. Der Wert ist "4".
  • Fehler: Filter, der die Eingabe mit dem HealthState-Wert Error übereinstimmt. Der Wert ist gleich „8“.
  • Alle: Filter, der eingaben mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist gleich „65535“.

ApplicationsHealthStateFilter

Typ: integer
Erforderlich: Nein
Standard:

Ermöglicht es, die Anwendungsintegritäts-Zustandsobjekte, die im Ergebnis einer Clusterintegritätsabfrage zurückgegeben werden, anhand des Integritätszustands zu filtern. Mögliche Werte für diesen Parameter sind ganzzahlige Werte, die von Membern oder über bitweise Operationen bei Membern der Enumeration „HealthStateFilter“ abgerufen werden können. Es werden nur Anwendungen zurückgegeben, die dem Filter entsprechen. Alle Anwendungen werden verwendet, um den aggregierten Integritätszustand auszuwerten. Ist kein Filter angegeben, werden alle Einträge zurückgegeben. Ein Statuswert ist eine kennzeichenbasierte Enumeration, sodass der Wert eine Kombination der Werte sein kann, die mit dem bitweisen ODER-Operator abgerufen werden. Ist der angegebene Wert beispielsweise gleich „6“, wird der Integritätszustand von Anwendungen zurückgegeben, für die „HealthState“ den Wert „OK (2)“ oder „Warning (4)“ aufweist.

  • Standard: Standardwert. Stimmt mit jedem Integritätsstatus (HealthState) überein. Der Wert ist gleich null.
  • None: Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine angegebene Statussammlung zurückzugeben. Der Wert ist "1".
  • Ok: Filter, der der Eingabe mit dem HealthState-Wert Ok entspricht. Der Wert ist "2".
  • Warnung: Filter, der eingaben mit dem HealthState-Wert Warning übereinstimmt. Der Wert ist "4".
  • Fehler: Filter, der die Eingabe mit dem HealthState-Wert Error übereinstimmt. Der Wert ist gleich „8“.
  • Alle: Filter, der eingaben mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist gleich „65535“.

EventsHealthStateFilter

Typ: integer
Erforderlich: Nein
Standard:

Ermöglicht das Filtern der Collection zurückgegebener HealthEvent-Objekte anhand des Integritätsstatus. Die möglichen Werte für diesen Parameter entsprechen dem jeweiligen ganzzahligen Wert von einem der folgenden Integritätsstatus. Es werden nur Ereignisse zurückgegeben, die dem Filter entsprechen. Alle Ereignisse werden verwendet, um den aggregierten Integritätsstatus auszuwerten. Ist kein Filter angegeben, werden alle Einträge zurückgegeben. Ein Statuswert ist eine flagbasierte Enumeration, sodass der Wert eine Kombination der Werte sein kann, die mit dem bitweisen OR-Operator abgerufen werden. Ist der angegebene Wert beispielsweise gleich „6“, werden alle Ereignisse zurückgegeben, für die „HealthState“ den Wert für OK (2) oder Warnung (4) hat.

  • Standard: Standardwert. Stimmt mit jedem Integritätsstatus (HealthState) überein. Der Wert ist gleich null.
  • None: Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine angegebene Statussammlung zurückzugeben. Der Wert ist "1".
  • Ok: Filter, der der Eingabe mit dem HealthState-Wert Ok entspricht. Der Wert ist "2".
  • Warnung: Filter, der eingaben mit dem HealthState-Wert Warning übereinstimmt. Der Wert ist "4".
  • Fehler: Filter, der die Eingabe mit dem HealthState-Wert Error übereinstimmt. Der Wert ist gleich „8“.
  • Alle: Filter, der eingaben mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist gleich „65535“.

ExcludeHealthStatistics

Typ: boolean
Erforderlich: Nein
Standard:

Gibt an, ob die Integritätsstatistiken als Bestandteil des Abfrageergebnisses zurückgegeben werden sollen. Der Standardwert ist gleich „False“. Die Statistiken zeigen die Anzahl von untergeordneten Entitäten, die einen der Integritätszustände „Ok“, „Warning“ oder „Error“ aufweisen.

IncludeSystemApplicationHealthStatistics

Typ: boolean
Erforderlich: Nein
Standard:

Gibt an, ob die Integritätsstatistiken in die Anwendungsintegritätsstatistik von fabric:/System einbezogen werden sollen. Der Standardwert ist gleich „False“. Ist „IncludeSystemApplicationHealthStatistics“ auf „true“ festgelegt, enthalten die Integritätsstatistiken die Entitäten, die zur Systemanwendung von Fabric gehören. Andernfalls enthält das Abfrageergebnis nur Integritätsstatistiken für Benutzeranwendungen. Die Integritätsstatistiken müssen für den anzuwendenden Parameter in das Abfrageergebnis einbezogen werden.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InklusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Bei einem erfolgreichen Vorgang werden 200 status Code und die angeforderten Clusterintegritätsinformationen zurückgegeben.
 ClusterHealth
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError