Abrufen der Dienstintegrität

Artikel
07/19/2023

Ruft die Integrität des angegebenen Service Fabric-Diensts ab.

Ruft die Integritätsinformationen des angegebenen Diensts ab. Verwenden Sie „EventsHealthStateFilter“, um die Sammlung der Integritätsereignisse (HealthEvents), die für den Dienst gemeldet wurden, anhand des Integritätsstatus zu filtern. Verwenden Sie „PartitionsHealthStateFilter“, um die zurückgegebene Sammlung von Partitionen zu filtern. Geben Sie einen Dienst an, der nicht im Integritätsspeicher vorhanden ist, gibt diese Anforderung einen Fehler zurück.

Anforderung

Methode	Anforderungs-URI
GET	`/Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

Parameter

Name	type	Erforderlich	Standort
`serviceId`	Zeichenfolge	Ja	Pfad
`api-version`	Zeichenfolge	Ja	Abfrage
`EventsHealthStateFilter`	integer	Nein	Abfrage
`PartitionsHealthStateFilter`	integer	Nein	Abfrage
`ExcludeHealthStatistics`	boolean	Nein	Abfrage
`timeout`	ganze Zahl (int64)	Nein	Abfrage

`serviceId`

Typ: Zeichenfolge
Erforderlich: Ja

Die Identität (ID) des Diensts. Diese ID ist üblicherweise der vollständige Name des Diensts ohne das URI-Schema „fabric“. Ab Version 6.0 wird für hierarchische Namen das Zeichen „~“ als Trennzeichen verwendet. Wenn der Dienstname beispielsweise „fabric:/myapp/app1/svc1“ lautet, würde die Dienstidentität ab 6.0 „myapp~app1~svc1“ und in früheren Versionen „myapp/app1/svc1“ lauten.

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

`PartitionsHealthStateFilter`

Typ: integer
Erforderlich: Nein
Standard:

Ermöglicht es, die Partitions-Integritätszustandsobjekte, 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 Partitionen zurückgegeben, die dem Filter entsprechen. Alle Partitionen werden verwendet, um den aggregierten Integritätszustand 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“, wird der Integritätszustand von Partitionen zurückgegeben, für die „HealthState“ den Wert „OK (2)“ oder „Warnung (4)“ aufweist.

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

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

Antworten

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

Freigeben über