Sdílet prostřednictvím

Příkaz Vyvolat infrastrukturu

  • Článek

Vyvolá příkaz pro správu v dané instanci služby infrastruktury.

Pro clustery, které mají nakonfigurovanou jednu nebo více instancí služby infrastruktury, poskytuje toto rozhraní API způsob, jak odesílat příkazy specifické pro infrastrukturu do konkrétní instance služby infrastruktury.

Dostupné příkazy a jejich odpovídající formáty odpovědí se liší v závislosti na infrastruktuře, na které je cluster spuštěný.

Toto rozhraní API podporuje platformu Service Fabric. není určená k použití přímo z vašeho kódu.

Žádost

Metoda Identifikátor URI žádosti
POST /$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}

Parametry

Název Typ Vyžadováno Umístění
api-version řetězec Ano Dotaz
Command řetězec Ano Dotaz
ServiceId řetězec No Dotaz
timeout celé číslo (int64) No 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.

Command

Typ: string
Povinné: Ano

Text příkazu, který se má vyvolat. Obsah příkazu je specifický pro infrastrukturu.

ServiceId

Typ: string
Povinné: Ne

Identita služby infrastruktury. Toto je úplný název služby infrastruktury bez schématu identifikátoru URI fabric:. Tento parametr se vyžaduje pouze pro cluster, ve kterém je spuštěno více než jedna instance služby infrastruktury.

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) Odpověď ze služby infrastruktury. Formát odpovědi je datový proud JSON.
Obsah odpovědi závisí na tom, který příkaz byl vydán.
 řetězec
Všechny ostatní stavové kódy Podrobná odpověď na chybu.
 Chyba infrastruktury