全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Feb 13, 2025

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    FlowNamestring是

    流程名称。

    		my_flow_name
    ExecutionNamestring是

    执行名称。

    		my_exec_name
    NextTokenstring否

    Event 查询开始名称，根据本接口返回获取。

    		flow_xxx
    Limitinteger否

    查询数量。取值范围[1,1000)，默认值为 60。

    		1

    返回参数

    名称类型描述示例值
    object

    返回数据。

    NextTokenstring

    首次查询非必填，该字段是以返回的 ScheduleEventId 作为下次查询的 Token；无数据时，该字段不返回。

    		3
    RequestIdstring

    请求 ID。

    		testRequestId
    Eventsarray<object>

    事件信息。

    Eventsobject

    事件信息。

    Typestring

    执行步骤类型。取值说明如下：

    • StepEntered
    • StepStarted
    • StepSucceeded
    • StepFailed
    • StepExited
    • BranchEntered
    • BranchExited
    • IterationEntered
    • IterationExited
    • TaskScheduled
    • TaskStarted
    • TaskSubmitted
    • TaskSubmitFailed
    • TaskSucceeded
    • TaskFailed
    • TaskTimedOut
    • ExecutionStarted
    • ExecutionStopped
    • ExecutionSucceeded
    • ExecutionFailed
    • ExecutionTimedOut
    		TaskSucceeded
    EventIdlong

    执行步骤 ID。

    		2
    Timestring

    事件更新时间。

    		2019-01-01T01:01:01.001Z
    ScheduleEventIdlong

    调度步骤 ID。

    		1
    EventDetailstring

    执行步骤详情。

    		{}
    StepNamestring

    执行步骤名称。

    		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错误码错误信息描述
    400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
    400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
    400EntityTooLargeThe payload size exceeds maximum allowed size (%s bytes).请求消息体过大。
    400InvalidArgumentParameter error.请求参数错误。具体内容请参考实际错误信息。
    400MissingRequiredHeaderThe HTTP header '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
    400MissingRequiredParamsThe HTTP query '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
    403AccessDeniedThe resources doesn't belong to you.-
    403InvalidAccessKeyIDThe AccessKey ID %s is invalid.AccessKey ID无效。
    403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。
    403SignatureNotMatchThe request signature we calculated does not match the signature you provided. Check your access key and signing method.您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。
    404ExecutionNotExistsExecution %s for flow %s does not exist.所请求资源不存在，请确保流程已创建并存在待查询的执行。
    404FlowNotExistsFlow %s does not exist.所请求资源不存在，请确保流程已创建。
    415UnsupportedMediaTypeThe content type must be "application/json".请求消息体类型错误。
    500InternalServerErrorAn internal error has occurred. Please retry.服务器内部错误。请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    2024-03-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情