Start a flow execution by calling StartExecution - CloudFlow - Alibaba Cloud - CloudFlow

Starts the execution of a flow.

Operation description

The flow must already exist. Currently, only flows in Standard execution mode are supported.
If no execution name is specified, the service automatically generates an execution name and starts the execution.
If an execution with the same name is in progress, a new execution is not started, and the in-progress execution with the same name is returned.
If an execution with the same name has already ended (succeeded or failed), ExecutionAlreadyExists is returned.
If no execution with the same name exists, a new execution is started.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fnf:StartExecution

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	Yes	The name of the flow to be executed.	my_flow_name
ExecutionName	string	No	The name of the execution. The name must be unique within the same flow. Valid values: The first character must be a letter (a to z or A to Z) or an underscore (_). The name can contain letters (a to z or A to Z), digits (0 to 9), underscores (_), and hyphens (-). The name is case-sensitive. The name must be 1 to 128 characters in length.	my_exec_name
Input	string	No	The input of the execution, in JSON object format.	{"key":"value"}
CallbackFnFTaskToken	string	No	The TaskToken used to call back the related task after the flow execution ends.	12
Qualifier	string	No	The version or alias of the flow.	1

Response elements

Element	Type	Description	Example
	object	The returned data.
Status	string	The execution status. Valid values: Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StoppedTime	string	The time when the execution was stopped. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss.sssZ format.	2019-01-01T01:01:01.001Z
RequestId	string	The ID of the request.	testRequestId
StartedTime	string	The time when the execution was started. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss.sssZ format.	2019-01-01T01:01:01.001Z
FlowDefinition	string	The flow definition of the execution.	Legacy: "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" New 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	The output of the execution, in JSON object format.	{"key":"value"}
FlowName	string	The name of the flow.	my_flow_name
Name	string	The name of the execution.	my_exec_name
Input	string	The input of the execution, in JSON object format.	{"key":"value"}

Examples

Success response

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\"}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	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	ExecutionAlreadyExists	Execution %s for flow %s already exists.	Execution %s for flow %s already exists.
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	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.