Hämta programhälsa

  • Artikel

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

Returnerar hälsotillståndet för Service Fabric-programmet. Svaret rapporterar antingen OK, Fel eller Varning hälsotillstånd. Om entiteten inte hittas i hälsoarkivet returneras Fel.

Förfrågan

Metod URI för förfrågan
GET /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Parametrar

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

applicationId

Typ: sträng
Obligatoriskt: Ja

Programmets identitet. Detta är vanligtvis det fullständiga namnet på programmet utan URI-schemat "fabric:". Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~". Om programnamnet till exempel är "fabric:/myapp/app1" skulle programidentiteten vara "myapp~app1" i 6.0+ och "myapp/app1" 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.

EventsHealthStateFilter

Typ: heltal
Obligatoriskt: Nej
Standard: 0

Tillåter filtrering av samlingen av HealthEvent-objekt som returneras baserat på hälsotillståndet. Möjliga värden för den här parametern inkluderar 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 BITWISE 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.

DeployedApplicationsHealthStateFilter

Typ: heltal
Obligatoriskt: Nej
Standard: 0

Tillåter filtrering av de distribuerade programhälsotillståndsobjekten som returneras i resultatet av programhälsofrågan baserat på deras hälsotillstånd. Möjliga värden för den här parametern inkluderar heltalsvärdet för något av följande hälsotillstånd. Endast distribuerade program som matchar filtret returneras. Alla distribuerade program 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 hjälp av bitvis "OR"-operator. Om det angivna värdet till exempel är 6 returneras hälsotillståndet för distribuerade program 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.

ServicesHealthStateFilter

Typ: heltal
Krävs: Nej
Standard: 0

Tillåter filtrering av tjänsthälsotillståndsobjekt som returneras i resultatet av frågor om tjänsters hälsotillstånd baserat på deras hälsotillstånd. 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 tjänster som matchar filtret returneras. Alla tjänster 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 erhålls med hjälp av bitvis "OR"-operator. Om det angivna värdet till exempel är 6 returneras hälsotillståndet för tjänster 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.

ExcludeHealthStatistics

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

Anger om hälsostatistiken ska returneras som en del av frågeresultatet. Falskt som standard. Statistiken visar antalet underordnade entiteter i hälsotillståndet Ok, Varning och Fel.

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 programhälsoinformationen.
 ApplicationHealth
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError