<think>我们正在处理一个关于如何通过API调用
海豚调度工作流的问题。由于这是一个技术操作问题，我们需要提供
详细的
步骤。注意，
海豚调度（DolphinScheduler）是一个分布式易扩展的可视化DAG工作流任务
调度系统，通常用于数据管道的
调度和管理。
步骤一般包括：
1. 获取访问令牌（Token）
2. 构造API请求（包括必要的参数）
3. 发送请求（通常为HTTP POST请求）
4. 处理响应
由于
海豚调度API的具体实现可能因版本而异，这里以常见的API设计为例。通常，调用工作流执行的API需要工作流的定义ID（processDefinitionId）或工作流名称（processDefinitionName）以及项目名称（projectName）等。
注意：在调用API之前，确保已经正确
安装和配置了海olphinScheduler，并且知道API的入口地址（baseUrl），例如：http://<server>:<port>/dolphinscheduler。
具体
步骤：
第一步：获取Token
通常，调用API需要先进行认证。
海豚调度API的认证方式通常是通过用户名和密码获取Token，然后在后续请求的Header中携带该Token。
例如，获取Token的API可能是：
POST /dolphinscheduler/login
请求体：{"userName":"username", "userPassword":"password"}
第二步：查找工作流定义
在调用工作流之前，我们需要知道工作流的定义ID。可以通过查询工作流定义的API来获取。
例如，根据项目名称和工作流名称查询工作流定义：
GET /dolphinscheduler/projects/{projectName}/process/definition?name={workflowName}
注意：在Header中携带Token
第三步：执行工作流
使用获取到的工作流定义ID，调用执行工作流的API。
例如：
POST /dolphinscheduler/projects/{projectName}/executors/start-process-instance
请求体：{"processDefinitionId": 123, ...} // 可能还需要其他参数，如定时时间、失败策略等，根据实际情况
第四步：处理响应
检查API的响应，确认工作流是否成功启动。
由于不同版本的API可能有所不同，这里提供的是通用
步骤。请参考具体版本的API文档。
下面我们以伪代码和示例说明：
示例（使用curl命令）：
1. 获取Token：
curl -X POST -H "Content-Type: application/json" -d '{"userName":"admin", "userPassword":"dolphinscheduler123"}' http://localhost:12345/dolphinscheduler/login
响应示例：
{"code":0,"msg":"success","data":{"sessionId":"","user":{"id":1, ...},"token":"7xxxxx"}}
提取token，假设为"7xxxxx"
2. 查询工作流定义（假设项目名称为project1，工作流名称为workflow1）：
curl -X GET -H "token: 7xxxxx" "http://localhost:12345/dolphinscheduler/projects/project1/process/definition?name=workflow1"
响应中会包含工作流定义的信息，其中包含id（例如：123）。
3. 执行工作流：
curl -X POST -H "token: 7xxxxx" -H "Content-Type: application/json" -d '{"processDefinitionId":123}' http://localhost:12345/dolphinscheduler/projects/project1/executors/start-process-instance
注意：实际使用中，执行工作流可能需要更多的参数，例如：
{
"processDefinitionId": 123,
"scheduleTime": null, // 定时时间，可选
"failureStrategy": "CONTINUE", // 失败策略
"warningType": "NONE", // 警告类型
"warningGroupId": 0, // 警告组ID
"execType": "START_PROCESS", // 执行类型
"startNodeList": "", // 开始节点列表
"taskDependType": "TASK_POST", // 任务依赖类型
"runMode": "RUN_MODE_SERIAL", // 运行模式
"processInstancePriority": "MEDIUM", // 优先级
"workerGroup": "default", // worker组
"timeout": 0 // 超时时间
}
请根据实际情况调整。
另外，
海豚调度还支持通过工作流定义名称直接启动，但需要同时指定项目名称和工作流定义名称。例如，使用如下API：
POST /dolphinscheduler/projects/{projectName}/executors/start-process-instance-by-name
请求体：{"processDefinitionName": "workflow1", ...}
这样就不需要先查询ID了，但同样需要提供其他参数。
由于API的变动，建议查阅对应版本的官方文档。
相关问题：
1. 如何在
海豚调度中创建项目和工作流？
2.
海豚调度API的认证方式有哪些？
3. 如何监控
海豚调度工作流的执行状态？
4.
海豚调度支持哪些类型的任务？
5. 如何设置
海豚调度工作流的超时和告警？
注意：在回答中，我们引用了
海豚调度的一般操作流程，具体细节请参考官方文档[^1]。</think>### 通过API调用
海豚调度工作流的
详细步骤
以下是调用
海豚调度（DolphinScheduler）工作流API的操作流程（以1.3.x及以上版本为例）：
---
#### **
步骤1：获取访问令牌**
调用登录API获取认证令牌（Token）：
```http
POST /dolphinscheduler/login
Content-Type: application/json
{
"userName": "your_username",
"userPassword": "your_password"
}
```
**响应示例**：
```json
{
"code": 0,
"msg": "success",
"data": {
"sessionId": "xxxxx",
"token": "eyJhbGciOiJIUzUxMiJ9.xxxxxx" // 保存此Token
}
}
```
> 所有后续请求需在Header中添加：`token: <your_token>`[^1]
---
#### **
步骤2：查询工作流定义ID**
获取工作流在目标项目中的唯一ID：
```http
GET /dolphinscheduler/projects/{projectName}/process/definition
?name=<workflow_name>
```
**参数说明**：
- `projectName`：项目名称（需URL编码）
- `workflow_name`：工作流名称
**响应关键字段**：
```json
{
"data": {
"id": 12345 // 记录此ID
}
}
```
---
#### **
步骤3：执行工作流API调用**
触发工作流执行：
```http
POST /dolphinscheduler/projects/{projectName}/executors/start-process-instance
Content-Type: application/json
{
"processDefinitionId": 12345,
"failureStrategy": "CONTINUE",
"warningType": "NONE",
"warningGroupId": 0,
"runMode": "RUN_MODE_SERIAL",
"processInstancePriority": "MEDIUM"
}
```
**参数详解**：
| 字段 | 说明 |
|------|------|
| `processDefinitionId` |
步骤2获取的工作流ID |
| `failureStrategy` | 失败策略：`CONTINUE`
(继续
)/`END`
(终止
) |
| `runMode` | 运行模式：`RUN_MODE_SERIAL`
(串行
)/`PARALLEL`
(并行
) |
| `processInstancePriority` | 优先级：`HIGH`/`MEDIUM`/`LOW` |
**成功响应**：
```json
{
"code": 0,
"msg": "success",
"data": {
"processInstanceId": 67890 // 记录实例ID用于追踪
}
}
```
---
#### **
步骤4：验证执行状态**
查询工作流实例状态：
```http
GET /dolphinscheduler/projects/{projectName}/executors/process-instance/{processInstanceId}
```
**响应状态字段**：
```json
{
"data": {
"state": "RUNNING_EXECUTION", // 状态值
"endTime": null
}
}
```
**常见状态值**：
- `RUNNING_EXECUTION`: 运行中
- `SUCCESS`: 执行成功
- `FAILURE`: 执行失败
- `PAUSE`: 已暂停
---
### **关键注意事项**
1. **权限要求**：
- API调用账号需拥有目标项目的**执行权限**
- 工作流需提前在Web界面完成定义和发布
2. **参数规范**：
- 所有路径参数需进行**URL编码**
- JSON字段名称严格区分大小写
3. **错误排查**：
- `401`错误：Token失效 → 重新登录获取
- `500`错误：检查工作流节点配置
- `10010`错误：项目或工作流不存在
4. **生产环境建议**：
- 使用服务账号而非个人账号
- 在请求中增加`executionQueue`字段指定队列
- 设置`timeout`参数避免长时阻塞
> 完整API文档参考：[
海豚调度官方REST API文档]
(https://dolphinscheduler.apache.org/zh-cn/docs/latest/developer_guide/rest-api.html
)[^2]
---
本文提供了海豚调度集群的详细安装步骤，包括前提条件、配置主节点与工作节点、启动服务及访问Web界面。通过这些步骤，用户可以成功搭建并开始使用海豚调度进行大数据任务的管理和调度。
订阅专栏 解锁全文
扫一扫
289
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
