Hämta distribuerad programinformation

  • Artikel

Hämtar information om ett program som distribuerats på en Service Fabric-nod.

Den här frågan returnerar systemprograminformation om det angivna program-ID:t är för systemprogrammet. Resultaten omfattar distribuerade program i aktiva, aktiverande och nedladdningstillstånd. Den här frågan kräver att nodnamnet motsvarar en nod i klustret. Frågan misslyckas om det angivna nodnamnet inte pekar på några aktiva Service Fabric-noder i klustret.

Förfrågan

Metod URI för förfrågan
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

Parametrar

Namn Typ Obligatorisk Location
nodeName sträng Ja Sökväg
applicationId sträng Ja Sökväg
api-version sträng Ja Söka i data
timeout heltal (int64) No Söka i data
IncludeHealthState boolean No Söka i data

nodeName

Typ: sträng
Obligatoriskt: Ja

Nodens namn.

applicationId

Typ: sträng
Obligatoriskt: Ja

Programmets identitet. Detta är vanligtvis det fullständiga namnet på programmet utan URI-schemat "fabric:". Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~". Om programnamnet till exempel är "fabric:/myapp/app1" skulle programidentiteten vara "myapp~app1" i 6.0+ och "myapp/app1" i tidigare versioner.

api-version

Typ: sträng
Obligatoriskt: Ja
Standard: 6.1

Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.1".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, för att göra det enklare att skriva klienterna, accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.

timeout

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

IncludeHealthState

Typ: booleskt
Obligatoriskt: Nej
Standard: false

Inkludera hälsotillståndet för en entitet. Om den här parametern är falsk eller inte angiven är hälsotillståndet som returneras "Okänt". När frågan är inställd på true går den parallellt med noden och hälsosystemtjänsten innan resultatet slås samman. Därför är frågan dyrare och kan ta längre tid.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) En lyckad åtgärd returnerar statuskoden 200 och informationen om det distribuerade programmet.
 DeployedApplicationInfo
204 (NoContent) Ett tomt svar returneras om det angivna programmet inte distribueras på noden.
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Hämta ett specifikt distribuerat program efter program-ID och inkludera hälsotillståndet i resultatet

Det här exemplet visar hur du hämtar information om ett program som distribueras på en angiven nod med hjälp av en programidentifierare. Om programmet hittas returneras informationen med statuskoden 200. Ett tomt svar med statuskod 204 returneras om det angivna programmet inte distribueras på noden.

Förfrågan

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

200-svar

Brödtext
{
  "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"
}

204-svar

Brödtext

Svarstexten är tom.