跳到主要内容

执行任务

执行指定的工作流任务。

请求地址:/openapi/v1/workflow/execute

请求方法:POST

请求参数

参数类型是否必选说明示例
workflowIdString任务 ID。ex-dd47653n757w
bizDataObject任务执行参数。根据工作流类型的不同,需要传入不同的参数。具体请参见本文的 bizData 参数(SQL 任务)bizData 参数(数据导出)

bizData 参数(SQL 任务)

参数类型是否必选说明示例
executeTypeString执行类型:
  • immediately:立即执行
  • schedule:定时执行
immediately
execFailedActionStringSQL 执行出错选项:
  • stop:执行出错后,停止任务
  • ignore:忽略执行错误,继续任务
  • rollback:执行出错后,回滚任务
stop
backupFailedActionString备份执行失败选项:
  • stop:备份失败后,停止任务li>ignore:备份失败后,继续任务
stop
executeTimeString执行时间。executeType 参数为 schedule 时必填,格式:yyyy-MM-dd'T'HH:mm:ssZ2025-09-11T12:34:56Z

bizData 参数(数据导出)

参数类型是否必选说明示例
executeTypeString执行类型:
  • immediately:立即执行
  • schedule:定时执行
immediately
executeTimeString执行时间。executeType 参数为 schedule 时必填,格式:yyyy-MM-dd'T'HH:mm:ssZ2025-09-11T12:34:56Z

返回参数

参数类型说明示例
successBoolean请求是否成功。true
errorCodeString错误码。
messageString异常信息。

调用成功示例

{
"success": true
}