Integrität des Berichtsdiensts

Artikel
08/05/2023

Sendet einen Integritätsbericht zu dem Service Fabric-Dienst.

Meldet den Integritätszustand des angegebenen Service Fabric-Diensts. Der Bericht muss die Informationen über die Quelle des Integritätsberichts und die Eigenschaft enthalten, auf die sich der Bericht bezieht. Der Bericht wird an einen Service Fabric-Gatewaydienst gesendet, der diesen an den Integritätsspeicher weiterleitet. Der Bericht wird möglicherweise vom Gateway akzeptiert, aber nach zusätzlicher Überprüfung vom Integritätsspeicher abgelehnt. Beispielsweise kann der Integritätsspeicher den Bericht aufgrund eines ungültigen Parameters wie etwa einer veralteten Sequenznummer ablehnen. Um festzustellen, ob der Bericht im Integritätsspeicher angewendet wurde, führen Sie GetServiceHealth aus, und überprüfen Sie, ob der Bericht im Abschnitt HealthEvents angezeigt wird.

Anforderung

Methode	Anforderungs-URI
POST	`/Services/{serviceId}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout}`

Parameter

Name	type	Erforderlich	Standort
`serviceId`	Zeichenfolge	Ja	Pfad
`api-version`	Zeichenfolge	Ja	Abfrage
`Immediate`	boolean	Nein	Abfrage
`timeout`	ganze Zahl (int64)	Nein	Abfrage
`HealthInformation`	HealthInformation	Ja	Body

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

`Immediate`

Typ: boolean
Erforderlich: Nein
Standard:

Ein Flag, das angibt, ob der Bericht sofort gesendet werden soll. Ein Integritätsbericht wird an eine Service Fabric-Gatewayanwendung gesendet, die diesen an den Integritätsspeicher weiterleitet. Wenn „Immediate“ auf „true“ festgelegt ist, wird der Bericht sofort vom HTTP-Gateway an den Integritätsspeicher gesendet, unabhängig von den Fabric-Clienteinstellungen, die die HTTP-Gatewayanwendung verwendet. Dies ist für kritische Berichte hilfreich, die schnellstmöglich gesendet werden sollen. Abhängig von der zeitlichen Steuerung und anderen Bedingungen können beim Senden des Berichts trotzdem möglicherweise Fehler auftreten, z.B., wenn das HTTP-Gateway geschlossen ist oder die Meldung das Gateway nicht erreicht. Wenn „Immediate“ auf „false“ festgelegt ist, wird der Bericht basierend auf den Integritätsclienteinstellungen vom HTTP-Gateway gesendet. Aus diesem Grund wird der Bericht entsprechend der HealthReportSendInterval-Konfiguration batchweise verarbeitet. Dies ist die empfohlene Einstellung, da der Integritätsclient die Optimierung von Meldungen des Integritätsberichts für den Integritätsspeicher sowie die Verarbeitung von Integritätsberichten ermöglicht. Standardmäßig werden Berichte nicht sofort gesendet.

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

`HealthInformation`

Typ: HealthInformation
Erforderlich: Ja

Beschreibt die Integritätsinformationen für den Integritätsbericht. Diese Informationen müssen in allen Integritätsberichten vorhanden sein, die an den Integritätsmanager gesendet werden.

Antworten

HTTP-Statuscode	BESCHREIBUNG	Antwortschema
200 (OK)	Ein erfolgreicher Vorgang gibt 200 status Code zurück.
Alle anderen status Codes	Die detaillierte Fehlerantwort.	FabricError

Freigeben über