Starts a flow execution.
Description
- The flow must already exist.
- If you do not specify the execution name, the system automatically generates an execution name and starts the execution.
- If an execution of the same name is in progress, the system does not start a new execution but directly returns the execution of the same name.
- If the execution of the same name has ended (succeeded or failed), the ExecutionAlreadyExists error is returned.
- If no execution of the same name exists, a new execution is started.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | StartExecution |
The operation that you want to perform. Set the value to StartExecution. |
FlowName | String | Yes | flow |
The name of the flow you start to execute. |
RequestId | String | No | testRequestId |
The ID of the request. If you specify this parameter, the system uses its value as the request ID. By default, the system generates a random value. |
ExecutionName | String | No | exec |
The custom name of the execution. Ensure that the name is unique within the flow. |
Input | String | No | {} |
The input information of the execution. |
CallbackFnFTaskToken | String | No | 12 |
Calls back TaskToken-related tasks after the flow execution ends. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
FlowDefinition | String | version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass |
The definition of the flow. |
FlowName | String | flow |
The name of the flow. |
Input | String | empty string |
The input of the execution. |
Name | String | exec1 |
The name of the execution. |
Output | String | empty string |
The output of the execution. |
RequestId | String | testRequestId |
The ID of the request. |
StartedTime | String | 2019-01-01T01:01:01.001Z |
The time when the execution started. |
Status | String | empty string |
The status of the execution. |
StoppedTime | String | 2019-01-01T01:01:01.001Z |
The time when the execution stopped. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=StartExecution
&FlowName=flow
&<Common request parameters>
Sample success responses
XML
format
<CreateFlowResponseponse>
<Description>Response in XML format is not supported. </Description>
</CreateFlowResponseponse>
JSON
format
{
"Name": "exec1",
"FlowName": "flow",
"FlowDefinition": "version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass",
"Input": "",
"Output": "",
"Status": "",
"StartedTime": "2019-01-01T01:01:01.001Z",
"StoppedTime": "2019-01-01T01:01:01.001Z",
"RequestId": "testRequestId"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
403 | AccessDenied | The resources doesn't belong to you. | The error message returned because request authentication failed. For more information, see the actual error message. |
400 | ActionNotSupported | The requested API operation '%s' is incorrect. Please check. | The error message returned because the request method is wrong. For more information, see the API documentation and check the spelling. |
400 | APIVersionNotSupported | The requested API version '%s' is not supported yet. Please check. | The error message returned because the requested API version is wrong. For more information, see Make API requests. |
400 | EntityTooLarge | The payload size exceeds maximum allowed size (%s bytes). | The error message returned because the request message body is too large. |
400 | ExecutionAlreadyExists | Execution %s for flow %s already exists. | The error message returned because an execution of the same name already exists in the corresponding flow. |
404 | FlowNotExists | Flow %s does not exist. | The error message returned because the requested resource does not exist. Ensure that the flow has been created. |
500 | InternalServerError | An internal error has occurred. Please retry. | The error message returned because an internal server error has occurred. Try again later. |
403 | InvalidAccessKeyID | The AccessKey ID %s is invalid. | The error message returned because the AccessKey ID is invalid. |
400 | InvalidArgument | Parameter error. | The error message returned because the request parameters are invalid. For more information, see the actual error message. |
400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | The error message returned because the required request parameters are missing. For more information, see the actual error message. |
400 | MissingRequiredParams | The HTTP query '%s' must be specified. | The error message returned because the required request parameters are missing. For more information, see the actual error message. |
403 | RequestTimeTooSkewed | The difference between the request time %s and the current time %s is too large. | The error message returned because your request time is wrong. The request has been identified as invalid. For more information, see the "Common parameters" section. |
429 | ResourceThrottled | The request is throttled. Please try again later. | The error message returned because the request is throttled for some reason. Try again later. |
403 | SignatureNotMatch | The request signature we calculated does not match the signature you provided. Check your access key and signing method. | The error message returned because the request signature we calculated does not match the request signature you provided. Check your signature algorithm and AccessKey secret. |
415 | UnsupportedMediaType | The content type must be "application/json". | The error message returned because the type of the request message body is wrong. |
For a list of error codes, visit the API Error Center.
For a list of error codes, visit the API Error Center.