Richiamare il comando infrastruttura

Articolo
08/05/2023

Richiama un comando amministrativo sull'istanza del servizio di infrastruttura specificato.

Per i cluster che dispongono di una o più istanze del servizio di infrastruttura configurato, questo API fornisce un modo per inviare comandi specifici dell'infrastruttura a una particolare istanza del servizio di infrastruttura.

I comandi disponibili e i relativi formati di risposta corrispondente variano a seconda dell'infrastruttura in esecuzione sul cluster.

Questa API supporta la piattaforma Service Fabric. non deve essere utilizzata direttamente dal codice.

Richiesta

Metodo	URI richiesta
POST	`/$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}`

Parametri

Nome	Tipo	Necessario	Posizione
`api-version`	string	Sì	Query
`Command`	string	Sì	Query
`ServiceId`	string	No	Query
`timeout`	integer (int64)	No	Query

`api-version`

Tipo: stringa
Obbligatorio: Sì
Impostazione predefinita: 6.0

Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '6.0'.

La versione dell'API REST di Service Fabric è basata sulla versione di runtime in cui è stata introdotta o modificata l'API. Il runtime di Service Fabric supporta più versioni dell'API. Questa è la versione più recente supportata dell'API. Se viene passata una versione api inferiore, la risposta restituita può essere diversa da quella documentata in questa specifica.

Inoltre, il runtime accetta qualsiasi versione superiore alla versione supportata più recente fino alla versione corrente del runtime. Quindi, se la versione dell'API più recente è 6.0, ma se il runtime è 6.1, per semplificare la scrittura dei client, il runtime accetterà la versione 6.1 per tale API. Tuttavia, il comportamento dell'API sarà in base alla versione 6.0 documentata.

`Command`

Tipo: stringa
Obbligatorio: Sì

Il testo del comando da richiamare. Il contenuto del comando è specifico dell'infrastruttura.

`ServiceId`

Tipo: stringa
Obbligatorio: No

L'identità del servizio di infrastruttura. Questo è il nome completo del servizio infrastruttura senza lo schema URI 'fabric:'. Questo parametro è obbligatorio solo per il cluster con più di un'istanza del servizio di infrastruttura in esecuzione.

`timeout`

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata del tempo che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi.

Risposte

Codice di stato HTTP	Descrizione	Schema di risposta
200 (OK)	Risposta dal servizio infrastruttura. Il formato di risposta è un flusso JSON. Il contenuto della risposta dipende dal comando rilasciato.	string
Tutti gli altri codici di stato	Risposta dettagliata all'errore.	FabricError

Condividi tramite