Získání seznamu stavu nasazení sestavení

  • Článek

Získá seznam vytvořených nasazení vytvořených v clusteru Service Fabric.

Získá stav vytváření nasazení, které byly vytvořeny nebo v procesu vytváření v clusteru Service Fabric. Odpověď obsahuje název, stav a další podrobnosti o vytváření nasazení. Pokud se seznam nasazení nevejde na stránku, vrátí se jedna stránka výsledků a token pro pokračování, který lze použít k získání další stránky.

Žádost

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

Parametry

Název Typ Vyžadováno Umístění
api-version řetězec Ano Dotaz
ContinuationToken řetězec No Dotaz
MaxResults integer (int64) No Dotaz
timeout integer (int64) No Dotaz

api-version

Typ: řetězec
Povinné: Ano
Výchozí:6.0-preview

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

ContinuationToken

Typ: řetězec
Povinné: Ne

Parametr tokenu pokračování se používá k získání další sady výsledků. Pokračovací token s neprázdnou hodnotou se zahrne do odpovědi rozhraní API v případech, kdy 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 zakódovaná adresa URL.

MaxResults

Typ: integer (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 nulový nebo není zadaný, stránkovaný dotaz obsahuje co nejvíce výsledků, které se vejdou do návratové zprávy.

timeout

Typ: integer (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 stavu vytváření nasazení v clusteru
 PagedComposeDeploymentStatusInfoList
Všechny ostatní stavové kódy Podrobná chybová odpověď.
 Chyba infrastruktury