Abrufen des Clusterintegritätsblocks mithilfe von Richtlinien und erweiterten Filtern

Artikel
08/05/2023

Ruft die Integrität eines Service Fabric-Clusters mithilfe von Integritätsblöcken ab.

Ruft die Integrität eines Service Fabric-Clusters mithilfe von Integritätsblöcken ab. Die Integritätsauswertung erfolgt basierend auf der Beschreibung der Integritätsblockabfrage des Eingabeclusters. Mit der Abfragebeschreibung können Benutzer Integritätsrichtlinien für die Auswertung des Clusters und seiner untergeordneten Elemente angeben. Benutzer können sehr flexible Filter angeben, um auszuwählen, welche Clusterentitäten zurückgegeben werden sollen. Die Auswahl kann basierend auf dem Integritätszustand der Entitäten und basierend auf der Hierarchie erfolgen. Die Abfrage kann basierend auf den angegebenen Filtern untergeordnete Elemente der Entitäten mit mehreren Ebenen zurückgeben. Beispielsweise kann eine Anwendung mit einem angegebenen Namen zurückgegeben werden, und für diese Anwendung werden nur Dienste zurückgegeben, die sich in Fehler oder Warnung befinden, sowie alle Partitionen und Replikate für einen dieser Dienste.

Anforderung

Methode	Anforderungs-URI
POST	`/$/GetClusterHealthChunk?api-version=6.0&timeout={timeout}`

Parameter

Name	type	Erforderlich	Standort
`api-version`	Zeichenfolge	Ja	Abfrage
`timeout`	ganze Zahl (int64)	Nein	Abfrage
`ClusterHealthChunkQueryDescription`	ClusterHealthChunkQueryDescription	Nein	Text

`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.

`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.

`ClusterHealthChunkQueryDescription`

Typ: ClusterHealthChunkQueryDescription
Erforderlich: Nein

Beschreibt die Cluster- und Anwendungsintegritätsrichtlinien, die zum Auswerten der Clusterintegrität verwendet werden, und die Filter, um auszuwählen, welche Clusterentitäten zurückgegeben werden sollen. Wenn die Clusterintegritätsrichtlinie vorhanden ist, wird sie verwendet, um die Clusterereignisse und die Clusterknoten auszuwerten. Falls nicht vorhanden, verwendet die Integritätsauswertung die im Clustermanifest definierte Clusterintegritätsrichtlinie oder die Standardintegritätsrichtlinie des Clusters. Standardmäßig wird jede Anwendung mit ihrer spezifischen Anwendungsintegritätsrichtlinie ausgewertet, die im Anwendungsmanifest definiert ist, oder der Standardintegritätsrichtlinie, wenn keine Richtlinie im Manifest definiert ist. Wenn die Anwendungsintegritätsrichtlinienzuordnung angegeben ist und über einen Eintrag für eine Anwendung verfügt, wird die angegebene Anwendungsintegritätsrichtlinie verwendet, um die Anwendungsintegrität auszuwerten. Benutzer können sehr flexible Filter angeben, um auszuwählen, welche Clusterentitäten als Antwort einbezogen werden sollen. Die Auswahl kann basierend auf dem Integritätszustand der Entitäten und basierend auf der Hierarchie erfolgen. Die Abfrage kann basierend auf den angegebenen Filtern untergeordnete Elemente der Entitäten mit mehreren Ebenen zurückgeben. Beispielsweise kann eine Anwendung mit einem angegebenen Namen zurückgegeben werden, und für diese Anwendung werden nur Dienste zurückgegeben, die sich in Fehler oder Warnung befinden, sowie alle Partitionen und Replikate für einen dieser Dienste.

Antworten

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

Freigeben über