Toepassingsstatus rapporteren

Artikel
08/05/2023

Hiermee wordt een statusrapport over de Service Fabric-toepassing verzonden.

Rapporteert de status van de opgegeven Service Fabric-toepassing. Het rapport moet informatie bevatten over de bron van het statusrapport en de eigenschap waarop het is gerapporteerd. Het rapport wordt verzonden naar een Service Fabric-gatewaytoepassing, die wordt doorgestuurd naar het statusarchief. Het rapport kan worden geaccepteerd door de gateway, maar geweigerd door het statusarchief na extra validatie. Het statusarchief kan het rapport bijvoorbeeld weigeren vanwege een ongeldige parameter, zoals een verlopen volgnummer. Als u wilt zien of het rapport is toegepast in het statusarchief, haalt u de toepassingsstatus op en controleert u of het rapport wordt weergegeven in de sectie HealthEvents.

Aanvraag

Methode	Aanvraag-URI
POST	`/Applications/{applicationId}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout}`

Parameters

Naam	Type	Vereist	Locatie
`applicationId`	tekenreeks	Ja	Pad
`api-version`	tekenreeks	Ja	Query’s uitvoeren
`Immediate`	booleaans	No	Query’s uitvoeren
`timeout`	geheel getal (int64)	Nee	Query’s uitvoeren
`HealthInformation`	Statusinformatie	Ja	Hoofdtekst

`applicationId`

Type: tekenreeks
Vereist: Ja

De identiteit van de toepassing. Dit is doorgaans de volledige naam van de toepassing zonder het URI-schema 'fabric:'. Vanaf versie 6.0 worden hiërarchische namen gescheiden door het teken '~'. Als de toepassingsnaam bijvoorbeeld 'fabric:/myapp/app1' is, is de toepassingsidentiteit 'myapp~app1' in 6.0+ en 'myapp/app1' in eerdere versies.

`api-version`

Type: tekenreeks
Vereist: Ja
Standaardinstelling: 6.0

De versie van de API. Deze parameter is vereist en de waarde moet '6.0' zijn.

Service Fabric REST API-versie is gebaseerd op de runtimeversie waarin de API is geïntroduceerd of gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Dit is de nieuwste ondersteunde versie van de API. Als een lagere API-versie wordt doorgegeven, kan het geretourneerde antwoord afwijken van het antwoord dat in deze specificatie wordt beschreven.

Daarnaast accepteert de runtime elke versie die hoger is dan de meest recente ondersteunde versie tot de huidige versie van de runtime. Dus als de nieuwste API-versie 6.0 is, maar als de runtime 6.1 is, accepteert de runtime versie 6.1 voor die API om het eenvoudiger te maken om de clients te schrijven. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.

`Immediate`

Type: booleaanse waarde
Vereist: Nee
Standaardinstelling: false

Een vlag die aangeeft of het rapport onmiddellijk moet worden verzonden. Er wordt een statusrapport verzonden naar een Service Fabric-gatewaytoepassing, die wordt doorgestuurd naar het statusarchief. Als Direct is ingesteld op true, wordt het rapport onmiddellijk van http-gateway naar het statusarchief verzonden, ongeacht de instellingen van de infrastructuurclient die de HTTP-gatewaytoepassing gebruikt. Dit is handig voor kritieke rapporten die zo snel mogelijk moeten worden verzonden. Afhankelijk van de timing en andere omstandigheden kan het verzenden van het rapport nog steeds mislukken, bijvoorbeeld als de HTTP-gateway is gesloten of als het bericht de gateway niet bereikt. Als Direct is ingesteld op onwaar, wordt het rapport verzonden op basis van de statusclientinstellingen van de HTTP-gateway. Daarom wordt deze batchgewijs uitgevoerd volgens de healthreportSendInterval-configuratie. Dit is de aanbevolen instelling, omdat hiermee de statusclient statusrapportageberichten kan optimaliseren naar het statusarchief en de verwerking van statusrapporten. Standaard worden rapporten niet onmiddellijk verzonden.

`timeout`

Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiveMaximum: 4294967295
InclusiefMinimum: 1

De time-out van de server voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten totdat de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.

`HealthInformation`

Type: StatusInformatie
Vereist: Ja

Beschrijft de statusinformatie voor het statusrapport. Deze informatie moet aanwezig zijn in alle statusrapporten die naar de statusmanager worden verzonden.

Antwoorden

HTTP-statuscode	Beschrijving	Antwoordschema
200 (OK)	Een geslaagde bewerking retourneert de statuscode 200.
Alle andere statuscodes	Het gedetailleerde foutantwoord.	FabricError

Delen via