Rapportens nodhälsa

Artikel
08/05/2023

Skickar en hälsorapport på Service Fabric-noden.

Rapporterar hälsotillståndet för den angivna Service Fabric-noden. Rapporten måste innehålla information om källan till hälsorapporten och egenskapen som den rapporteras för. Rapporten skickas till en Service Fabric-gatewaynod som vidarebefordras till hälsoarkivet. Rapporten kan godkännas av gatewayen, men avvisas av hälsoarkivet efter extra validering. Hälsoarkivet kan till exempel avvisa rapporten på grund av en ogiltig parameter, till exempel ett inaktuellt sekvensnummer. Om du vill se om rapporten har tillämpats i hälsoarkivet kör du GetNodeHealth och kontrollerar att rapporten visas i avsnittet HealthEvents.

Förfrågan

Metod	URI för förfrågan
POST	`/Nodes/{nodeName}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout}`

Parametrar

Namn	Typ	Obligatorisk	Location
`nodeName`	sträng	Ja	Sökväg
`api-version`	sträng	Ja	Söka i data
`Immediate`	boolean	No	Söka i data
`timeout`	heltal (int64)	No	Söka i data
`HealthInformation`	Hälsoinformation	Yes	Brödtext

`nodeName`

Typ: sträng
Krävs: Ja

Namnet på noden.

`api-version`

Typ: sträng
Krävs: Ja
Standard: 6.0

Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.0".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som dokumenteras i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds upp till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, accepterar körningen version 6.1 för det API:et för att göra det enklare att skriva klienterna. Beteendet för API:et är dock enligt den dokumenterade 6.0-versionen.

`Immediate`

Typ: booleskt värde
Krävs: Nej
Standard: false

En flagga som anger om rapporten ska skickas omedelbart. En hälsorapport skickas till ett Service Fabric-gatewayprogram som vidarebefordras till hälsoarkivet. Om Immediate är inställt på true skickas rapporten omedelbart från HTTP Gateway till hälsoarkivet, oavsett vilka klientinställningar för infrastrukturresurser som ANVÄNDS av HTTP-gatewayprogrammet. Detta är användbart för kritiska rapporter som ska skickas så snart som möjligt. Beroende på tidsinställningar och andra villkor kan sändningen av rapporten fortfarande misslyckas, till exempel om HTTP-gatewayen är stängd eller om meddelandet inte når gatewayen. Om Immediate är inställt på false skickas rapporten baserat på hälsoklientinställningarna från HTTP-gatewayen. Därför batchas den enligt konfigurationen HealthReportSendInterval. Det här är den rekommenderade inställningen eftersom den gör det möjligt för hälsoklienten att optimera hälsorapporteringsmeddelanden till hälsoarkivet samt bearbetning av hälsorapporter. Som standard skickas inte rapporter omedelbart.

`timeout`

Typ: heltal (int64)
Krävs: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns tidsgräns för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

`HealthInformation`

Typ: Hälsoinformation
Krävs: Ja

Beskriver hälsoinformationen för hälsorapporten. Den här informationen måste finnas i alla hälsorapporter som skickas till hälsohanteraren.

Svar

HTTP-statuskod	Description	Svarsschema
200 (OK)	En lyckad åtgärd returnerar 200 statuskod.
Alla andra statuskoder	Det detaljerade felsvaret.	FabricError

Dela via