Získání stavu aplikace pomocí zásad
Získá stav aplikace Service Fabric pomocí zadaných zásad.
Získá stav aplikace Service Fabric. Pomocí funkce EventsHealthStateFilter můžete filtrovat kolekci událostí stavu hlášených na uzlu na základě stavu. Pomocí ClusterHealthPolicies přepište zásady stavu použité k vyhodnocení stavu.
Žádost
| Metoda | Identifikátor URI žádosti |
|---|---|
| POST | /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parametry
| Název | Typ | Vyžadováno | Umístění |
|---|---|---|---|
applicationId |
řetězec | Yes | Cesta |
api-version |
řetězec | Yes | Dotaz |
EventsHealthStateFilter |
integer | Ne | Dotaz |
DeployedApplicationsHealthStateFilter |
integer | Ne | Dotaz |
ServicesHealthStateFilter |
integer | Ne | Dotaz |
ExcludeHealthStatistics |
boolean | Ne | Dotaz |
timeout |
celé číslo (int64) | Ne | Dotaz |
ApplicationHealthPolicy |
ApplicationHealthPolicy | Ne | Text |
applicationId
Typ: string
Povinné: Ano
Identita aplikace. Obvykle se jedná o úplný název aplikace bez schématu identifikátoru URI fabric:.
Od verze 6.0 jsou hierarchické názvy oddělené znakem "~".
Pokud je například název aplikace "fabric:/myapp/app1", bude identita aplikace ve verzi 6.0 nebo novější myapp~app1 a v předchozích verzích myapp/app1.
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.
DeployedApplicationsHealthStateFilter
Typ: celé číslo
Povinné: Ne
Výchozí:0
Umožňuje filtrování objektů stavu nasazených aplikací vrácených ve výsledku dotazu na stav aplikace na základě jejich stavu.
Možné hodnoty tohoto parametru zahrnují celočíselnou hodnotu jednoho z následujících stavů. Vrátí se jenom nasazené aplikace, které odpovídají filtru.
Všechny nasazené aplikace 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 stav nasazených aplikací s hodnotami 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.
- Vše – filtr, který odpovídá vstupu s libovolnou hodnotou HealthState. Hodnota je 65535.
ServicesHealthStateFilter
Typ: integer
Povinné: Ne
Výchozí:0
Umožňuje filtrování objektů stavu služeb vrácených ve výsledku dotazu na stav služeb 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 služby, které odpovídají filtru. Všechny služby 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, která se získá pomocí bitového operátoru OR. Pokud je například zadaná hodnota 6, vrátí se stav služeb 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.
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 požadované informace o stavu uzlu. |
ApplicationHealth |
| Všechny ostatní stavové kódy | Podrobná chybová odpověď. |
Chyba infrastruktury |