Replika állapotának lekérése szabályzattal

  • Cikk

Lekéri egy Service Fabric állapotalapú szolgáltatásreplika vagy állapot nélküli szolgáltatáspéldány állapotát a megadott szabályzat használatával.

Lekéri a Service Fabric állapotalapú szolgáltatásreplikájának vagy állapot nélküli szolgáltatáspéldányának állapotát. Az EventsHealthStateFilter használatával szűrje a fürtön jelentett állapotesemények gyűjteményét az állapot alapján. Az ApplicationHealthPolicy használatával igény szerint felülbírálhatja az állapot kiértékeléséhez használt állapotszabályzatokat. Ez az API csak az ApplicationHealthPolicy "ConsiderWarningAsError" mezőjét használja. A replika állapotának kiértékelése során a többi mező figyelmen kívül lesz hagyva.

Kérés

Metódus Kérés URI-ja
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Paraméterek

Név Típus Kötelező Hely
partitionId sztring (uuid) Yes Elérési út
replicaId sztring Igen Elérési út
api-version sztring Igen Lekérdezés
EventsHealthStateFilter egész szám No Lekérdezés
timeout egész szám (int64) No Lekérdezés
ApplicationHealthPolicy ApplicationHealthPolicy No Törzs

partitionId

Típus: sztring (uuid)
Kötelező: Igen

A partíció identitása.

replicaId

Típus: sztring
Kötelező: Igen

A replika azonosítója.

api-version

Típus: sztring
Kötelező: Igen
Alapértelmezett: 6.0

Az API verziója. Ez a paraméter kötelező, értéke pedig "6.0".

A Service Fabric REST API-verziója azon a futtatókörnyezeti verzión alapul, amelyben az API-t bevezették vagy módosították. A Service Fabric-futtatókörnyezet az API több verzióját is támogatja. Ez az API legújabb támogatott verziója. Ha egy alacsonyabb API-verziót ad át, a visszaadott válasz eltérhet az ebben a specifikációban dokumentálttól.

Emellett a futtatókörnyezet minden olyan verziót elfogad, amely magasabb, mint a legújabb támogatott verzió, egészen a futtatókörnyezet aktuális verziójáig. Tehát ha a legújabb API-verzió a 6.0, de ha a futtatókörnyezet 6.1, az ügyfelek írásának megkönnyítése érdekében a futtatókörnyezet elfogadja az API 6.1-es verzióját. Az API viselkedése azonban a dokumentált 6.0-s verziónak megfelelően fog változni.

EventsHealthStateFilter

Típus: egész szám
Kötelező: Nem
Alapértelmezett: 0

Lehetővé teszi az állapot alapján visszaadott HealthEvent objektumok gyűjteményének szűrését. A paraméter lehetséges értékei közé tartozik az alábbi állapotok egyikének egész értéke. A rendszer csak a szűrőnek megfelelő eseményeket adja vissza. Az összes esemény az összesített állapot kiértékelésére szolgál. Ha nincs megadva, a rendszer minden bejegyzést visszaad. Az állapotértékek jelzőalapú számbavételek, ezért az érték az értékek kombinációja lehet, amelyet a bitenkénti "OR" operátorral kapunk. Ha például a megadott érték 6, akkor a rendszer az OK (2) és a Figyelmeztetés (4) állapotértékkel rendelkező összes eseményt visszaadja.

  • Alapértelmezett – Alapértelmezett érték. Bármely HealthState-ra illeszkedik. Az érték nulla.
  • Nincs – Olyan szűrő, amely nem felel meg a HealthState értéknek. Egy adott állapotgyűjtemény eredményének visszaadására szolgál. Az érték 1.
  • Ok – Szűrő, amely megfelel a bemenetnek az Ok állapotértékkel. Az érték 2.
  • Figyelmeztetés – Olyan szűrő, amely megfelel a bemenetnek a Figyelmeztetés Állapotállapot értékkel. Az érték 4.
  • Hiba – A bemenetnek a HealthState error értékkel egyező szűrője. Az érték 8.
  • All – Olyan szűrő, amely megfelel a bemenetnek bármely HealthState értékkel. Az érték 65535.

timeout

Típus: egész szám (int64)
Kötelező: Nem
Alapértelmezett: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

A művelet végrehajtásának kiszolgálói időtúllépése másodpercben. Ez az időtúllépés azt az időtartamot adja meg, amelyet az ügyfél hajlandó megvárni a kért művelet befejezéséig. A paraméter alapértelmezett értéke 60 másodperc.

ApplicationHealthPolicy

Típus: ApplicationHealthPolicy
Kötelező: Nem

Egy alkalmazás vagy egy gyermek állapotának értékeléséhez használt állapotszabályzatokat ismerteti. Ha nincs jelen, az állapotértékelés az alkalmazásjegyzékből vagy az alapértelmezett állapotszabályzatból származó állapotszabályzatot használja.

Válaszok

HTTP-állapotkód Description Válaszséma
200 (OK) A sikeres művelet 200 állapotkódot és a kért replikaállapot-adatokat adja vissza.
 Replika állapota
Minden más állapotkód A részletes hibaválasz.
 Hálóerror