Získání informací o nasazené aplikaci
Získá informace o aplikaci nasazené v uzlu Service Fabric.
Tento dotaz vrátí informace o systémové aplikaci, pokud je zadané ID aplikace určené pro systémovou aplikaci. Výsledky zahrnují nasazené aplikace ve stavu aktivní, aktivace a stahování. Tento dotaz vyžaduje, aby název uzlu odpovídal uzlu v clusteru. Dotaz selže, pokud zadaný název uzlu neodkazuje na žádné aktivní uzly Service Fabric v clusteru.
Žádost
Metoda | Identifikátor URI žádosti |
---|---|
GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState} |
Parametry
Název | Typ | Vyžadováno | Umístění |
---|---|---|---|
nodeName |
řetězec | Yes | Cesta |
applicationId |
řetězec | Yes | Cesta |
api-version |
řetězec | Ano | Dotaz |
timeout |
integer (int64) | No | Dotaz |
IncludeHealthState |
boolean | No | Dotaz |
nodeName
Typ: řetězec
Povinné: Ano
Název uzlu
applicationId
Typ: řetězec
Povinné: Ano
Identita aplikace. Obvykle se jedná o úplný název aplikace bez schématu identifikátoru URI fabric:.
Od verze 6.0 jsou hierarchické názvy oddělené znakem ~.
Pokud je například název aplikace "fabric:/myapp/app1", identita aplikace bude ve verzi 6.0 nebo novější "myapp~app1" a v předchozích verzích "myapp/app1".
api-version
Typ: řetězec
Povinné: Ano
Výchozí:6.1
Verze rozhraní API. Tento parametr je povinný a jeho hodnota musí být 6.1.
Verze rozhraní REST API Service Fabric 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 se předá nižší verze rozhraní API, může se vrácená odpověď 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.
timeout
Typ: integer (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.
IncludeHealthState
Typ: boolean
Povinné: Ne
Výchozí:false
Uveďte stav entity.
Pokud je tento parametr false nebo není zadaný, je vrácený stav Neznámý.
Pokud je nastavená hodnota true, dotaz před sloučením výsledků přejde paralelně k uzlu a službě Health System.
V důsledku toho je dotaz dražší a může trvat delší dobu.
Odpovědi
Stavový kód HTTP | Description | Schéma odpovědi |
---|---|---|
200 (OK) | Úspěšná operace vrátí stavový kód 200 a informace o nasazené aplikaci. |
DeployedApplicationInfo |
204 (bez obsahu) | Pokud zadaná aplikace není na uzlu nasazená, vrátí se prázdná odpověď. |
|
Všechny ostatní stavové kódy | Podrobná chybová odpověď. |
Chyba infrastruktury |
Příklady
Získání konkrétní nasazené aplikace podle ID aplikace a zahrnutí stavu do výsledku
Tento příklad ukazuje, jak získat informace o aplikaci nasazené v zadaném uzlu pomocí identifikátoru aplikace. Pokud se aplikace najde, vrátí se její informace se stavovým kódem 200. Pokud zadaná aplikace není na uzlu nasazená, vrátí se prázdná odpověď se stavovým kódem 204.
Žádost
GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True
Odpověď 200
Text
{
"Id": "samples~CalculatorApp",
"Name": "fabric:/samples/CalculatorApp",
"TypeName": "CalculatorApp",
"TypeVersion": "1.0.0",
"Status": "Active",
"WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
"LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
"TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
"HealthState": "Ok"
}
Odpověď 204
Text
Text odpovědi je prázdný.