文档

InvokeFlow - 运行工作流

更新时间:

运行一次工作流。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
composer:InvokeFlowRead
  • Flow
    acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}

请求参数

名称类型必填描述示例值
FlowIdstring

需要运行的工作流 ID

lc-uf65sg10vjws7o
Parametersstring

该模板所需要的参数,为 JSON 字符串。

{"ParamA": "test"}
Datastring

该工作流的触发器所需要的入参,为 JSON 字符串。

{"body": {"test": true}}
ClientTokenstring

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

abcdefghijklmn

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID

5CE7EAE6-XXXX-XXXX-A1A3-D3C2AE624000
Successboolean

是否运行成功。

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

本次运行的唯一标识符

6b387696-d160-4ed7-xxxx-070ac29dce4d

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-11-21OpenAPI 描述信息更新看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新