ListExecutions - CloudFlow - Alibaba Cloud Documentation Center

Queries all historical executions of a flow.

Operation description

Usage notes

After you delete a flow, you cannot query its historical executions, even if you create a flow of the same name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 must be unique within the region and cannot be modified after the flow is created. The name must meet the following conventions: The name can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter or an underscore (_). The name is case-sensitive. The name must be 1 to 128 characters in length.	flow
NextToken	string	No	The name of the execution to start the query. You can obtain the value from the response data. You do not need to specify this parameter for the first request.	flow_xxx
Limit	integer	No	The maximum number of executions to be queried. Valid values: 1 to 100.	1
Status	string	No	The status of the execution that you want to filter. Valid values: Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StartedTimeBegin	string	No	The beginning of the time range to query executions. Specify the value in the UTC RFC3339 format.	2020-12-02T02:39:20.402Z
StartedTimeEnd	string	No	The end of the time range to query executions. Specify the value in the UTC RFC3339 format.	2020-12-02T02:23:54.817Z
ExecutionNamePrefix	string	No	The name prefix of the execution.	run

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The start key for the next query. This parameter is not returned if all results have been returned.	exec2
RequestId	string	The request ID.	testRequestId
Executions	object []	The information about executions.
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 flow.	version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
Output	string	The output of the execution, which is in the JSON format	{"key":"value"}
FlowName	string	The name of the flow.	flow
Name	string	The name of the execution.	exec
Input	string	The input of the execution, which is in the JSON format.	{"key":"value"}

Examples

Sample success responses

JSONformat

{
  "NextToken": "exec2",
  "RequestId": "testRequestId",
  "Executions": [
    {
      "Status": "Succeeded",
      "StoppedTime": "2019-01-01T01:01:01.001Z",
      "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

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

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 412
	delete Error Codes: 415
	delete Error Codes: 429
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: RequestId

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.
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.
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.