CreateFlow - CloudFlow - Centre de documentation Alibaba Cloud

Crée un flux.

Description de l'opération

Description

Le nombre de flux que chaque utilisateur peut créer est soumis à des limites de ressources. Pour plus d'informations, consultez Limites. Si vous avez des exigences particulières, soumettez un ticket pour demander un ajustement des limites.
Les flux sont identifiés de manière unique par leur nom au sein d'un compte. Par conséquent, vous ne pouvez pas créer plusieurs flux portant le même nom sous un seul compte.

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

create

*Flow

acs:fnf:{#regionId}:{#accountId}:flow/*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Name	string	Oui	Le nom du flux. Le nom doit être unique dans la même région et ne peut pas être modifié après la création du flux. Le nom doit répondre aux exigences suivantes : Il peut contenir des lettres (de a à z et de A à Z), des chiffres (de 0 à 9), des traits de soulignement (_) et des traits d'union (-). Il doit commencer par une lettre ou un trait de soulignement (_). Il est sensible à la casse. Il doit comporter entre 1 et 128 caractères.	my_flow_name
Definition	string	Oui	La définition du flux. Elle doit être conforme à la syntaxe du Flow Definition Language (FDL). Pour des raisons de compatibilité ascendante, le système prend en charge deux versions de la spécification de définition de flux. Remarque Dans les exemples de définitions de flux, Name: my_flow_name fait référence au nom du flux et doit être identique au paramètre d'entrée Name.	Ancienne version : " type: flow version: v1 name: my_flow_name steps: - type: pass name: mypass " Nouvelle version : " Type: StateMachine SpecVersion: v1 Name: my_flow_name StartAt: my_state States: - Type: Pass Name: my_state End: true "
Description	string	Oui	La description du flux.	mon flux de test
Type	string	Oui	Le type du flux. La valeur doit être FDL. Valeurs valides : FDL : Flow Definition Language.	FDL
RoleArn	string	Non	Le descripteur de ressource pour le rôle sur lequel le flux s'appuie pour son exécution. Lorsque le flux s'exécute, Serverless Workflow endosse ce rôle (AssumeRole) pour agir sur les ressources de flux associées.	acs:ram:${region}:${accountID}:${role}
ExternalStorageLocation	string	Non	L'emplacement de stockage externe.	/path
ExecutionMode	string	Non	Le mode d'exécution. Il s'agit d'un type d'énumération. Les valeurs valides sont Express et Standard. Pour des raisons de compatibilité ascendante, une chaîne vide est traitée comme le mode d'exécution Standard. Valeurs valides : Express : Le mode d'exécution express. Standard : Le mode d'exécution standard.	Standard
Environment	object	Non	Le contexte d'environnement auquel le flux peut accéder pendant l'exécution.
Variables	array<object>	Non	Une liste de variables d'environnement auxquelles le flux peut accéder pendant l'exécution.
	object	Non	Une liste de variables auxquelles le flux peut accéder pendant l'exécution.
Name	string	Non	Le nom de la variable.	key
Value	string	Non	La valeur de la variable.	value
Description	string	Non	La description de la variable.	description
ResourceGroupId	string	Non

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
Type	string	Le type du flux. Valeurs valides : FDL : Flow Definition Language.	FDL
Definition	string	La définition du flux. Pour des raisons de compatibilité ascendante, le système prend en charge deux versions de la spécification de définition de flux.	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"
RoleArn	string	Le descripteur de ressource pour le rôle sur lequel le flux s'appuie pour son exécution. Lorsque le flux s'exécute, Serverless Workflow endosse ce rôle (AssumeRole) pour agir sur les ressources de flux associées.	acs:ram:${region}:${accountID}:${role}
RequestId	string	L'identifiant de la requête. Serverless Workflow renvoie un identifiant de requête pour chaque requête qui reçoit un `code d'état HTTP`.	testRequestID
Description	string	La description du flux.	mon flux de test
Name	string	Le nom du flux.	my_flow_name
CreatedTime	string	L'heure de création du flux.	2019-01-01T01:01:01.001Z
LastModifiedTime	string	L'heure de la dernière modification du flux.	2019-01-01T01:01:01.001Z
Id	string	L'identifiant unique du flux.	e589e092-e2c0-4dee-b306-3574ddfdddf5****
ExecutionMode	string	Le mode d'exécution. Il s'agit d'un type d'énumération. Les valeurs valides sont Express et Standard. Pour des raisons de compatibilité ascendante, ce champ peut être une chaîne vide, qui est traitée comme le mode Standard.	Standard
Environment	object	Une liste de variables auxquelles le flux peut accéder pendant l'exécution.
Variables	array<object>	Une liste de variables auxquelles le flux peut accéder pendant l'exécution.
	object	Une liste de variables auxquelles le flux peut accéder pendant l'exécution.
Name	string	The variable name.	key
Value	string	The variable value.	value
Description	string	The variable description.	description
ResourceGroupId	string		rg-xxx

Exemples

JSON format

{
  "Type": "FDL",
  "Definition": "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\"",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}",
  "RequestId": "testRequestID",
  "Description": "my test flow",
  "Name": "my_flow_name",
  "CreatedTime": "2019-01-01T01:01:01.001Z",
  "LastModifiedTime": "2019-01-01T01:01:01.001Z",
  "Id": "e589e092-e2c0-4dee-b306-3574ddfdddf5****",
  "ExecutionMode": "Standard",
  "Environment": {
    "Variables": [
      {
        "Name": "key",
        "Value": "value",
        "Description": "description"
      }
    ]
  },
  "ResourceGroupId": "rg-xxx"
}

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	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.
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	FlowAlreadyExists	Flow %s already exists.	Flow %s already exists.

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

Notes de version

Consultez Notes de version pour la liste complète.