Získání popisu služby

Získá popis existující služby Service Fabric.

Získá popis existující služby Service Fabric. Před získáním jejího popisu musí být vytvořena služba.

Žádost

Metoda Identifikátor URI žádosti
GET /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout}

Parametry

Název Typ Vyžadováno Umístění
serviceId řetězec Yes Cesta
api-version řetězec Ano Dotaz
timeout celé číslo (int64) No Dotaz

serviceId

Typ: string
Povinné: Ano

Identita služby. Toto ID je obvykle úplný název služby bez schématu identifikátoru URI fabric:. Od verze 6.0 jsou hierarchické názvy oddělené znakem "~". Pokud je například název služby "fabric:/myapp/app1/svc1", identita služby bude myapp~app1~svc1 ve verzi 6.0+ a myapp/app1/svc1 v předchozích verzích.


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.


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) Úspěšná operace vrátí stavový kód 200.
ServiceDescription
Všechny ostatní stavové kódy Podrobná odpověď na chybu.
Chyba infrastruktury