StopExecution - - Centre de documentation Alibaba Cloud

Arrête une exécution en cours dans un flux.

Description de l'opération

Notes d'utilisation

Le flux doit être en cours.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

fnf:StopExecution

update

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
FlowName	string	Oui	Le nom du flux de travail à arrêter. Vous pouvez appeler l'opération ListFlows pour obtenir la valeur de ce paramètre.	flow
ExecutionName	string	Oui	Le nom de l'exécution à arrêter. Vous pouvez appeler l'opération ListExecutions pour obtenir la valeur de ce paramètre.	exec
Cause	string	Non	La raison de l'arrêt de l'exécution. La valeur doit comporter de 1 à 4 096 caractères.	for test
Error	string	Non	Le code d'erreur pour l'arrêt de l'exécution. Le code d'erreur doit comporter de 1 à 128 caractères.	nill

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
Status	string	L'état de l'exécution. Valeurs valides : Starting Running Stopped Succeeded Failed TimedOut	Running
StoppedTime	string	L'heure à laquelle l'exécution s'est arrêtée.	2019-01-01T01:01:01.001Z
RequestId	string	L'identifiant de la requête.	testRequestId
StartedTime	string	L'heure à laquelle l'exécution a démarré.	2019-01-01T01:01:01.001Z
FlowDefinition	string	La définition du flux.	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
Output	string	Le résultat de l'exécution, au format JSON.	{"key":"value"}
FlowName	string	Le nom du flux.	flow
Name	string	Le nom de l'exécution.	exec
Input	string	L'entrée de l'exécution, au format JSON.	{"key":"value"}
RoleArn	string	Le nom de ressource Alibaba Cloud (ARN) du rôle qui a exécuté le flux. Si le RoleArn dans la définition du flux est modifié pendant l'exécution du flux, le système enregistre et renvoie un instantané du RoleArn d'origine. Remarque Si vous ne spécifiez pas le paramètre RoleArn dans les paramètres de la requête, les paramètres de la réponse ne contiennent pas le paramètre RoleArn.	acs:ram:${region}:${accountID}:${role}

Exemples

JSON format

{
  "Status": "Running",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "RequestId": "testRequestId",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "FlowDefinition": "Legacy version:\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass\"\n\nNew version:\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true\"",
  "Output": "{\"key\":\"value\"}",
  "FlowName": "my_flow_name",
  "Name": "my_exec_name",
  "Input": "{\"key\":\"value\"}",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ActionNotSupported	The requested API operation '%s' is incorrect. Please check.
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.
400	EntityTooLarge	The payload size exceeds maximum allowed size (%s bytes).	The payload size exceeds maximum allowed size (%s bytes).
400	ExecutionAlreadyCompleted	Execution '%s' for flow '%s' has already completed.
400	InvalidArgument	Parameter error.	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.	The HTTP query '%s' must be specified.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	The difference between the request time %s and the current time %s is too large.	The difference between the request time %s and the current time %s is too large.
403	SignatureNotMatch	The request signature we calculated does not match the signature you provided. Check your access key and signing method.	The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
404	ExecutionNotExists	Execution %s for flow %s does not exist.	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.	The request is throttled. Please try again later.
409	ConcurrentUpdateError	Update conflict, please retry.	Update conflict, please retry.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.