创建工作流任务
创建一个新的工作流任务。
请求地址:/openapi/v1/workflow/create
请求方法:POST
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| module | String | 是 | 任务类型:
| sqlTask |
| bizData | Object | 是 | 任务详情。根据 module 参数的不同,需要传入不同的参数。具体请参见本文的 bizData 参数(SQL 任务)或 bizData 参数(数据导出)。 | 无 |
bizData 参数(SQL 任务)
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| name | String | 是 | 任务名称。 | "test" |
| datasourceId | String | 是 | 任务关联的数据源 ID。 | "ds-dbiddumxp4h" |
| dbName | String | 是 | 任务关联的数据库名称。 | "ght" |
| schemaName | String | 否 | 任务关联的 Schema 名称。 | "public" |
| dbGroupId | String | 否 | 任务关联的数据库分组 ID(与 datasourceId 互斥,至少填充一个)。 | "group1" |
| estimatedAffectedRows | Integer | 是 | 预估影响行数。 | 12 |
| executorType | String | 否 | 执行人类型:
| "creator" |
| sqlInputType | String | 否 | SQL 文本类型:
| "text" |
| sqlText | String | 是 | SQL 文本内容。 | "select version();" |
| rollbackTextType | String | 否 | 回滚文本类型:
| "text" |
| rollbackText | String | 否 | 回滚文本内容。 | "drop table if exists t1;" |
bizData 参数(数据导出)
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| name | String | 是 | 任务名称。 | "test" |
| datasourceId | String | 是 | 任务关联的数据源 ID。 | "ds-dbiddumxp4h" |
| dbName | String | 是 | 任务关联的数据库名称。 | "ght" |
| type | String | 是 | 导出类型:
| "sql" |
| sqlText | String | 否 | SQL 文本。type 为 sql 时必传。 | "select version();" |
| content | String | 是 | 导出内容类型:
| "data" |
| fileType | String | 是 | 导出文件类型:
| "excel" |
| reason | String | 否 | 导出原因。 | "test" |
| executorType | String | 是 | 任务执行人:
| "creator" |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| data | String | 任务 ID。 | "st-dd46vm7divwx" |
| errorCode | String | 错误码。 | 无 |
| message | String | 异常信息。 | 无 |
调用成功示例
{
"success": true,
"data": "st-dd46vm7divwx"
}