Freigeben über

Abrufen der Partitionsintegrität mithilfe der Richtlinie

  • Artikel

Ruft die Integrität der angegebenen Service Fabric-Partition mithilfe der angegebenen Integritätsrichtlinie ab.

Ruft die Integritätsinformationen der angegebenen Partition ab. Wenn die Anwendungsintegritätsrichtlinie angegeben ist, wird sie von der Integritätsauswertung verwendet, um den aggregierten Integritätsstatus abzurufen. Wenn die Richtlinie nicht angegeben ist, verwendet die Integritätsauswertung die im Anwendungsmanifest definierte Anwendungsintegritätsrichtlinie oder die Standardintegritätsrichtlinie, wenn im Manifest keine Richtlinie definiert ist. Verwenden Sie EventsHealthStateFilter, um die Auflistung von Integritätsereignissen zu filtern, die auf der Partition basierend auf dem Integritätsstatus gemeldet werden. Verwenden Sie „ReplicasHealthStateFilter“, um die Auflistung der ReplicaHealthState-Objekte für die Partition zu filtern. Verwenden Sie ApplicationHealthPolicy im POST-Text, um die Integritätsrichtlinien zu überschreiben, die zum Bewerten der Integrität verwendet werden. Geben Sie eine Partition an, die nicht im Integritätsspeicher vorhanden ist, gibt diese Anforderung einen Fehler zurück.

Anforderung

Methode Anforderungs-URI
POST /Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Parameter

Name type Erforderlich Standort
partitionId Zeichenfolge (uuid) Ja Pfad
api-version Zeichenfolge Ja Abfrage
EventsHealthStateFilter integer Nein Abfrage
ReplicasHealthStateFilter integer Nein Abfrage
ExcludeHealthStatistics boolean Nein Abfrage
timeout ganze Zahl (int64) Nein Abfrage
ApplicationHealthPolicy ApplicationHealthPolicy Nein Text

partitionId

Typ: string (uuid)
Erforderlich: Ja

Die Identität (ID) der Partition.

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

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

Die Service Fabric-REST-API-Version 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 erleichtern. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

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.

  • Standardwert: 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 die Eingabe mit dem HealthState-Wert Warning übereinstimmt. Der Wert ist "4".
  • Fehler: Filter, der die Eingabe mit dem HealthState-Wert Error abgleicht. Der Wert ist gleich „8“.
  • Alle: Filter, der eingaben mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist gleich „65535“.

ReplicasHealthStateFilter

Typ: integer
Erforderlich: Nein
Standard:

Ermöglicht das Filtern der Sammlung der ReplicaHealthState-Objekte für die Partition. Der Wert kann von Membern oder bitweisen Operationen für HealthStateFilter-Member abgerufen werden. Es werden nur Replikate zurückgegeben, die dem Filter entsprechen. Alle Replikate werden verwendet, um den aggregierten Integritätszustand auszuwerten. Ist kein Filter angegeben, werden alle Einträge zurückgegeben. Bei den Statuswerten handelt es sich um 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 „OK (2)“ oder „Warning (4)“ aufweist. Die möglichen Werte für diesen Parameter entsprechen dem jeweiligen ganzzahligen Wert von einem der folgenden Integritätsstatus.

  • Standardwert: 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 die Eingabe 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.

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.

ApplicationHealthPolicy

Typ: ApplicationHealthPolicy
Erforderlich: Nein

Beschreibt die Integritätsrichtlinien, die zum Bewerten der Integrität einer Anwendung oder einer ihrer untergeordneten Elemente verwendet werden. Falls nicht vorhanden, verwendet die Integritätsauswertung die Integritätsrichtlinie aus dem Anwendungsmanifest oder die Standardintegritätsrichtlinie.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Ein erfolgreicher Vorgang gibt 200 status Code und die Integritätsinformationen zur angegebenen Partition zurück.
 PartitionHealth
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError