GroupInvokeFlow - Logic Composer - Alibaba Cloud Documentation Center

Executes a workflow multiple times.

Operation description

You can call this operation to trigger a workflow to be executed more than 100 times per second. If the desired execution frequency does not exceed 100 times per second, we recommend that you call the InvokeFlow operation.
However, you may need to call the GroupInvokeFlow operation multiple times. For example, assume that you want a workflow to be executed 1,000 times per second and the 1,000 times of execution are divided into ten groups. You need to call the operation ten times for the ten groups and specify a group key for each group.
Each call corresponds to a group execution. Logic Composer automatically determines when a group execution starts. You must set the Data parameter to a JSON array of strings to specify the information required by the execution. Each string provides the information required by one time of execution. The string must use the format of the Data parameter in the InvokeFlow operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
FlowId	string	Yes	The ID of the workflow that you want to execute.	lc-uf6axpwfcw4ubx
GroupKey	string	Yes	The name of the group. The name must be unique among the groups.	1632117849243
Data	string	Yes	The information required by the group execution. Set this parameter to a JSON array of strings in the following format:`{"Items": []}`. Each string provides the information required by one time of execution. The string must use the format of the Data parameter in the InvokeFlow operation.	{\"Items\":[{\"resourceId\":\"i-bp1383wskmaa65duviwh\",\"regionId\":\"cn-hangzhou\",\"resourceType\":\"ACS::ECS::Instance\"}],\"Source\":\"CloudConfig\"}
ClientToken	string	Yes	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.	abcdefghijklmn
TotalCount	integer	Yes	The number of times of execution. The value must be the same as the number of strings in the value of the Data parameter.	1
Tags	string	No	The tag that is attached to each time of execution. The value is a JSON array. The number of tags in the array is the same as the value of the TotalCount parameter.	[{\"key1\":\"value1\",\"key2\":\"value2\"}]

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of the group. Valid values: New: The group is created and waiting to be executed. Started: The group is being executed. Canceled: The group was canceled. Failed: The execution failed. Completed: All the times of execution in the group are complete. Unknown: The group status is uncertain. In this case, a system error may occur. TimedOut: The execution timed out. Paused: The execution was suspended.	Completed
GroupInvocationId	string	The unique identifier of the execution.	7bdbdb58-f028-4155-915e-f21e1f8fc48a
RequestId	string	The ID of the request.	4F06F96E-D1F8-54ED-9611-4F621AD899B5
CurrentCount	integer	The number of times of execution that are pending.	10
Success	boolean	Indicates whether the operation was successful. true: The workflow execution is triggered. false: The workflow execution failed to be triggered. Note : You can call the GetInvocationLog operation to check whether the workflow execution is successful.	true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-11-21

API Description Update

see changesets

Change item	Change content
API Description	API Description Update.