Získání stavu repliky pomocí zásad

Získá stav repliky stavové služby nebo bezstavové instance služby Service Fabric pomocí zadané zásady.

Získá stav repliky stavové služby nebo instance bezstavové služby Service Fabric. Pomocí EventHealthStateFilter vyfiltrujte kolekci událostí stavu hlášených v clusteru 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 applicationHealthPolicy. Zbývající pole se při vyhodnocování stavu repliky ignorují.

Žádost

Metoda Identifikátor URI žádosti
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Parametry

Název Typ Vyžadováno Umístění
partitionId string (uuid) Yes Cesta
replicaId řetězec Yes Cesta
api-version řetězec Ano Dotaz
EventsHealthStateFilter integer No Dotaz
timeout celé číslo (int64) No Dotaz
ApplicationHealthPolicy ApplicationHealthPolicy No Text

partitionId

Typ: řetězec (uuid)
Povinné: Ano

Identita oddílu.


replicaId

Typ: řetězec
Povinné: Ano

Identifikátor repliky.


api-version

Typ: řetězec
Povinné: Ano
Výchozí nastavení: 6.0

Verze rozhraní API. Tento parametr je povinný a jeho hodnota musí být 6,0.

Service Fabric verze rozhraní REST API je založená na verzi modulu runtime, ve které bylo rozhraní API zavedeno nebo změněno. Service Fabric runtime 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á jakoukoli verzi, která je vyšší než nejnovější podporovaná verze až do aktuální verze modulu runtime. Takže pokud je nejnovější verze rozhraní API verze 6.0, ale pokud je modul runtime 6.1, aby bylo snazší psát klienty, modul runtime pro toto rozhraní API přijme verzi 6.1. Chování rozhraní API ale bude podle zdokumentované verze 6.0.


EventsHealthStateFilter

Typ: celé číslo
Povinné: Ne
Výchozí nastavení: 0

Umožňuje filtrovat kolekci objektů HealthEvent vrácených 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 slouží k vyhodnocení agregovaného stavu. Pokud není zadáno, vrátí se všechny položky. Hodnoty stavu jsou výčty založené na příznaku, takže tato hodnota může být kombinací těchto hodnot získaných pomocí bitové operátoru OR. Pokud je například zadaná hodnota 6, vrátí se všechny události s hodnotou HealthState OK (2) a Upozornění (4).

  • Výchozí – výchozí hodnota. Odpovídá libovolnému stavu stavu. Hodnota je nula.
  • Žádné – Filtr, který neodpovídá žádné hodnotě HealthState. Slouží 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.
  • Upozornění – Filtr, který odpovídá vstupu s upozorněním hodnoty HealthState. Hodnota je 4.
  • Chyba – 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: celé číslo (int64)
Povinné: Ne
Výchozí nastavení: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Časový limit serveru pro provedení operace v sekundách. Tento časový limit určuje dobu, po kterou je klient ochotný počkat 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 jedné z jejích podřízených položek. Pokud není k dispozici, vyhodnocení stavu používá zásady stavu z manifestu aplikace nebo výchozí zásady 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 repliky.
ReplikaHealth
Všechny ostatní stavové kódy Podrobná odpověď na chybu.
FabricError