Megosztás a következőn keresztül:

Service Health lekérése

  • Cikk

Lekéri a megadott Service Fabric-szolgáltatás állapotát.

Lekéri a megadott szolgáltatás állapotadatait. Az EventsHealthStateFilter használatával szűrje a szolgáltatásban jelentett állapotesemények gyűjteményét az állapot alapján. A PartitionsHealthStateFilter használatával szűrje a visszaadott partíciók gyűjteményét. Ha olyan szolgáltatást ad meg, amely nem létezik az állapottárolóban, a kérés hibát ad vissza.

Kérés

Metódus Kérés URI-ja
GET /Services/{serviceId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&PartitionsHealthStateFilter={PartitionsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Paraméterek

Név Típus Kötelező Hely
serviceId sztring Igen Elérési út
api-version sztring Igen Lekérdezés
EventsHealthStateFilter egész szám No Lekérdezés
PartitionsHealthStateFilter egész szám No Lekérdezés
ExcludeHealthStatistics boolean No Lekérdezés
timeout egész szám (int64) No Lekérdezés

serviceId

Típus: sztring
Kötelező: Igen

A szolgáltatás identitása. Ez az azonosító általában a szolgáltatás teljes neve a "háló:" URI-séma nélkül. A 6.0-s verziótól kezdve a hierarchikus nevek a "~" karakterrel vannak elválasztva. Ha például a szolgáltatás neve "fabric:/myapp/app1/svc1", akkor a szolgáltatás identitása a "myapp~app1~svc1" lesz a 6.0+-ban és a "myapp/app1/svc1" a korábbi verziókban.

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 elfogad minden olyan verziót, amely magasabb, mint a legújabb támogatott verzió, egészen a futtatókörnyezet aktuális verziójáig. Ha tehát a legújabb API-verzió a 6.0, de 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 a HealthEvent-objektumok gyűjteményének szűrését az állapot alapján. 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 az összes bejegyzést visszaadja. 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 szerezhetünk be. Ha például a megadott érték 6, akkor a rendszer az OK (2) és a Figyelmeztetés (4) HealthState értékkel rendelkező összes eseményt visszaadja.

  • Alapértelmezett – Alapértelmezett érték. Bármely HealthState-nak megfelel. Az érték nulla.
  • Nincs – Olyan szűrő, amely nem felel meg a HealthState értéknek. Egy adott állapotgyűjtemény eredményeinek visszaadására szolgál. Az érték 1.
  • Ok – Szűrő, amely megfelel a bemenetnek a HealthState ok értékével. Az érték 2.
  • Figyelmeztetés – Olyan szűrő, amely megegyezik a HealthState érték figyelmeztetésével. Az érték 4.
  • Hiba – Szűrő, amely megfelel a bemenetnek a HealthState érték hiba értékével. Az érték 8.
  • Mind – Szűrő, amely megfelel a bemenetnek bármely HealthState-értékkel. Az érték 65535.

PartitionsHealthStateFilter

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

Lehetővé teszi a partíciók állapot-objektumainak szűrését, amely a szolgáltatásállapot-lekérdezés eredménye alapján ad vissza állapotot. 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ő partíciókat adja vissza. Az összes partíció az összesített állapot kiértékelésére szolgál. Ha nincs megadva, a rendszer az összes bejegyzést visszaadja. Az állapotértékek jelzőalapú számbavételek, így az érték a bitenkénti "OR" operátorral kapott érték kombinációja lehet. Ha például a megadott érték 6, akkor a rendszer az OK (2) és a Figyelmeztetés (4) állapotú partíciók állapotát adja vissza.

  • Alapértelmezett – Alapértelmezett érték. Bármely HealthState-nak megfelel. Az érték nulla.
  • Nincs – Olyan szűrő, amely nem felel meg a HealthState értéknek. Egy adott állapotgyűjtemény eredményeinek visszaadására szolgál. Az érték 1.
  • Ok – Szűrő, amely megfelel a bemenetnek a HealthState ok értékével. Az érték 2.
  • Figyelmeztetés – Olyan szűrő, amely megegyezik a HealthState érték figyelmeztetésével. Az érték 4.
  • Hiba – Szűrő, amely megfelel a bemenetnek a HealthState érték hiba értékével. Az érték 8.
  • Mind – Szűrő, amely megfelel a bemenetnek bármely HealthState-értékkel. Az érték 65535.

ExcludeHealthStatistics

Típus: logikai
Kötelező: Nem
Alapértelmezett: false

Azt jelzi, hogy az állapotstatisztikát vissza kell-e adni a lekérdezés eredményének részeként. Alapértelmezés szerint hamis. A statisztikák az OK, a Figyelmeztetés és a Hiba állapotú gyermekentitások számát mutatják.

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.

Válaszok

HTTP-állapotkód Description Válaszséma
200 (OK) A sikeres művelet 200 állapotkódot és a megadott szolgáltatás állapotadatait adja vissza.
 ServiceHealth
Minden más állapotkód A részletes hibaválasz.
 Hálóerror