Synchronously starts an execution in a flow.
Operation description
- Only flows of the express execution mode are supported.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
FlowName | string | Yes | The name of the flow in which you want to start the execution. The name is unique within the same region and cannot be modified after the flow is created. Set this parameter based on the following rules:
| my_flow_name |
ExecutionName | string | No | The name of the execution that you want to start. The name must meet the following conventions:
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
Examples
Sample success responses
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"
}
Error codes
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. |
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 | see changesets | ||||||||||||||||||
|