文档

GroupInvokeFlow - 批量运行工作流

更新时间:
一键部署

触发一个工作流多次执行。

接口说明

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

调试

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

调试

授权信息

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

请求参数

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

需要运行的工作流ID

lc-uf6axpwfcw4ubx
GroupKeystring

本次批量执行的分组名,不同执行分组之间不能重复

1632117849243
Datastring

该分组执行所需的数据,为JSON字符串,格式为:{"Items": []}。Items数组每一项为单次执行的参数。单次执行参数的编写方式和InvokeFlow的Data参数一致

{\"Items\":[{\"resourceId\":\"i-bp1383wskmaa65duviwh\",\"regionId\":\"cn-hangzhou\",\"resourceType\":\"ACS::ECS::Instance\"}],\"Source\":\"CloudConfig\"}
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符

abcdefghijklmn
TotalCountinteger

该组执行包含的执行数,需要和Data.Items数组中的个数一致

1
Tagsstring

为该分组下的每次执行打标签,格式为JSON数组,数组内为对应执行的标签对象。数组包含的标签对象个数需与TotalCount一致

[{\"key1\":\"value1\",\"key2\":\"value2\"}]

返回参数

名称类型描述示例值
object
Statusstring

本次分组执行的状态:

  • New:请求已经创建,待运行
  • Started:已经开始运行
  • Canceled:已经取消
  • Failed:执行失败
  • Completed:分组内所有执行已经完成
  • Unknown:执行状态不确定,常见于系统错误
  • TimedOut:执行超时
  • Paused:执行被暂停
Completed
GroupInvocationIdstring

本次运行的唯一标识符

7bdbdb58-f028-4155-915e-f21e1f8fc48a
RequestIdstring

请求ID

4F06F96E-D1F8-54ED-9611-4F621AD899B5
CurrentCountinteger

当前待运行的执行数

10
Successboolean

是否运行成功。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-11-21OpenAPI 描述信息更新
变更项变更内容
API 描述OpenAPI 描述信息更新
  • 本页导读 (0)
文档反馈