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

Artikel
08/05/2023

Hämtar hälsotillståndet för den angivna Service Fabric-tjänsten med hjälp av den angivna hälsoprincipen.

Hämtar hälsoinformationen för den angivna tjänsten. Om programmets hälsoprincip anges använder hälsoutvärderingen den för att hämta det aggregerade hälsotillståndet. Om principen inte anges använder hälsoutvärderingen den programhälsoprincip som definierats i programmanifestet, eller standardhälsoprincipen, om ingen princip har definierats i manifestet. Använd EventsHealthStateFilter för att filtrera insamlingen av hälsohändelser som rapporterats på tjänsten baserat på hälsotillståndet. Använd PartitionsHealthStateFilter för att filtrera samlingen med partitioner som returneras. Om du anger en tjänst som inte finns i hälsoarkivet returnerar den här begäran ett fel.

Förfrågan

Metod	URI för förfrågan
POST	`/Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

Parametrar

Namn	Typ	Obligatorisk	Location
`serviceId`	sträng	Ja	Sökväg
`api-version`	sträng	Ja	Söka i data
`EventsHealthStateFilter`	heltal	No	Söka i data
`PartitionsHealthStateFilter`	heltal	No	Söka i data
`ExcludeHealthStatistics`	boolean	No	Söka i data
`timeout`	heltal (int64)	No	Söka i data
`ApplicationHealthPolicy`	ApplicationHealthPolicy	No	Brödtext

`serviceId`

Typ: sträng
Krävs: 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
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.

`PartitionsHealthStateFilter`

Typ: heltal
Krävs: Nej
Standard: 0

Tillåter filtrering av partitionernas hälsotillståndsobjekt som returneras i resultatet av service health-frågan 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 partitioner som matchar filtret returneras. Alla partitioner 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"-operatorn. Om det angivna värdet till exempel är 6 returneras hälsotillståndet för partitioner 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.

`ApplicationHealthPolicy`

Typ: ApplicationHealthPolicy
Krävs: Nej

Beskriver de hälsoprinciper som används för att utvärdera hälsotillståndet för ett program eller någon av dess underordnade. Om den inte finns använder hälsoutvärderingen hälsoprincipen från programmanifestet eller standardhälsoprincipen.

Svar

HTTP-statuskod	Description	Svarsschema
200 (OK)	En lyckad åtgärd returnerar 200 statuskod och hälsoinformationen för den angivna tjänsten.	ServiceHealth
Alla andra statuskoder	Det detaljerade felsvaret.	FabricError

Share via