Queries detailed information of an execution. This operation supports the long polling mode to help callers obtain the result of an execution in a timely manner. You can specify the WaitTimeSeconds parameter to set the maximum timeout period for long polling.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeExecution

The operation that you want to perform. Set the value to DescribeExecution.

ExecutionName String Yes exec

The name of the execution.

FlowName String Yes flow

The name of the flow.

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.

WaitTimeSeconds Integer No 20

The maximum timeout period of long polling for this request. Valid values: 0 to 60. WaitTimeSeconds=0 indicates that the server returns the current execution status immediately. WaitTimeSeconds>0 indicates that the server waits until the execution ends to return a response. The server must wait for at most WaitTimeSeconds seconds.

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 {"key":"value"}

The input of the execution.

Name String exec

The name of the execution.

Output 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 Succeeded

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=DescribeExecution
&ExecutionName=exec
&FlowName=flow
&<Common request parameters>

Sample success responses

XML format

<CreateFlowResponseponse>
    <Description>Response in XML format is not supported. </Description>
</CreateFlowResponseponse>

JSON format

{
    "Name": "exec",
    "FlowName": "flow",
    "FlowDefinition": "version: v1.0\ntype: flow\nname: test\nsteps:\n  - type: pass\n    name: mypass",
    "Input": "",
    "Output": "",
    "Status": "Succeeded",
    "StartedTime": "2019-01-01T01:01:01.001Z",
    "StoppedTime": "2019-01-01T01:01:01.001Z",
    "RequestId": "testRequestId"
}

Error codes

HttpCode Error code Error message Description
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.
412 PreconditionFailed The resource to be modified has been changed. The error message returned because resource view or check for updates failed, and the resource may be modified. Try again later.
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.
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.
404 ExecutionNotExists Execution %s for flow %s does not exist. The error message returned because the requested resource does not exist. Ensure that the flow has been created and the executions to be queried exist.
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.

For a list of error codes, visit the API Error Center.