GetExecutionHistory - Query workflow execution step details - CloudFlow

Retrieves the details of each step in a specified execution.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fnf:GetExecutionHistory

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	Yes	The name of the workflow.	flow
ExecutionName	string	Yes	The name of the execution.	exec
NextToken	string	No	The event name from which to start the query. Obtain this value from the previous response.	flow_xxx
Limit	integer	No	The maximum number of events to return. Valid values: 1-999. Default value: 60.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	Not required for the first request. Use the ScheduleEventId value from the previous response as the token for subsequent queries. No value is returned for the last page.	3
RequestId	string	The request ID.	testRequestId
Events	array<object>	The events.
	object
Type	string	The type of the execution step. Valid values: StepEntered StepStarted StepSucceeded StepFailed StepExited BranchEntered BranchExited IterationEntered IterationExited TaskScheduled TaskStarted TaskSubmitted TaskSubmitFailed TaskSucceeded TaskFailed TaskTimedOut ExecutionStarted ExecutionStopped ExecutionSucceeded ExecutionFailed ExecutionTimedOut	TaskSucceeded
EventId	integer	The ID of the execution step.	2
Time	string	The time when the event was updated.	2019-01-01T01:01:01.001Z
ScheduleEventId	integer	The ID of the scheduling step.	1
EventDetail	string	The event details.	{}
StepName	string	The name of the execution step.	passStep

Examples

Success response

JSON format

{
  "NextToken": "3",
  "RequestId": "testRequestId",
  "Events": [
    {
      "Type": "TaskSucceeded",
      "EventId": 2,
      "Time": "2019-01-01T01:01:01.001Z",
      "ScheduleEventId": 1,
      "EventDetail": "{}",
      "StepName": "passStep"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
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).
400	InvalidArgument	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.
500	InternalServerError	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	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.
404	ExecutionNotExists	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.