StartSyncExecution - CloudFlow - Alibaba Cloud Documentation Center

Synchronously starts a flow execution.

Operation description

This operation supports only flows in Express mode.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	Yes	The name of the flow to execute.	my_flow_name
ExecutionName	string	No	The name of the execution. The name must meet the following requirements: It can contain letters (a–z and A–Z), digits (0–9), underscores (_), and hyphens (-). It must start with a letter (a–z or A–Z) or an underscore (_). It is case-sensitive. It must be 1 to 128 characters in length. Unlike the StartExecution operation, the execution name for a synchronous call does not need to be unique within a flow. You can specify an execution name to identify the execution. The system appends a UUID to the name in the `{ExecutionName}:{UUID}` format. If you do not specify an execution name, the system automatically generates one.	my_exec_name
Input	string	No	The input of the execution. The input must be in JSON format.	{"key":"value"}
Qualifier	string	No	The version or alias of the flow.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	testRequestId
FlowName	string	The name of the flow.	my_flow_name
Name	string	The name of the flow execution.	my_exec_name:{UUID}
Status	string	The status of the execution. Valid values: Starting Running Stopped Succeeded Failed TimedOut	Succeeded
ErrorCode	string	The error code returned if the execution fails.	ActionNotSupported
ErrorMessage	string	The execution timed out.	Standard execution is not supported
Output	string	The output of the execution, which is a JSON object.	{"key":"value"}
StartedTime	string	The time when the execution started.	2019-01-01T01:01:01.001Z
StoppedTime	string	The time when the execution stopped.	2019-01-01T01:01:01.001Z
Environment	object	The environment variables used during the flow execution.
Variables	array<object>	A list of environment variables.
	object	The variables that are accessible during the execution of the flow.
Name	string	The name of the variable.	key
Value	string	The value of the variable.	value

Examples

Success response

JSON format

{
  "RequestId": "testRequestId",
  "FlowName": "my_flow_name",
  "Name": "my_exec_name:{UUID}",
  "Status": "Succeeded",
  "ErrorCode": "ActionNotSupported",
  "ErrorMessage": "Standard execution is not supported",
  "Output": "{\"key\":\"value\"}",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "Environment": {
    "Variables": [
      {
        "Name": "key",
        "Value": "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	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.
400	ActionNotSupported	The requested API operation %s is incorrect. Please check.	The requested API operation %s is incorrect. Please check.
400	APIVersionNotSupported	The requested API version %s is not supported yet. Please check.	The requested API version %s is not supported yet. Please check.
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 does not belong to you.	The request is denied due to the authority check failure.
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.