Hämta klusterhälsosegment med hjälp av principer och avancerade filter

  • Artikel

Hämtar hälsotillståndet för ett Service Fabric-kluster med hjälp av hälsosegment.

Hämtar hälsotillståndet för ett Service Fabric-kluster med hjälp av hälsosegment. Hälsoutvärderingen görs baserat på frågebeskrivningen för indataklustrets hälsosegment. Med frågebeskrivningen kan användare ange hälsoprinciper för utvärdering av klustret och dess underordnade. Användare kan ange mycket flexibla filter för att välja vilka klusterentiteter som ska returneras. Valet kan göras baserat på entiteternas hälsotillstånd och baserat på hierarkin. Frågan kan returnera underordnade entiteter på flera nivåer baserat på de angivna filtren. Den kan till exempel returnera ett program med ett angivet namn, och för det här programmet returneras endast tjänster som är i Fel eller Varning, och alla partitioner och repliker för någon av dessa tjänster.

Förfrågan

Metod URI för förfrågan
POST /$/GetClusterHealthChunk?api-version=6.0&timeout={timeout}

Parametrar

Namn Typ Obligatorisk Location
api-version sträng Ja Söka i data
timeout heltal (int64) No Söka i data
ClusterHealthChunkQueryDescription ClusterHealthChunkQueryDescription No Brödtext

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.

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.

ClusterHealthChunkQueryDescription

Typ: ClusterHealthChunkQueryDescription
Krävs: Nej

Beskriver de principer för kluster- och programhälsa som används för att utvärdera klustrets hälsa och filtren för att välja vilka klusterentiteter som ska returneras. Om klustrets hälsoprincip finns används den för att utvärdera klusterhändelserna och klusternoderna. Om den inte finns använder hälsoutvärderingen den princip för klusterhälsa som definierats i klustermanifestet eller standardprincipen för klusterhälsa. Som standard utvärderas varje program med hjälp av sin specifika programhälsoprincip, definierad i programmanifestet eller standardhälsoprincipen, om ingen princip har definierats i manifestet. Om programhälsoprincipkartan har angetts och den har en post för ett program används den angivna hälsoprincipen för programmet för att utvärdera programmets hälsa. Användare kan ange mycket flexibla filter för att välja vilka klusterentiteter som ska inkluderas som svar. Valet kan göras baserat på entiteternas hälsotillstånd och baserat på hierarkin. Frågan kan returnera underordnade entiteter på flera nivåer baserat på de angivna filtren. Den kan till exempel returnera ett program med ett angivet namn, och för det här programmet returneras endast tjänster som är i Fel eller Varning, och alla partitioner och repliker för någon av dessa tjänster.

Svar

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