Alkalmazásállapot lekérése
Lekéri a Service Fabric-alkalmazás állapotát.
A Service Fabric-alkalmazás hőállapotát adja vissza. A válasz az OK, a Hiba vagy a Figyelmeztetés állapotot jelenti. Ha az entitás nem található az állapottárolóban, hibaüzenetet ad vissza.
Kérés
| Metódus | Kérés URI-ja |
|---|---|
| GET | /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Paraméterek
| Név | Típus | Kötelező | Hely |
|---|---|---|---|
applicationId |
sztring | Igen | Elérési út |
api-version |
sztring | Igen | Lekérdezés |
EventsHealthStateFilter |
egész szám | No | Lekérdezés |
DeployedApplicationsHealthStateFilter |
egész szám | No | Lekérdezés |
ServicesHealthStateFilter |
egész szám | No | Lekérdezés |
ExcludeHealthStatistics |
boolean | No | Lekérdezés |
timeout |
egész szám (int64) | No | Lekérdezés |
applicationId
Típus: sztring
Kötelező: Igen
Az alkalmazás identitása. Ez általában az alkalmazás teljes neve a "fabric:" URI séma nélkül.
A 6.0-s verziótól kezdődően a hierarchikus nevek "~" karakterrel vannak elválasztva.
Ha például az alkalmazás neve "fabric:/myapp/app1", akkor az alkalmazás identitása a "myapp~app1" lesz a 6.0-s vagy újabb verziókban, illetve a "myapp/app1" 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 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.
DeployedApplicationsHealthStateFilter
Típus: egész szám
Kötelező: Nem
Alapértelmezett: 0
Lehetővé teszi az üzembe helyezett alkalmazások állapot-objektumainak szűrését, amelyeket az alkalmazásállapot-lekérdezés eredményében ad vissza az állapotuk 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ő telepített alkalmazásokat adja vissza.
Az összes üzembe helyezett alkalmazás 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, így az érték ezen értékek kombinációja lehet, amely bitenkénti "OR" operátorral érhető el.
Ha például a megadott érték 6, akkor a rendszer az OK (2) és a Figyelmeztetés (4) állapotú üzembe helyezett alkalmazások állapotát adja vissza.
- 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.
- Mind – Szűrő, amely megfelel a bemenetnek bármely HealthState-értékkel. Az érték 65535.
ServicesHealthStateFilter
Típus: egész szám
Kötelező: Nem
Alapértelmezett: 0
Lehetővé teszi a szolgáltatások állapot-lekérdezésének eredményeként visszaadott szolgáltatások állapotobjektumainak szűrését az állapotuk 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ő szolgáltatásokat adja vissza. Az összes szolgáltatás 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ételt jelentenek, így az érték ezen értékek kombinációja lehet, amely bitenkénti "OR" operátorral érhető el. Ha például a megadott érték 6, akkor a rendszer az OK (2) és a Figyelmeztetés (4) Állapotértékkel rendelkező szolgáltatások á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 a lekérdezés eredményének részeként kell-e visszaadni. Alapértelmezés szerint hamis.
A statisztikák az Ok, a Figyelmeztetés és a Hiba állapotú gyermek entitá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 kiszolgáló időtúllépése a művelet másodpercben történő végrehajtásához. 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 kért alkalmazásállapot-adatokat adja vissza. |
ApplicationHealth |
| Minden más állapotkód | A részletes hibaválasz. |
FabricError |