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

  • Článek

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

Získá stavovou repliku služby Service Fabric nebo instanci bezstavové služby. Pomocí funkce EventsHealthStateFilter můžete filtrovat 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 v 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) Ano Cesta
replicaId řetězec Yes Cesta
api-version řetězec Ano Dotaz
EventsHealthStateFilter integer No Dotaz
timeout celé číslo (int64) Ne Dotaz
ApplicationHealthPolicy ApplicationHealthPolicy Ne Text

partitionId

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

Identita oddílu.

replicaId

Typ: string
Povinné: Ano

Identifikátor repliky.

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.

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.

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, vyhodnocení stavu použije zásadu stavu z manifestu aplikace nebo výchozí zásadu 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.
 ReplicaHealth
Všechny ostatní stavové kódy Podrobná odpověď na chybu.
 Chyba infrastruktury