Získání nasazené služby Service Package Health pomocí zásad
Získá informace o stavu balíčku služby pro konkrétní aplikaci nasazenou v uzlu Service Fabric pomocí zadaných zásad.
Získá informace o stavu balíčku služby pro konkrétní aplikaci nasazenou v uzlu Service Fabric. pomocí zadaných zásad. Pomocí funkce EventsHealthStateFilter můžete volitelně filtrovat kolekci objektů HealthEvent hlášených v nasazeném balíčku služby na základě stavu. Pomocí ApplicationHealthPolicy můžete volitelně přepsat zásady stavu použité k vyhodnocení stavu. Toto rozhraní API používá pouze pole ConsiderWarningAsError v rámci applicationHealthPolicy. Zbývající pole se při vyhodnocování stavu nasazeného balíčku služby ignorují.
Žádost
| Metoda | Identifikátor URI žádosti |
|---|---|
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout} |
Parametry
| Název | Typ | Vyžadováno | Umístění |
|---|---|---|---|
nodeName |
řetězec | Yes | Cesta |
applicationId |
řetězec | Yes | Cesta |
servicePackageName |
řetězec | Yes | Cesta |
api-version |
řetězec | Ano | Dotaz |
EventsHealthStateFilter |
integer | No | Dotaz |
timeout |
integer (int64) | No | Dotaz |
ApplicationHealthPolicy |
Zásady stavu aplikace | No | Text |
nodeName
Typ: řetězec
Povinné: Ano
Název uzlu
applicationId
Typ: řetězec
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", identita aplikace bude ve verzi 6.0 nebo novější "myapp~app1" a v předchozích verzích "myapp/app1".
servicePackageName
Typ: řetězec
Povinné: Ano
Název balíčku služby.
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.
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 nasazeného balíčku služby pro konkrétní uzel a aplikaci. |
DeployedServicePackageHealth |
| Všechny ostatní stavové kódy | Podrobná chybová odpověď. |
Chyba infrastruktury |