Získat seznam informací o aplikaci

Získá seznam aplikací vytvořených v clusteru Service Fabric, které odpovídají zadaným filtrům.

Získá informace o aplikacích, které byly vytvořeny nebo v procesu vytváření v clusteru Service Fabric a odpovídají zadaným filtrům. Odpověď obsahuje název, typ, stav, parametry a další podrobnosti o aplikaci. Pokud se aplikace nevejdou na stránku, vrátí se jedna stránka výsledků a také token pokračování, který lze použít k získání další stránky. Filtry ApplicationTypeName a ApplicationDefinitionKindFilter nelze zadat současně.

Žádost

Parametry

api-version

Typ: string
Povinné: Ano
Výchozí:6.1

Verze rozhraní API Tento parametr je povinný a jeho hodnota musí být 6.1.

Verze rozhraní SERVICE Fabric REST API 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 je předána nižší verze rozhraní API, vrácená odpověď se může 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.

ApplicationDefinitionKindFilter

Typ: celé číslo
Povinné: Ne
Výchozí:0

Slouží k filtrování applicationDefinitionKind, což je mechanismus, který se používá k definování aplikace Service Fabric.

• Výchozí – výchozí hodnota, která provádí stejnou funkci jako při výběru možnosti Vše. Hodnota je 0.
• All – filtr, který odpovídá vstupu s libovolnou hodnotou ApplicationDefinitionKind. Hodnota je 65535.
• ServiceFabricApplicationDescription – filtr, který odpovídá vstupu s hodnotou ApplicationDefinitionKind ServiceFabricApplicationDescription. Hodnota je 1.
• Compose – filtr, který odpovídá vstupu s hodnotou ApplicationDefinitionKind Compose. Hodnota je 2.

ApplicationTypeName

Typ: string
Povinné: Ne

Název typu aplikace, který slouží k filtrování aplikací, na které se mají dotazovat. Tato hodnota by neměla obsahovat verzi typu aplikace.

ExcludeApplicationParameters

Typ: logická
Povinné: Ne
Výchozí:false

Příznak, který určuje, jestli budou parametry aplikace vyloučeny z výsledku.

ContinuationToken

Typ: string
Povinné: Ne

Parametr pokračovacího tokenu se používá k získání další sady výsledků. Token pokračování s neprázdnou hodnotou je součástí odpovědi rozhraní API, pokud se výsledky ze systému nevejdou do jedné odpovědi. Když se tato hodnota předá dalšímu volání rozhraní API, vrátí rozhraní API další sadu výsledků. Pokud nejsou k dispozici žádné další výsledky, znamená to, že pokračovací token neobsahuje hodnotu. Hodnota tohoto parametru by neměla být kódovaná adresa URL.

MaxResults

Typ: celé číslo (int64)
Povinné: Ne
Výchozí:0
InclusiveMinimum: 0

Maximální počet výsledků, které se mají vrátit jako součást stránkovaných dotazů. Tento parametr definuje horní mez počtu vrácených výsledků. Vrácené výsledky můžou být menší než zadané maximální výsledky, pokud se nevejdou do zprávy podle omezení maximální velikosti zprávy definované v konfiguraci. Pokud je tento parametr nula nebo není zadaný, stránkovaný dotaz obsahuje co nejvíce výsledků, které se vejdou do návratové zprávy.

timeout

Typ: celé číslo (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.

Odpovědi

Příklady

Omezit maximální počet výsledků

Tento příklad ukazuje, jak získat informace o aplikacích v clusteru. Počet výsledků na stránce je omezen na maximálně dva pomocí parametru MaxResult.

Žádost

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

Odpověď 200

Text

{
  "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"
    }
  ]
}

Stránka s využitím pokračovacího tokenu

Tento příklad ukazuje, jak procházet informace o aplikacích v clusteru pomocí parametru ContinuationToken. Hodnota tohoto parametru je zadaná z předchozího dotazu, v tomto případě z výše uvedeného příkladu. Odpověď obsahuje zbývající jeden výsledek a prázdný ContinuationToken. Prázdný token ContinuationToken označuje, že další výsledky nejsou k dispozici.

Žádost

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

Odpověď 200

Text

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