Queries an execution in a flow. The long polling mode is supported. The maximum waiting period for long polling depends on the value of the WaitTimeSeconds parameter.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
FlowName | string | Yes | The name of the flow. The name is unique within the region and cannot be modified after the flow is created. Set this parameter based on the following rules:
| flow |
ExecutionName | string | Yes | The name of the execution, which is unique within a flow. Set this parameter based on the following rules:
| exec |
WaitTimeSeconds | integer | No | The maximum period of time for long polling waits. Valid values: 0 to 60. Unit: seconds. Configure this parameter based on the following rules:
| 20 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Status": "Succeeded",
"StoppedTime": "2019-01-01T01:01:01.001Z",
"RequestId": "testRequestId",
"StartedTime": "2019-01-01T01:01:01.001Z",
"FlowDefinition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
"Output": "{\"key\":\"value\"}",
"FlowName": "flow",
"Name": "exec",
"Input": "{\"key\":\"value\"}"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
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. | - |
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). |
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 doesn't belong to you. | - |
404 | ExecutionNotExists | Execution %s for flow %s does not exist. | Execution %s for flow %s does not exist. |
404 | FlowNotExists | Flow %s does not exist. | Flow %s does not exist. |
412 | PreconditionFailed | The resource to be modified has been changed. | The resource to be modified has been changed. Please try again later. |
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 | ||||||||||||||||||||
|