Share via

Hämta node health

  • Artikel

Hämtar hälsotillståndet för en Service Fabric-nod.

Hämtar hälsotillståndet för en Service Fabric-nod. Använd EventsHealthStateFilter för att filtrera samlingen av hälsohändelser som rapporterats på noden baserat på hälsotillståndet. Om den nod som du anger med namnet inte finns i hälsoarkivet returneras ett fel.

Förfrågan

Metod URI för förfrågan
GET /Nodes/{nodeName}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Parametrar

Namn Typ Obligatorisk Location
nodeName sträng Ja Sökväg
api-version sträng Ja Söka i data
EventsHealthStateFilter heltal No Söka i data
timeout heltal (int64) No Söka i data

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.

EventsHealthStateFilter

Typ: heltal
Krävs: Nej
Standard: 0

Tillåter filtrering av samlingen med HealthEvent-objekt som returneras baserat på hälsotillståndet. Möjliga värden för den här parametern innehåller heltalsvärdet för något av följande hälsotillstånd. Endast händelser som matchar filtret returneras. Alla händelser används för att utvärdera det aggregerade hälsotillståndet. Om inget anges returneras alla poster. Tillståndsvärdena är flaggbaserad uppräkning, så värdet kan vara en kombination av dessa värden som hämtas med operatorn BITVIS "OR". Om det angivna värdet till exempel är 6 returneras alla händelser med HealthState-värdet OK (2) och Varning (4).

  • Standard – standardvärde. Matchar alla HealthState. Värdet är noll.
  • Ingen – Filter som inte matchar något HealthState-värde. Används för att inte returnera några resultat för en viss samling tillstånd. Värdet är 1.
  • Ok – Filter som matchar indata med HealthState-värdet OK. Värdet är 2.
  • Varning – Filter som matchar indata med HealthState-värdet Varning. Värdet är 4.
  • Fel – Filter som matchar indata med HealthState-värdet Fel. Värdet är 8.
  • Alla – Filter som matchar indata med valfritt HealthState-värde. Värdet är 65535.

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.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) En lyckad åtgärd returnerar 200 statuskod och den begärda nodhälsoinformationen.
 NodeHealth
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError