Appeler une commande d’infrastructure

Article
08/04/2023

Appelle une commande d’administration dans l’instance de service d’infrastructure donnée.

Pour les clusters pour lesquels une ou plusieurs instances du service d’infrastructure sont configurées, cette API permet d’envoyer des commandes propres à l’infrastructure vers une instance particulière du service d’infrastructure.

Les commandes disponibles et leurs formats de réponse correspondants varient en fonction de l’infrastructure sur laquelle le cluster s’exécute.

Cette API prend en charge la plateforme Service Fabric ; elle n’est pas censée être utilisée directement à partir de votre code.

Requête

Méthode	URI de demande
POST	`/$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`api-version`	string	Oui	Requête
`Command`	string	Oui	Requête
`ServiceId`	string	Non	Requête
`timeout`	entier (int64)	Non	Requête

`api-version`

Type : chaîne
Obligatoire : Oui
Par défaut : 6.0

Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 6.0 ».

La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Il s’agit de la dernière version prise en charge de l’API. Si une version d’API inférieure est transmise, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0, mais si le runtime est 6.1, afin de faciliter l’écriture des clients, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera en fonction de la version 6.0 documentée.

`Command`

Type : chaîne
Obligatoire : Oui

Texte de la commande à appeler. Le contenu de la commande dépend de l’infrastructure.

`ServiceId`

Type : chaîne
Obligatoire : Non

Identité du service d’infrastructure. Il s’agit du nom complet du service d’infrastructure sans le schéma d’URI « fabric: ». Ce paramètre est obligatoire uniquement pour les clusters pour lesquels plusieurs instances du service d’infrastructure s’exécutent.

`timeout`

Type : integer (int64)
Obligatoire : Non
Par défaut : 60
InclusiveMaximum : 4294967295
InclusiveMinimum : 1

Délai d’attente du serveur pour l’exécution de l’opération en secondes. Il spécifie la durée pendant laquelle le client attend la fin de l’opération demandée. La valeur par défaut de ce paramètre est de 60 secondes.

Réponses

Code d’état HTTP	Description	Schéma de réponse
200 (OK)	Réponse du service d’infrastructure. Le format de réponse est un flux JSON. Le contenu de la réponse dépend de la commande qui a été émise.	string
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via