StartSyncExecution - CloudFlow - Alibaba Cloud Documentation Center

Synchronously starts an execution in a flow.

Operation description

Only flows of the express execution mode are supported.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
fnf:StartSyncExecution	update	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	Yes	The name of the workflow to be executed.	my_flow_name
ExecutionName	string	No	The name of the execution that you want to start. The name must meet the following conventions: The name can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter or an underscore (_). The name is case-sensitive. The name must be 1 to 128 characters in length. Different from the StartExecution operation, in the synchronous execution mode, the execution name is no longer required to be unique within a flow. You can choose to provide an execution name to identify the current execution. In this case, the system adds a UUID to the current execution name. The used format is {ExecutionName}:{UUID}. If you do not specify the execution name, the system automatically generates an execution name.	my_exec_name
Input	string	No	The input of the execution, which is in the JSON format.	{"key":"value"}

Response parameters

Parameter	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 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 that is returned if the execution failed.	ActionNotSupported
ErrorMessage	string	The error message that indicates the execution timed out.	Standard execution is not supported
Output	string	The output of the execution, which is in the JSON format.	{"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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-21	The Error code has changed. The request parameters of the API has changed	View Change Details

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.
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.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.