GetExecutionHistory - 获取一次执行的步骤详情 - 云工作流

获取指定执行过程中的每个步骤详细信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

fnf:GetExecutionHistory

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
FlowName	string	是	流程名称。	my_flow_name
ExecutionName	string	是	执行名称。	my_exec_name
NextToken	string	否	Event 查询开始名称，根据本接口返回获取。	flow_xxx
Limit	integer	否	查询数量。取值范围[1,1000)，默认值为 60。	1

返回参数

名称	类型	描述	示例值
	object	返回数据。
NextToken	string	首次查询非必填，该字段是以返回的 ScheduleEventId 作为下次查询的 Token；无数据时，该字段不返回。	3
RequestId	string	请求 ID。	testRequestId
Events	array<object>	事件信息。
	object	事件信息。
Type	string	执行步骤类型。取值说明如下： StepEntered StepStarted StepSucceeded StepFailed StepExited BranchEntered BranchExited IterationEntered IterationExited TaskScheduled TaskStarted TaskSubmitted TaskSubmitFailed TaskSucceeded TaskFailed TaskTimedOut ExecutionStarted ExecutionStopped ExecutionSucceeded ExecutionFailed ExecutionTimedOut	TaskSucceeded
EventId	integer	执行步骤 ID。	2
Time	string	事件更新时间。	2019-01-01T01:01:01.001Z
ScheduleEventId	integer	调度步骤 ID。	1
EventDetail	string	执行步骤详情。	{}
StepName	string	执行步骤名称。	passStep

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

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