ListExecutions - CloudFlow - Alibaba Cloud Documentation Center

Lists the execution history of a flow.

Operation description

Description

You cannot query the execution history of a flow after it is deleted, even if you create a new flow with the same name.

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:ListExecutions

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowName	string	Yes	The name of the flow. The name must be unique within the same region and cannot be changed after the flow is created. The name must meet the following requirements: Can contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). Must start with a letter (a-z or A-Z) or an underscore (_). Is case-sensitive. Must be 1 to 128 characters in length.	my_flow_name
NextToken	string	No	The token to start the query from. Obtain the token from the response of this operation. This parameter is not required for the first query.	flow_xxx
Limit	integer	No	The number of executions to query. The value must be in the range of [1, 100]. The default value is 60.	1
Status	string	No	The status of the executions to filter. Valid values: Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StartedTimeBegin	string	No	Filters for executions that started after this time. The time must be in the UTC RFC3339 format.	2020-12-02T02:39:20.402Z
StartedTimeEnd	string	No	Filters for executions that started before this time. The time must be in the UTC RFC3339 format.	2020-12-02T02:23:54.817Z
ExecutionNamePrefix	string	No	The prefix of the execution name.	run
MetadataOnly	boolean	No	Specifies whether to return only the metadata of the executions. If you set this to true, the response does not include the flow definition, input, or output. If you set this to false, the response includes all data.
Qualifier	string	No	The version or alias of the flow.	1
MapRunName	string	No	The name of the MapRun. When a MapRun is started in an execution, a MapRunStarted event is generated. You can get the MapRunName from the output of the MapRunStarted event. You can set MapRunName to filter child executions started by a specific MapRun in the current flow.	c39142f1345b196d678333c41f113100

Response elements

Element	Type	Description	Example
	object	The returned data.
NextToken	string	The token to start the next query. This parameter is not returned if no more data is available. Note This parameter might not appear in the response if there are no more results.	397aba96-4d85-11ef-9c97-************
RequestId	string	The request ID.	69AD2AA7-DB47-449B-941B-B14409DF****
Executions	array<object>	The execution information.
	array<object>	The execution information.
Status	string	The status of the execution.	Succeeded
StoppedTime	string	The time when the execution stopped.	2019-01-01T01:01:01.001Z
StartedTime	string	The time when the execution started.	2019-01-01T01:01:01.001Z
FlowDefinition	string	The definition of the executed flow.	旧版： "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" 新版： "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true"
Output	string	The output of the execution, in JSON object format.	{"key":"value"}
FlowName	string	The name of the flow.	my_flow_name
Name	string	The name of the execution.	my_exec_name
Input	string	The input of the execution, in JSON object format.	{"key":"value"}
Environment	object	The list of environment variables used during the flow execution.
Variables	array<object>	The list of environment variables used during the flow execution.
	object	The list of variables that can be accessed during the flow execution.
Name	string	The name of the variable.	key
Value	string	The value of the variable.	value

Examples

Success response

JSON format

{
  "NextToken": "397aba96-4d85-11ef-9c97-************",
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Executions": [
    {
      "Status": "Succeeded",
      "StoppedTime": "2019-01-01T01:01:01.001Z",
      "StartedTime": "2019-01-01T01:01:01.001Z",
      "FlowDefinition": "旧版：\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n  - type: pass\\n    name: mypass\"\n\n新版：\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n  - Type: Pass\\n    Name: my_state\\n    End: true\"",
      "Output": "{\"key\":\"value\"}",
      "FlowName": "my_flow_name",
      "Name": "my_exec_name",
      "Input": "{\"key\":\"value\"}",
      "Environment": {
        "Variables": [
          {
            "Name": "key",
            "Value": "value"
          }
        ]
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
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).
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.
412	PreconditionFailed	The resource to be modified has been changed.	The resource to be modified has been changed. Please try again later.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
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.
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.