Získat seznam informací o službě
Získá informace o všech službách patřících do aplikace určené id aplikace.
Vrátí informace o všech službách patřících do aplikace určené id aplikace.
Žádost
Metoda | Identifikátor URI žádosti |
---|---|
GET | /Applications/{applicationId}/$/GetServices?ServiceTypeName={ServiceTypeName}&api-version=6.0&ContinuationToken={ContinuationToken}&timeout={timeout} |
Parametry
Název | Typ | Vyžadováno | Umístění |
---|---|---|---|
applicationId |
řetězec | Yes | Cesta |
ServiceTypeName |
řetězec | No | Dotaz |
api-version |
řetězec | Yes | Dotaz |
ContinuationToken |
řetězec | No | Dotaz |
timeout |
integer (int64) | No | Dotaz |
applicationId
Typ: řetězec
Povinné: Ano
Identita aplikace. Obvykle se jedná o úplný název aplikace bez schématu identifikátoru URI fabric:.
Od verze 6.0 jsou hierarchické názvy oddělené znakem ~.
Pokud je například název aplikace "fabric:/myapp/app1", identita aplikace bude ve verzi 6.0 nebo novější "myapp~app1" a v předchozích verzích "myapp/app1".
ServiceTypeName
Typ: řetězec
Povinné: Ne
Název typu služby použitý k filtrování služeb, na které se mají dotazovat.
api-version
Typ: řetězec
Povinné: Ano
Výchozí:6.0
Verze rozhraní API. Tento parametr je povinný a jeho hodnota musí být 6.0.
Verze rozhraní REST API Service Fabric 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 se předá nižší verze rozhraní API, může se vrácená odpověď 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.
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.
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 služeb v clusteru pro zadanou aplikaci |
PagedServiceInfoList |
Všechny ostatní stavové kódy | Podrobná chybová odpověď. |
Chyba infrastruktury |