Hämta klusterhälsa med hjälp av princip

Artikel
08/05/2023

Hämtar hälsotillståndet för ett Service Fabric-kluster med den angivna principen.

Använd EventsHealthStateFilter för att filtrera samlingen av hälsohändelser som rapporterats i klustret baserat på hälsotillståndet. På samma sätt använder du NodesHealthStateFilter och ApplicationsHealthStateFilter för att filtrera samlingen av noder och program som returneras baserat på deras aggregerade hälsotillstånd. Använd ClusterHealthPolicies för att åsidosätta de hälsoprinciper som används för att utvärdera hälsotillståndet.

Förfrågan

Metod	URI för förfrågan
POST	`/$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout}`

Parametrar

Namn	Typ	Obligatorisk	Location
`api-version`	sträng	Ja	Söka i data
`NodesHealthStateFilter`	heltal	No	Söka i data
`ApplicationsHealthStateFilter`	heltal	No	Söka i data
`EventsHealthStateFilter`	heltal	No	Söka i data
`ExcludeHealthStatistics`	boolean	No	Söka i data
`IncludeSystemApplicationHealthStatistics`	boolean	No	Söka i data
`timeout`	heltal (int64)	No	Söka i data
`ClusterHealthPolicies`	ClusterHealthPolicies	No	Brödtext

`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.

`NodesHealthStateFilter`

Typ: heltal
Obligatoriskt: Nej
Standard: 0

Tillåter filtrering av nodhälsotillståndsobjekt som returneras i resultatet av klusterhä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 noder som matchar filtret returneras. Alla noder 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 bitvis "OR"-operator. Om det angivna värdet till exempel är 6 returneras hälsotillståndet för noder 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.

`ApplicationsHealthStateFilter`

Typ: heltal
Obligatoriskt: Nej
Standard: 0

Tillåter filtrering av programhälsotillståndsobjekt som returneras i resultatet av klusterhälsofrågan baserat på deras hälsotillstånd. Möjliga värden för den här parametern inkluderar heltalsvärde som hämtats från medlemmar eller bitvisåtgärder för medlemmar i HealthStateFilter-uppräkning. Endast program som matchar filtret returneras. Alla 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 bitvis "OR"-operator. Om det angivna värdet till exempel är 6 returneras hälsotillståndet för 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.

`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.

`ExcludeHealthStatistics`

Typ: booleskt
Obligatoriskt: 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.

`IncludeSystemApplicationHealthStatistics`

Typ: booleskt
Obligatoriskt: Nej
Standard: false

Anger om hälsostatistiken ska innehålla hälsostatistik för infrastrukturresurser:/systemprogram. Falskt som standard. Om IncludeSystemApplicationHealthStatistics har angetts till true innehåller hälsostatistiken de entiteter som tillhör fabric:/System-programmet. Annars innehåller frågeresultatet endast hälsostatistik för användarprogram. Hälsostatistiken måste inkluderas i frågeresultatet för att den här parametern ska tillämpas.

`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.

`ClusterHealthPolicies`

Typ: ClusterHealthPolicies
Obligatoriskt: Nej

Beskriver de hälsoprinciper som används för att utvärdera klustrets hälsa. Om den inte finns använder hälsoutvärderingen den klusterhälsoprincip som definierats i klustermanifestet eller standardprincipen för klusterhälsa. Som standard utvärderas varje program med hjälp av dess specifika programhälsoprincip, definierad i programmanifestet eller standardhälsoprincipen, om ingen princip definieras i manifestet. Om programhälsoprincipkartan har angetts och den har en post för ett program används den angivna programhälsoprincipen för att utvärdera programmets hälsa.

Svar

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

Dela via