Získání stavu oddílu pomocí zásad
Získá stav zadaného oddílu Service Fabric pomocí zadaných zásad stavu.
Získá informace o stavu zadaného oddílu. Pokud je zadaná zásada stavu aplikace, vyhodnocení stavu ji použije k získání agregovaného stavu. Pokud není zásada zadaná, použije se při vyhodnocování stavu aplikace zásada stavu aplikace definovaná v manifestu aplikace nebo výchozí zásada stavu, pokud v manifestu není definovaná žádná zásada. Pomocí funkce EventsHealthStateFilter můžete filtrovat kolekci událostí stavu hlášených v oddílu na základě stavu. Pomocí ReplicasHealthStateFilter vyfiltrujte kolekci objektů ReplicaHealthState v oddílu. Pomocí ApplicationHealthPolicy v textu POST přepište zásady stavu použité k vyhodnocení stavu. Pokud zadáte oddíl, který v úložišti stavů neexistuje, vrátí tento požadavek chybu.
Žádost
| Metoda | Identifikátor URI žádosti |
|---|---|
| POST | /Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parametry
| Název | Typ | Vyžadováno | Umístění |
|---|---|---|---|
partitionId |
string (uuid) | Ano | Cesta |
api-version |
řetězec | Ano | Dotaz |
EventsHealthStateFilter |
integer | Ne | Dotaz |
ReplicasHealthStateFilter |
integer | Ne | Dotaz |
ExcludeHealthStatistics |
boolean | Ne | Dotaz |
timeout |
integer (int64) | No | Dotaz |
ApplicationHealthPolicy |
Zásady stavu aplikace | Ne | Text |
partitionId
Typ: řetězec (uuid)
Povinné: Ano
Identita oddílu.
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.
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.
ReplicasHealthStateFilter
Typ: integer
Povinné: Ne
Výchozí:0
Umožňuje filtrovat kolekci objektů ReplicaHealthState v oddílu. Hodnotu lze získat ze členů nebo bitové operace u členů HealthStateFilter. Budou vráceny pouze repliky, které odpovídají filtru. Všechny repliky se použijí 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 všechny události s hodnotami HealthState OK (2) a Warning (4). Možné hodnoty tohoto parametru zahrnují celočíselnou hodnotu jednoho z následujících stavů.
- 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.
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.
ApplicationHealthPolicy
Typ: ApplicationHealthPolicy
Povinné: Ne
Popisuje zásady stavu používané k vyhodnocení stavu aplikace nebo některé z jejích podřízených položek.
Pokud není k dispozici, použije se při vyhodnocování stavu zásada stavu z manifestu aplikace nebo výchozí zásada stavu.
Odpovědi
| Stavový kód HTTP | Description | Schéma odpovědi |
|---|---|---|
| 200 (OK) | Úspěšná operace vrátí stavový kód 200 a informace o stavu zadaného oddílu. |
PartitionHealth |
| Všechny ostatní stavové kódy | Podrobná chybová odpověď. |
Chyba infrastruktury |