Získat stav oddílu
Získá stav zadaného oddílu Service Fabric.
Pomocí funkce EventsHealthStateFilter můžete filtrovat kolekci událostí stavu hlášených ve službě na základě stavu. Pomocí ReplicasHealthStateFilter vyfiltrujte kolekci objektů ReplicaHealthState v oddílu. Pokud zadáte oddíl, který v úložišti stavů neexistuje, vrátí tento požadavek chybu.
Žádost
| Metoda | Identifikátor URI žádosti |
|---|---|
| GET | /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 | No | Dotaz |
timeout |
celé číslo (int64) | Ne | Dotaz |
partitionId
Typ: řetězec (uuid)
Povinné: Ano
Identita oddílu.
api-version
Typ: string
Povinné: Ano
Výchozí:6.0
Verze rozhraní API Tento parametr je povinný a jeho hodnota musí být 6.0.
Verze rozhraní SERVICE Fabric REST API 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 je předána nižší verze rozhraní API, vrácená odpověď se může 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: celé číslo
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 stavu.
Pokud není zadán, vrátí se všechny položky. Hodnoty stavu jsou výčet 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 hodnotou HealthState OK (2) a Warning (4).
- Výchozí – výchozí hodnota. Odpovídá libovolnému stavu stavu. Hodnota je nula.
- None – filtr, který neodpovídá žádné hodnotě HealthState. Používá se k vrácení žádných výsledků v dané 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.
- All – filtr, který odpovídá vstupu s libovolnou hodnotou HealthState. Hodnota je 65535.
ReplicasHealthStateFilter
Typ: celé číslo
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í zadáno, budou vráceny všechny položky. Hodnoty stavu jsou výčet 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 stavu. Hodnota je nula.
- None – filtr, který neodpovídá žádné hodnotě HealthState. Používá se k vrácení žádných výsledků v dané 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.
- All – filtr, který odpovídá vstupu s libovolnou hodnotou HealthState. Hodnota je 65535.
ExcludeHealthStatistics
Typ: logická
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í nepravda.
Statistika zobrazuje počet podřízených entit ve stavu OK, Upozornění a Chyba.
timeout
Typ: celé číslo (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.
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á odpověď na chybu. |
Chyba infrastruktury |