调用InvokeFlow运行一个编排实例中的工作流。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String InvokeFlow

系统规定参数。取值:InvokeFlow

Data String {"body": {"test": true}}

该编排实例工作流的触发器所需要的入参,需要JSON Stringify。

FlowId String lc-abcdefg

需要运行的工作流编排实例的ID

Parameters String {"ParamA": "test"}

该模板所需要的参数,需要JSON Stringify。

ClientToken String abcdefghijklmn

用于幂等,避免重复运行。

返回数据

名称 类型 示例值 描述
InvocationId String 6b387696-d160-4ed7-xxxx-070ac29dce4d

本次运行的唯一标识符

RequestId String 5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000

本次请求的ID

Success Boolean true

是否运行成功。

  • true:工作流已经被触发
  • false:触发失败
说明 如果需要查询工作流运行结果,请使用GetInvocationLog查询运行结果。

示例

请求示例


http(s)://[Endpoint]/?Action=InvokeFlow
&Data={"body": {"test": true}}
&FlowId=lc-abcdefg
&Parameters={"ParamA": "test"}
&<公共请求参数>

正常返回示例

XML 格式

<InvokeFlowResponse>
      <InvocationId>6b387696-d160-4ed7-xxxx-070ac29dce4d</InvocationId>
      <RequestId>5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000</RequestId>
      <Success>true</Success>
</InvokeFlowResponse>

JSON 格式

{
	"InvocationId":"6b387696-d160-4ed7-xxxx-070ac29dce4d",
	"RequestId":"5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000",
	"Success":true
}

错误码

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