执行任务

执行指定的工作流任务。

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

请求方法：POST

数据库连接信息验证

执行 SQL 任务时，系统会校验数据库连接信息；验证通过后才会继续执行，验证失败则拒绝执行。调用方如需传入数据库账号和密码，请以当前版本 OpenAPI 的实际字段定义为准，并避免在请求日志、示例或其他长期存储中记录明文凭证。

请求参数

参数	类型	是否必选	说明	示例
workflowId	String	是	任务 ID。	ex-dd47653n757w
bizData	Object	是	任务执行参数。根据工作流类型的不同，需要传入不同的参数。具体请参见本文的 bizData 参数（SQL 任务）或 bizData 参数（数据导出）。	无
reason	String	否	执行原因。	release
source	String	否	调用来源。	api
toolId	String	否	工具标识。	tool-1
sourceClient	String	否	调用客户端。	client-1
sourceSessionId	String	否	外部会话 ID。	session-1
skillVersion	String	否	工具版本。	1.0.0
language	String	否	返回信息语言。	zh_cn

bizData 参数（SQL 任务）

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

bizData 参数（数据导出）

参数	类型	是否必选	说明	示例
executeType	String	是	执行类型： immediately：立即执行 schedule：定时执行	immediately
executeTime	String	否	执行时间。executeType 参数为 schedule 时必填，格式：yyyy-MM-dd'T'HH:mm:ssZ。	2025-09-11T12:34:56Z

返回参数

参数	类型	说明	示例
success	Boolean	请求是否成功。	true
requestId	String	OpenAPI 请求 ID。	"<requestId>"
data	Object	成功时为空。	{}
message	String	异常信息。	无

调用成功示例

{
  "success": true,
  "requestId": "<requestId>",
  "data": {}
}