Dela via

Hämta lista över distribuerade programinformation

  • Artikel

Hämtar listan över program som distribueras på en Service Fabric-nod.

Hämtar listan över program som distribueras på en Service Fabric-nod. Resultaten innehåller inte information om distribuerade systemprogram såvida de inte uttryckligen efterfrågas av ID. 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?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

Parametrar

Namn Typ Obligatorisk Location
nodeName 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
ContinuationToken sträng No Söka i data
MaxResults heltal (int64) No Söka i data

nodeName

Typ: sträng
Krävs: Ja

Namnet på noden.

api-version

Typ: sträng
Krävs: 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 dokumenteras i den här specifikationen.

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

timeout

Typ: heltal (int64)
Krävs: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns tidsgräns 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 värde
Krävs: Nej
Standard: false

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

ContinuationToken

Typ: sträng
Krävs: Nej

Parametern fortsättningstoken används för att hämta nästa resultatuppsättning. En fortsättningstoken med ett icke-tomt värde ingår i API:ets svar när resultatet från systemet inte får plats i ett enda svar. När det här värdet skickas till nästa API-anrop returnerar API:et nästa uppsättning resultat. Om det inte finns några ytterligare resultat innehåller fortsättningstoken inget värde. Värdet för den här parametern ska inte vara URL-kodat.

MaxResults

Typ: heltal (int64)
Krävs: Nej
Standard: 0
InclusiveMinimum: 0

Det maximala antalet resultat som ska returneras som en del av de växlingsade frågorna. Den här parametern definierar den övre gränsen för antalet returnerade resultat. Resultatet som returneras kan vara mindre än det angivna maximala resultatet om de inte får plats i meddelandet enligt de maximala storleksbegränsningarna för meddelanden som definierats i konfigurationen. Om den här parametern är noll eller inte anges innehåller den växlingsfråga så många resultat som möjligt som får plats i returmeddelandet.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) En lyckad åtgärd returnerar 200 statuskod och listan över distribuerad programinformation.
 PagedDeployedApplicationInfoList
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Begränsa maximalt resultat

Det här exemplet visar hur du anger antalet program som returneras av frågan när du hämtar information om program som distribueras på en specifik nod. Antalet resultat på en sida är begränsat till högst 2 med hjälp av parametern MaxResult. Hälsotillstånd begärs inte i det här exemplet, så det returnerade hälsotillståndet blir Okänt.

Förfrågan

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

200 Svar

Brödtext
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Sida med fortsättningstoken

Det här exemplet visar de växlingsfunktioner som är tillgängliga när du hämtar information om program som distribueras på en specifik nod. I det här exemplet används parametern ContinuationToken. Värdet för den här parametern anges från föregående fråga. i det här fallet exemplet som visas ovan. Svaret innehåller återstående resultat och en tom ContinuationToken. Den tomma ContinuationToken anger att ytterligare resultat inte är tillgängliga.

Förfrågan

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

200-svar

Brödtext
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Inkludera hälsotillstånd i resultatet

Det här exemplet visar hur du inkluderar hälsotillståndet för varje distribuerat program när du får information om program som distribueras på en specifik nod.

Förfrågan

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

200-svar

Brödtext
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}