Rapporttjänsthälsa
Skickar en hälsorapport för Service Fabric-tjänsten.
Rapporterar hälsotillståndet för den angivna Service Fabric-tjänsten. 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-gatewaytjänst 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 GetServiceHealth och kontrollerar att rapporten visas i avsnittet HealthEvents.
Förfrågan
| Metod | URI för förfrågan |
|---|---|
| POST | /Services/{serviceId}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout} |
Parametrar
| Namn | Typ | Obligatorisk | Location |
|---|---|---|---|
serviceId |
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 |
serviceId
Typ: sträng
Obligatoriskt: Ja
Tjänstens identitet. Det här ID:t är vanligtvis det fullständiga namnet på tjänsten utan URI-schemat "fabric:".
Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~".
Om tjänstnamnet till exempel är "fabric:/myapp/app1/svc1" skulle tjänstidentiteten vara "myapp~app1~svc1" i 6.0+ och "myapp/app1/svc1" i tidigare versioner.
api-version
Typ: sträng
Obligatoriskt: 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 beskrivs i den här specifikationen.
Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, för att göra det enklare att skriva klienterna, accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.
Immediate
Typ: booleskt
Obligatoriskt: 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 HTTP Gateway-programmet använder.
Detta är användbart för kritiska rapporter som ska skickas så snart som möjligt.
Beroende på tid 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)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Serverns timeout 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: HealthInformation
Obligatoriskt: 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 statuskoden 200. |
|
| Alla andra statuskoder | Det detaljerade felsvaret. |
FabricError |