执行任务
执行指定的工作流任务。
请求地址:/openapi/v1/workflow/execute
请求方法:POST
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| 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 |
| execFailedAction | String | 是 | SQL 执行出错选项:
| stop |
| backupFailedAction | String | 是 | 备份执行失败选项:
| stop |
| executeTime | String | 否 | 执行时间。executeType 参数为 schedule 时必填,格式:yyyy-MM-dd'T'HH:mm:ssZ。 | 2025-09-11T12:34:56Z |
bizData 参数(数据导出)
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| executeType | String | 是 | 执行类型:
| 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": {}
}