RerunWorkflowInstances-阿里云帮助中心

Rerun a workflow instance

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:RerunWorkflowInstances

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The project ID.	123
EnvType	string	No	The environment of the workspace. Valid values: Prod Dev	Prod
WorkflowId	integer	Yes	The workflow ID.	123
Type	string	Yes	The type of the workflow instance. Valid values: ManualWorkflow.	ManualWorkflow
Name	string	No	The manual workflow name, used for fuzzy matching.	test
StartTriggerTime	integer	No	The start trigger time (creation time) of the manual workflow instance used for matching. This parameter must be used together with EndTriggerTime.	1710239005403
EndTriggerTime	integer	No	The end trigger time of the manual workflow instance used for matching. This parameter must be used together with the StartTriggerTime.	1710239005403
Bizdate	integer	No	The business date used for matching manual workflow instances.	1710239005403
Status	string	No	The status used for matching manual workflow instances. Valid values: Success Failure	Failure
Ids	array	No	The instance IDs used for matching manual workflow instances.
	integer	No	The manual workflow instance ID.	12345
Filter	object	No	The match conditions for internal instances of manual workflow instances.
RerunDownstreamEnabled	boolean	No	Specifies whether to rerun the matched instances and all downstream instances.	false
TaskIds	array	No	The internal task IDs used for matching manual workflow instances.
	integer	No	The internal task ID.	12345
TaskName	string	No	The internal task name used for matching the manual workflow instance.	test
TaskInstanceStatuses	array	No	The statuses of internal tasks used for matching manual workflow instances.
	string	No	The status of internal instances.	Failure
TaskTypes	array	No	Match internal tasks within the manual workflow by type.
	string	No	The type of the internal task. For possible values of TaskType, see DataWorks nodes.	ODPS_SQL

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Used for troubleshooting and log tracking.	22C97E95-F023-56B5-8852-B1A77A17XXXX
OperationId	string	The operation ID. You can use this value to query the creation result via the GetRerunWorkflowInstancesResult operation.	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx

Examples

Success response

JSON format

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.