Annuler l’opération

Article
07/19/2023

Annule une opération d’erreur induite par l’utilisateur.

Les API suivantes démarrent des opérations d’erreurs qui peuvent être annulées à l’aide de la commande CancelOperation : StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.

Si force est défini sur false, l’opération induite par l’utilisateur spécifiée est correctement arrêtée et nettoyée. Si force est défini sur true, la commande va être abandonnée et un état interne peut éventuellement être conservé. La définition de force sur true doit être utilisée avec précaution. Vous n’êtes pas autorisé à appeler cette API avec force défini sur true tant que cette API n’a pas encore été appelée sur la même commande de test avec force défini sur false, ou sauf si la commande de test a déjà un OperationState OperationState.RollingBack. Clarification : OperationState.RollingBack signifie que le système nettoiera/nettoie l’état du système interne généré par l’exécution de la commande. Cela ne restaurera pas les données si la commande de test engendre une perte de données. Par exemple, si vous appelez StartDataLoss, puis cette API, le système nettoiera seulement l’état interne lié à l’exécution de la commande. Il ne restaurera pas les données de la partition cible si la commande a progressé suffisamment pour entraîner une perte de données.

Remarque importante : si cette API est appelée avec force==true, l’état interne peut être conservé.

Requête

Méthode	URI de demande
POST	`/Faults/$/Cancel?api-version=6.0&OperationId={OperationId}&Force={Force}&timeout={timeout}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`api-version`	string	Oui	Requête
`OperationId`	string (uuid)	Oui	Requête
`Force`	boolean	Oui	Requête
`timeout`	integer (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 inférieure de l’API est passée, 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 que 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 conformément à la version 6.0 documentée.

`OperationId`

Type : chaîne (uuid)
Obligatoire : Oui

GUID qui identifie un appel de cette API. Cette opération est passée à l’API GetProgress correspondante

`Force`

Type : booléen
Obligatoire : Oui
Par défaut : false

Indique s’il faut restaurer et nettoyer l’état du système interne modifié par l’exécution de l’opération induite par l’utilisateur.

`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)	Une opération réussie retourne 200 status code.
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via