Execute a Task

Use this API to execute a specified workflow task.

Request URL: /openapi/v1/workflow/execute

HTTP method: POST

Request parameters

Parameter	Type	Required	Description	Example
workflowId	String	Yes	Task ID.	ex-dd47653n757w
bizData	Object	Yes	Task execution parameters. The required fields depend on the workflow type. For details, see bizData parameters (SQL task) or bizData parameters (data export).	N/A

bizData parameters (SQL task)

Parameter	Type	Required	Description	Example
executeType	String	Yes	Execution type: immediately: Execute immediately. schedule: Execute on a schedule.	immediately
execFailedAction	String	Yes	Action when SQL execution fails: stop: Stop the task after an execution error. ignore: Ignore the execution error and continue the task. rollback: Roll back the task after an execution error.	stop
backupFailedAction	String	Yes	Action when the backup fails: stop: Stop the task after a backup failure. ignore: Ignore the backup failure and continue the task.	stop
executeTime	String	No	Execution time. Required when executeType is schedule. Format: yyyy-MM-dd'T'HH:mm:ssZ.	2025-09-11T12:34:56Z

bizData parameters (data export)

Parameter	Type	Required	Description	Example
executeType	String	Yes	Execution type: immediately: Execute immediately. schedule: Execute on a schedule.	immediately
executeTime	String	No	Execution time. Required when executeType is schedule. Format: yyyy-MM-dd'T'HH:mm:ssZ.	2025-09-11T12:34:56Z

Response parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request was successful.	true
errorCode	String	Error code.	N/A
message	String	Error message.	N/A

Successful response example

{
  "success": true
}