Sdílet prostřednictvím

Získat seznam informací o typu aplikace

  • Článek

Získá seznam typů aplikací v clusteru Service Fabric.

Vrátí informace o typech aplikací, které jsou zřízené nebo v procesu zřizování v clusteru Service Fabric. Každá verze typu aplikace se vrátí jako jeden typ aplikace. Odpověď obsahuje název, verzi, stav a další podrobnosti o typu aplikace. Jedná se o stránkovaný dotaz, což znamená, že pokud se na stránku nevejdou všechny typy aplikací, 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. Pokud je například 10 typů aplikací, ale stránka odpovídá pouze prvním třem typům aplikace, nebo pokud je maximální počet výsledků nastaven na 3, vrátí se tři. Pokud chcete získat přístup ke zbytku výsledků, načtěte následující stránky pomocí vráceného tokenu pokračování v dalším dotazu. Pokud neexistují žádné další stránky, vrátí se prázdný token pokračování.

Žádost

Metoda Identifikátor URI žádosti
GET /ApplicationTypes?api-version=6.0&ApplicationTypeDefinitionKindFilter={ApplicationTypeDefinitionKindFilter}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametry

Název Typ Vyžadováno Umístění
api-version řetězec Yes Dotaz
ApplicationTypeDefinitionKindFilter integer Ne Dotaz
ExcludeApplicationParameters boolean Ne Dotaz
ContinuationToken řetězec No Dotaz
MaxResults celé číslo (int64) Ne Dotaz
timeout celé číslo (int64) Ne Dotaz

api-version

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

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

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.

ApplicationTypeDefinitionKindFilter

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

Používá se k filtrování applicationTypeDefinitionKind, což je mechanismus, který se používá k definování typu 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 ApplicationTypeDefinitionKind. Hodnota je 65535.
  • ServiceFabricApplicationPackage – filtr, který odpovídá vstupu s hodnotou ApplicationTypeDefinitionKind ServiceFabricApplicationPackage. Hodnota je 1.
  • Compose – filtr, který odpovídá vstupu s hodnotou ApplicationTypeDefinitionKind Compose. Hodnota je 2.

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

Stavový kód HTTP Description Schéma odpovědi
200 (OK) Seznam typů aplikací v clusteru
 PagedApplicationTypeInfoList
Všechny ostatní stavové kódy Podrobná odpověď na chybu.
 Chyba infrastruktury

Příklady

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

Tento příklad ukazuje, jak získat informace o typech aplikací, které se zřizují nebo zřizují v clusteru. Počet výsledků na stránce je omezen na maximálně pět pomocí parametru MaxResult.

Žádost

GET http://localhost:19080/ApplicationTypes?api-version=6.0&MaxResults=5

Odpověď 200

Text
{
  "ContinuationToken": "PersistentQueueApp+2.0",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "GatewayPort",
          "Value": "8505"
        },
        {
          "Key": "ServiceInstanceCount",
          "Value": "1000"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

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

Tento příklad ukazuje, jak procházet informace o typech aplikací, které jsou zřízené nebo zřízené 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í dva výsledky a prázdný ContinuationToken. Prázdný token ContinuationToken označuje, že další výsledky nejsou k dispozici.

Žádost

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

Odpověď 200

Text
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Vyloučení parametrů aplikace z výsledku

Tento příklad ukazuje, jak ve výsledku vyloučit parametr aplikace při získávání informací o typech aplikací, které jsou zřízené nebo zřízené v clusteru.

Žádost

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ExcludeApplicationParameters=True

Odpověď 200

Text
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    }
  ]
}