Alkalmazásadatok lekérése
Információt kér le egy Service Fabric-alkalmazásról.
A Service Fabric-fürtben létrehozott vagy folyamatban lévő alkalmazás adatait adja vissza, amelynek neve megegyezik a paraméterként megadott alkalmazással. A válasz tartalmazza az alkalmazás nevét, típusát, állapotát, paramétereit és egyéb adatait.
Kérés
Metódus | Kérés URI-ja |
---|---|
GET | /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&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 |
ExcludeApplicationParameters |
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 "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 az alkalmazás neve "fabric:/myapp/app1", akkor az alkalmazás identitása "myapp~app1" lesz a 6.0-s vagy újabb verziókban, a "myapp/app1" pedig 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.
ExcludeApplicationParameters
Típus: logikai
Kötelező: Nem
Alapértelmezett: false
A jelölő, amely azt határozza meg, hogy az alkalmazásparaméterek ki lesznek-e zárva az eredményből.
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) | Az alkalmazással kapcsolatos információk. |
ApplicationInfo |
204 (NoContent) | A rendszer üres választ ad vissza, ha a megadott applicationId nem található a fürtben. |
|
Minden más állapotkód | A részletes hibaválasz. |
FabricError |
Példák
Adott alkalmazás lekérése alkalmazásazonosító alapján
Ez a példa bemutatja, hogyan kérhet le információkat egy alkalmazásról annak azonosítójával. Ha az alkalmazás megtalálható, a rendszer 200 állapotkóddal adja vissza a rá vonatkozó információkat. Ha az alkalmazás nem található, a rendszer üres tartalmat ad vissza a 204-ben megadott állapotkóddal.
Kérés
GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0
200 Válasz
Törzs
{
"Id": "samples~CalculatorApp",
"Name": "fabric:/samples/CalculatorApp",
"TypeName": "CalculatorApp",
"TypeVersion": "1.0",
"Status": "Ready",
"Parameters": [
{
"Key": "CalculatorAppParameter1",
"Value": "314"
},
{
"Key": "CalculatorAppParameter2",
"Value": "271"
}
],
"HealthState": "Ok",
"ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}
204- válasz
Törzs
A választörzs üres.