Anropa infrastrukturkommando

Artikel
07/19/2023

Anropar ett administrativt kommando på den angivna infrastrukturtjänstinstansen.

För kluster som har en eller flera instanser av infrastrukturtjänsten konfigurerade tillhandahåller det här API:et ett sätt att skicka infrastrukturspecifika kommandon till en viss instans av infrastrukturtjänsten.

Tillgängliga kommandon och deras motsvarande svarsformat varierar beroende på vilken infrastruktur klustret körs på.

Det här API:et stöder Service Fabric-plattformen. Den är inte avsedd att användas direkt från koden.

Förfrågan

Metod	URI för förfrågan
POST	`/$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}`

Parametrar

Namn	Typ	Obligatorisk	Location
`api-version`	sträng	Ja	Söka i data
`Command`	sträng	Ja	Söka i data
`ServiceId`	sträng	No	Söka i data
`timeout`	heltal (int64)	No	Söka i data

`api-version`

Typ: sträng
Obligatoriskt: Ja
Standard: 6.0

Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.0".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, för att göra det enklare att skriva klienterna, accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.

`Command`

Typ: sträng
Obligatoriskt: Ja

Texten i kommandot som ska anropas. Innehållet i kommandot är infrastrukturspecifikt.

`ServiceId`

Typ: sträng
Obligatoriskt: Nej

Infrastrukturtjänstens identitet. Det här är det fullständiga namnet på infrastrukturtjänsten utan URI-schemat "fabric:". Den här parametern krävs endast för klustret som har fler än en instans av infrastrukturtjänsten som körs.

`timeout`

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

Svar

HTTP-statuskod	Description	Svarsschema
200 (OK)	Svaret från infrastrukturtjänsten. Svarsformatet är en JSON-ström. Innehållet i svaret beror på vilket kommando som utfärdades.	sträng
Alla andra statuskoder	Det detaljerade felsvaret.	FabricError

Share via