GetExecutionHistory - 获取一次执行的步骤详情_云工作流(CloudFlow)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RequestId	string	否	请求 ID。如果您指定了该值，系统将使用该值作为本次请求的 ID；如果您不指定，系统将随机生成。	testRequestId
FlowName	string	是	流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。区分大小写。长度为 1~128 个字符。	my_flow_name
ExecutionName	string	是	执行名称，在同一流程内唯一。取值说明如下：支持英文字符（a~z）或（A~Z）、数字（0~9）、下划线（_）和短划线（-）。首字母必须为英文字母（a~z）、（A~Z）或下划线（_）。区分大小写。长度为 1~128 个字符。	my_exec_name
NextToken	string	否	Event 查询开始名称，根据本接口返回获取。	flow_xxx
Limit	integer	否	查询数量。取值范围[1,1000]。	1

返回参数

名称	类型	描述	示例值
	object	返回数据。
NextToken	string	首次查询非必填，该字段是以返回的 ScheduleEventId 作为下次查询的 Token；无数据时，该字段不返回。	3
RequestId	string	请求 ID。	testRequestId
Events	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	long	执行步骤 ID。	2
Time	string	事件更新时间。	2019-01-01T01:01:01.001Z
ScheduleEventId	long	调度步骤 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.	请求所需参数缺失。具体内容请参考实际错误信息。
403	AccessDenied	The resources doesn't belong to you.	-
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	AccessKey ID无效。
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.	您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。
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".	请求消息体类型错误。
500	InternalServerError	An internal error has occurred. Please retry.	服务器内部错误。请稍后重试。

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