DescribeExecution - - Centre de documentation Alibaba Cloud

Consulte l'état d'une exécution. Cette opération prend en charge l'interrogation longue. Le paramètre WaitTimeSeconds spécifie le temps d'attente maximum.

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:DescribeExecution

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
FlowName	string	Oui	Le nom du flux.	my_flow_name
ExecutionName	string	Oui	Le nom de l'exécution.	my_exec_name
WaitTimeSeconds	integer	Non	Le temps d'attente maximum pour une requête d'interrogation longue, en secondes. Valeurs valides : 0 à 60. 0 : la requête renvoie immédiatement l'état actuel de l'exécution. Valeur supérieure à 0 : la requête attend sur le serveur que l'exécution se termine. Le temps d'attente maximum est la valeur que vous spécifiez.	20

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
Status	string	L'état de l'exécution. Valeurs valides : Starting Running Stopped Succeeded Failed TimedOut	Succeeded
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 exécuté.	Ancienne version : "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" Nouvelle version : "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true"
Output	string	La sortie de l'exécution, au format JSON.	{"key":"value"}
FlowName	string	Le nom du flux.	my_flow_name
Name	string	Le nom de l'exécution.	my_exec_name
Input	string	L'entrée de l'exécution, au format JSON.	{"key":"value"}
Environment	object	La liste des variables d'environnement utilisées lors de l'exécution du flux.
Variables	array<object>	La liste des variables d'environnement utilisées lors de l'exécution du flux.
	object	La liste des variables accessibles lors de l'exécution du flux.
Name	string	The name of the variable.	key
Value	string	The value of the variable.	value

Exemples

JSON format

{
  "Status": "Succeeded",
  "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\"}",
  "Environment": {
    "Variables": [
      {
        "Name": "key",
        "Value": "value"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
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.
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).
412	PreconditionFailed	The resource to be modified has been changed.	The resource to be modified has been changed. Please try again later.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.
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.
403	AccessDenied	The resources doesn't belong to you.
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.