Získání stavu clusteru pomocí zásad
Získá stav clusteru Service Fabric pomocí zadaných zásad.
Pomocí funkce EventsHealthStateFilter můžete filtrovat kolekci událostí stavu hlášených v clusteru na základě stavu. Podobně použijte NodesHealthStateFilter a ApplicationsHealthStateFilter k filtrování kolekce vrácených uzlů a aplikací na základě jejich agregovaného stavu. Pomocí ClusterHealthPolicies přepište zásady stavu použité k vyhodnocení stavu.
Žádost
| Metoda | Identifikátor URI žádosti |
|---|---|
| POST | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Parametry
| Název | Typ | Vyžadováno | Umístění |
|---|---|---|---|
api-version |
řetězec | Ano | Dotaz |
NodesHealthStateFilter |
integer | Ne | Dotaz |
ApplicationsHealthStateFilter |
integer | Ne | Dotaz |
EventsHealthStateFilter |
integer | Ne | Dotaz |
ExcludeHealthStatistics |
boolean | Ne | Dotaz |
IncludeSystemApplicationHealthStatistics |
boolean | Ne | Dotaz |
timeout |
integer (int64) | Ne | Dotaz |
ClusterHealthPolicies |
ClusterHealthPolicies | Ne | Text |
api-version
Typ: řetězec
Povinné: Ano
Výchozí:6.0
Verze rozhraní API. Tento parametr je povinný a jeho hodnota musí být 6.0.
Verze rozhraní REST API Service Fabric je založená na verzi modulu runtime, ve které bylo rozhraní API zavedeno nebo změněno. Modul runtime Service Fabric podporuje více než jednu verzi rozhraní API. Toto je nejnovější podporovaná verze rozhraní API. Pokud se předá nižší verze rozhraní API, může se vrácená odpověď lišit od odpovědi popsané v této specifikaci.
Modul runtime navíc přijímá všechny verze, které jsou vyšší než nejnovější podporovaná verze až do aktuální verze modulu runtime. Pokud je tedy nejnovější verze rozhraní API 6.0, ale modul runtime je 6.1, aby se usnadnil zápis klientů, modul runtime pro toto rozhraní API přijme verzi 6.1. Chování rozhraní API však bude podle zdokumentované verze 6.0.
NodesHealthStateFilter
Typ: integer
Povinné: Ne
Výchozí:0
Umožňuje filtrování objektů stavu uzlu vrácených ve výsledku dotazu na stav clusteru na základě jejich stavu. Možné hodnoty tohoto parametru zahrnují celočíselnou hodnotu jednoho z následujících stavů. Vrátí se pouze uzly, které odpovídají filtru. Všechny uzly slouží k vyhodnocení agregovaného stavu.
Pokud není zadaný, vrátí se všechny položky.
Hodnoty stavů jsou výčty založené na příznaku, takže hodnota může být kombinací těchto hodnot získaných pomocí bitového operátoru OR.
Pokud je například zadaná hodnota 6, vrátí se stav uzlů s hodnotami HealthState OK (2) a Warning (4).
- Výchozí – výchozí hodnota. Odpovídá libovolnému stavu HealthState. Hodnota je nula.
- None – filtr, který neodpovídá žádné hodnotě HealthState. Používá se k vrácení žádných výsledků pro danou kolekci stavů. Hodnota je 1.
- Ok – filtr, který odpovídá vstupu s hodnotou HealthState OK. Hodnota je 2.
- Warning – filtr, který odpovídá vstupu s hodnotou HealthState Warning. Hodnota je 4.
- Error – filtr, který odpovídá vstupu s hodnotou HealthState Error. Hodnota je 8.
- Vše – filtr, který odpovídá vstupu s libovolnou hodnotou HealthState. Hodnota je 65535.
ApplicationsHealthStateFilter
Typ: integer
Povinné: Ne
Výchozí:0
Umožňuje filtrování objektů stavu aplikace vrácených ve výsledku dotazu na stav clusteru na základě jejich stavu.
Možné hodnoty tohoto parametru zahrnují celočíselnou hodnotu získanou ze členů nebo bitové operace se členy výčtu HealthStateFilter. Vrátí se pouze aplikace, které odpovídají filtru.
Všechny aplikace se používají k vyhodnocení agregovaného stavu. Pokud není zadaný, vrátí se všechny položky.
Hodnoty stavů jsou výčty založené na příznaku, takže hodnota může být kombinací těchto hodnot získaných pomocí bitového operátoru OR.
Pokud je například zadaná hodnota 6, vrátí se stav aplikací s hodnotami HealthState OK (2) a Warning (4).
- Výchozí – výchozí hodnota. Odpovídá libovolnému stavu HealthState. Hodnota je nula.
- None – filtr, který neodpovídá žádné hodnotě HealthState. Používá se k vrácení žádných výsledků pro danou kolekci stavů. Hodnota je 1.
- Ok – filtr, který odpovídá vstupu s hodnotou HealthState OK. Hodnota je 2.
- Warning – filtr, který odpovídá vstupu s hodnotou HealthState Warning. Hodnota je 4.
- Error – filtr, který odpovídá vstupu s hodnotou HealthState Error. Hodnota je 8.
- Vše – filtr, který odpovídá vstupu s libovolnou hodnotou HealthState. Hodnota je 65535.
EventsHealthStateFilter
Typ: integer
Povinné: Ne
Výchozí:0
Umožňuje filtrovat kolekci vrácených objektů HealthEvent na základě stavu.
Možné hodnoty tohoto parametru zahrnují celočíselnou hodnotu jednoho z následujících stavů.
Vrátí se pouze události, které odpovídají filtru. Všechny události se používají k vyhodnocení agregovaného stavu.
Pokud není zadaný, vrátí se všechny položky. Hodnoty stavu jsou výčty založené na příznaku, takže hodnota může být kombinací těchto hodnot, která se získá pomocí bitového operátoru "OR". Pokud je například zadaná hodnota 6, vrátí se všechny události s hodnotami HealthState OK (2) a Warning (4).
- Výchozí – výchozí hodnota. Odpovídá libovolnému stavu HealthState. Hodnota je nula.
- None – filtr, který neodpovídá žádné hodnotě HealthState. Používá se k vrácení žádných výsledků pro danou kolekci stavů. Hodnota je 1.
- Ok – filtr, který odpovídá vstupu s hodnotou HealthState OK. Hodnota je 2.
- Warning – filtr, který odpovídá vstupu s hodnotou HealthState Warning. Hodnota je 4.
- Error – filtr, který odpovídá vstupu s hodnotou HealthState Error. Hodnota je 8.
- Vše – filtr, který odpovídá vstupu s libovolnou hodnotou HealthState. Hodnota je 65535.
ExcludeHealthStatistics
Typ: boolean
Povinné: Ne
Výchozí:false
Určuje, jestli se mají jako součást výsledku dotazu vrátit statistiky stavu. Ve výchozím nastavení je false.
Statistika zobrazuje počet podřízených entit ve stavu Ok, Upozornění a Chyba.
IncludeSystemApplicationHealthStatistics
Typ: boolean
Povinné: Ne
Výchozí:false
Určuje, jestli by statistika stavu měla obsahovat statistiku fabric:/System application health statistiky. Ve výchozím nastavení je false.
Pokud je IncludeSystemApplicationHealthStatistics nastavená na hodnotu true, statistika stavu zahrnuje entity, které patří do aplikace fabric:/System.
V opačném případě bude výsledek dotazu obsahovat statistiku stavu jenom pro uživatelské aplikace.
Aby se tento parametr použil, musí být ve výsledku dotazu zahrnuté statistiky stavu.
timeout
Typ: integer (int64)
Povinné: Ne
Výchozí:60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Časový limit serveru pro provedení operace v sekundách. Tento časový limit určuje dobu, po kterou je klient ochoten čekat na dokončení požadované operace. Výchozí hodnota tohoto parametru je 60 sekund.
ClusterHealthPolicies
Typ: ClusterHealthPolicies
Povinné: Ne
Popisuje zásady stavu použité k vyhodnocení stavu clusteru.
Pokud není k dispozici, vyhodnocení stavu použije zásady stavu clusteru definované v manifestu clusteru nebo výchozí zásady stavu clusteru.
Ve výchozím nastavení se každá aplikace vyhodnocuje pomocí své konkrétní zásady stavu aplikace definované v manifestu aplikace nebo výchozí zásady stavu, pokud v manifestu nejsou definované žádné zásady.
Pokud je zadaná mapa zásad stavu aplikace a má položku pro aplikaci, použijí se k vyhodnocení stavu aplikace zadané zásady stavu aplikace.
Odpovědi
| Stavový kód HTTP | Description | Schéma odpovědi |
|---|---|---|
| 200 (OK) | Úspěšná operace vrátí stavový kód 200 a požadované informace o stavu clusteru. |
Stav clusteru |
| Všechny ostatní stavové kódy | Podrobná chybová odpověď. |
Chyba infrastruktury |