使用GroupInvokeFlow批量运行工作流-逻辑编排-阿里云-阿里云帮助中心

接口说明

该 API 适用于大批量执行工作流，如果执行频率不超过 100 次/秒，建议使用 InvokeFlow 触发工作流执行。
调用成功后，并不代表所有请求并发执行，逻辑编排会自动根据请求情况确定单次执行的开始执行时间。
该 API 每次调用认为是一次执行分组（Group），假设共需要执行工作流 1000 次，每 100 次为一个分组，那么就需要调用 10 次该 API，同时每次调用均需要传递一个唯一的 GroupKey 作为该组标识。一个分组内包含多个执行数据（Data 为 JSON 数组），每个执行数据对应一次执行（与调用一次 InvokeFlow 一致）。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

composer:GroupInvokeFlow

*Flow

acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}

无

请求参数

名称	类型	必填	描述	示例值
FlowId	string	是	需要运行的工作流 ID	lc-uf6axpwfcw4ubx
GroupKey	string	是	本次批量执行的分组名，不同执行分组之间不能重复	1632117849243
Data	string	是	该分组执行所需的数据，为 JSON 字符串，格式为：`{"Items": []}`。Items 数组每一项为单次执行的参数。单次执行参数的编写方式和 InvokeFlow 的 Data 参数一致	{\"Items\":[{\"resourceId\":\"i-bp1383wskmaa65duviwh\",\"regionId\":\"cn-hangzhou\",\"resourceType\":\"ACS::ECS::Instance\"}],\"Source\":\"CloudConfig\"}
ClientToken	string	是	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符	abcdefghijklmn
TotalCount	integer	是	该组执行包含的执行数，需要和 Data.Items 数组中的个数一致	1
Tags	string	否	为该分组下的每次执行打标签，格式为 JSON 数组，数组内为对应执行的标签对象。数组包含的标签对象个数需与 TotalCount 一致	[{\"key1\":\"value1\",\"key2\":\"value2\"}]

返回参数

名称	类型	描述	示例值
	object
Status	string	本次分组执行的状态： New：请求已经创建，待运行 Started：已经开始运行 Canceled：已经取消 Failed：执行失败 Completed：分组内所有执行已经完成 Unknown：执行状态不确定，常见于系统错误 TimedOut：执行超时 Paused：执行被暂停	Completed
GroupInvocationId	string	本次运行的唯一标识符	7bdbdb58-f028-4155-915e-f21e1f8fc48a
RequestId	string	请求 ID	4F06F96E-D1F8-54ED-9611-4F621AD899B5
CurrentCount	integer	当前待运行的执行数	10
Success	boolean	是否运行成功。 true：工作流已经被触发 false：触发失败说明如果需要查询工作流运行结果，请使用 GetInvocationLog 查询运行结果。	true

示例

正常返回示例

JSON格式

{
  "Status": "Completed",
  "GroupInvocationId": "7bdbdb58-f028-4155-915e-f21e1f8fc48a",
  "RequestId": "4F06F96E-D1F8-54ED-9611-4F621AD899B5",
  "CurrentCount": 10,
  "Success": true
}

错误码

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

变更历史

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