Dela via

Hämta programinformationslista

  • Artikel

Hämtar listan över program som skapats i Service Fabric-klustret som matchar de angivna filtren.

Hämtar information om de program som har skapats eller håller på att skapas i Service Fabric-klustret och matchar de angivna filtren. Svaret innehåller namn, typ, status, parametrar och annan information om programmet. Om programmen inte får plats på en sida returneras en sida med resultat samt en fortsättningstoken som kan användas för att hämta nästa sida. Filter ApplicationTypeName och ApplicationDefinitionKindFilter kan inte anges samtidigt.

Förfrågan

Metod URI för förfrågan
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametrar

Namn Typ Obligatorisk Location
api-version sträng Ja Söka i data
ApplicationDefinitionKindFilter heltal No Söka i data
ApplicationTypeName sträng No Söka i data
ExcludeApplicationParameters boolean No Söka i data
ContinuationToken sträng No Söka i data
MaxResults heltal (int64) No Söka i data
timeout heltal (int64) No Söka i data

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.

ApplicationDefinitionKindFilter

Typ: heltal
Krävs: Nej
Standard: 0

Används för att filtrera på ApplicationDefinitionKind, vilket är den mekanism som används för att definiera ett Service Fabric-program.

  • Standard – Standardvärde, som utför samma funktion som att välja "Alla". Värdet är 0.
  • Alla – Filter som matchar indata med valfritt ApplicationDefinitionKind-värde. Värdet är 65535.
  • ServiceFabricApplicationDescription – filter som matchar indata med ApplicationDefinitionKind-värdet ServiceFabricApplicationDescription. Värdet är 1.
  • Compose – Filter som matchar indata med ApplicationDefinitionKind-värdet Compose. Värdet är 2.

ApplicationTypeName

Typ: sträng
Krävs: Nej

Namnet på programtypen som används för att filtrera de program som ska frågas efter. Det här värdet får inte innehålla programtypsversionen.

ExcludeApplicationParameters

Typ: booleskt värde
Krävs: Nej
Standard: false

Flaggan som anger om programparametrar ska undantas från resultatet.

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.

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.

Svar

HTTP-statuskod Description Svarsschema
200 (OK) Lista över program som skapats i klustret.
 PagedApplicationInfoList
Alla andra statuskoder Det detaljerade felsvaret.
 FabricError

Exempel

Begränsa maximalt resultat

Det här exemplet visar hur du hämtar information om program i klustret. Antalet resultat på en sida är begränsat till högst två med hjälp av parametern MaxResult.

Förfrågan

GET http://localhost:19080/Applications?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",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

Sida med fortsättningstoken

Det här exemplet visar hur du bläddrar igenom informationen om program i klustret med 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 det återstående resultatet och ett tomt ContinuationToken. Den tomma ContinuationToken anger att ytterligare resultat inte är tillgängliga.

Förfrågan

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

200 Svar

Brödtext
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}