ListExecutions - 获取一个流程的历史执行_云工作流(CloudFlow)-阿里云帮助中心

获取一个流程的所有历史执行。

接口说明

当您删除流程后，即便后续创建了同名流程，系统将不再支持查询原流程所有的执行历史。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

fnf:ListExecutions

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
FlowName	string	是	流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。区分大小写。长度为 1~128 个字符。	my_flow_name
NextToken	string	否	执行查询开始名称，根据本接口返回获取。首次查询非必填。	flow_xxx
Limit	integer	否	查询数量。取值范围[1,100]，默认值为 60。	1
Status	string	否	需要过滤的执行状态。取值说明如下： Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StartedTimeBegin	string	否	筛选某个执行的起始时间后的所有执行，格式为 UTC RFC3339。	2020-12-02T02:39:20.402Z
StartedTimeEnd	string	否	筛选某个执行的起始时间前的所有执行，格式为 UTC RFC3339。	2020-12-02T02:23:54.817Z
ExecutionNamePrefix	string	否	执行的名称前缀。	run
MetadataOnly	boolean	否	是否只返回执行的元数据。为 true 时，返回值中不包括 Flow 定义、Input 和 Output，为 false 时会返回全部数据

返回参数

名称	类型	描述	示例值
	object	返回数据。
NextToken	string	下个查询起始 Key，如无其他数据则不返回。说明返回结果中，可能因为没有下一页内容不显示该参数。	397aba96-4d85-11ef-9c97-************
RequestId	string	请求 ID。	69AD2AA7-DB47-449B-941B-B14409DF****
Executions	array<object>	执行信息。
	object	执行信息。
Status	string	执行的状态。	Succeeded
StoppedTime	string	执行停止时间。	2019-01-01T01:01:01.001Z
StartedTime	string	执行开始时间。	2019-01-01T01:01:01.001Z
FlowDefinition	string	执行的流程定义。	旧版： "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	执行的输出，为 JSON 对象格式。	{"key":"value"}
FlowName	string	流程名称。	my_flow_name
Name	string	执行名称。	my_exec_name
Input	string	执行的输入，为 JSON 对象格式。	{"key":"value"}

示例

正常返回示例

JSON格式

{
  "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\"}"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
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.
412	PreconditionFailed	The resource to be modified has been changed.
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	FlowNotExists	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。