Získání bloku stavu clusteru pomocí zásad a rozšířených filtrů

Získá stav clusteru Service Fabric pomocí bloků stavu.

Získá stav clusteru Service Fabric pomocí bloků stavu. Vyhodnocení stavu se provádí na základě popisu vstupního dotazu na blok dat clusteru. Popis dotazu umožňuje uživatelům určit zásady stavu pro vyhodnocení clusteru a jeho podřízených položek. Uživatelé můžou zadat velmi flexibilní filtry a vybrat entity clusteru, které se mají vrátit. Výběr lze provést na základě stavu entit a hierarchie. Dotaz může vrátit víceúrovňové podřízené položky entit na základě zadaných filtrů. Může například vrátit jednu aplikaci se zadaným názvem a pro tuto aplikaci pouze služby, které jsou v chybě nebo upozornění, a všechny oddíly a repliky pro jednu z těchto služeb.

Žádost

Metoda Identifikátor URI žádosti
POST /$/GetClusterHealthChunk?api-version=6.0&timeout={timeout}

Parametry

Název Typ Vyžadováno Umístění
api-version řetězec Ano Dotaz
timeout integer (int64) Ne Dotaz
ClusterHealthChunkQueryDescription ClusterHealthChunkQueryDescription No 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.


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.


ClusterHealthChunkQueryDescription

Typ: ClusterHealthChunkQueryDescription
Povinné: Ne

Popisuje zásady stavu clusteru a aplikací použité k vyhodnocení stavu clusteru a filtry pro výběr entit clusteru, které se mají vrátit. Pokud zásady stavu clusteru existují, použijí se k vyhodnocení událostí clusteru a uzlů 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. Uživatelé můžou zadat velmi flexibilní filtry a vybrat entity clusteru, které se mají zahrnout jako odpověď. Výběr lze provést na základě stavu entit a hierarchie. Dotaz může vrátit víceúrovňové podřízené položky entit na základě zadaných filtrů. Může například vrátit jednu aplikaci se zadaným názvem a pro tuto aplikaci pouze služby, které jsou v chybě nebo upozornění, a všechny oddíly a repliky pro jednu z těchto služeb.

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.
ClusterHealthChunk
Všechny ostatní stavové kódy Podrobná chybová odpověď.
Chyba infrastruktury