Získání seznamu informací o typu aplikace podle názvu

Získá seznam typů aplikací v clusteru Service Fabric, který přesně odpovídá zadanému názvu.

Vrátí informace o typech aplikací, které jsou zřízené nebo v procesu zřizování v clusteru Service Fabric. Tyto výsledky jsou typů aplikací, jejichž název přesně odpovídá názvu zadanému jako parametr a které odpovídají zadaným parametrům dotazu. Vrátí se všechny verze typu aplikace, které odpovídají názvu typu aplikace, přičemž každá verze 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

Parametry

applicationTypeName

Typ: string
Povinné: Ano

Název typu aplikace.

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.

ApplicationTypeVersion

Typ: string
Povinné: Ne

Verze 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