DolphinScheduler API 实战指南拿到可跑通请求的4步与3组关键接口【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler写自动化脚本、对接第三方系统时如果你想用 DolphinScheduler API 以编程方式创建工作流、查询任务实例、管理调度资产先拿一个 token再调几个 v2 接口就够了。快速上手API认证Token配置与可跑通请求的4步 三种认证方式的区别只在凭证怎么拿拿到之后请求侧是统一的Token 走请求头Session 走 CookieBasic 适合最简单的集成。项目取值/说明基础 URLhttp://{host}:{port}/api按部署的实际上下文路径调整请求头token: your-access-tokenToken 认证时使用内容格式application/jsonUTF-8 编码分页参数pageNo、pageSize拿到一个能跑通的请求只需要四步通过登录入口认证取得 access tokenWeb 会话同样可用每个请求都带上token请求头写操作用 POST/PUT 并带 JSON 请求体查询用 GET 加查询参数响应先看code等于 0 再处理data。一个最小可运行的查询示例curl -X GET http://{host}:{port}/api/v2/projects?pageNo1pageSize10 \ -H token: your-access-token能力全景项目管理与工作流定义管理的3组关键接口官方接口按资源划分数量不少按使用场景归拢只需要记三组——一组建资产、一组看现场、一组管数据与人。搭建调度资产项目与工作流定义管理接口覆盖项目、工作流定义、任务定义这三类静态资产。所有东西都挂在项目下所以第一步永远是建项目。方法路径用途POST/v2/projects创建新项目GET/v2/projects查询项目列表支持名称搜索、分页POST/projects/{projectCode}/workflow-definition创建工作流定义POST/projects/{projectCode}/workflow-definition/{code}/release发布工作流POST/projects/{projectCode}/task-definition创建任务定义观察运行现场工作流实例查询与任务实例重跑接口覆盖工作流实例、任务实例及其运行时操作是日常排障查得最多的一组。方法路径用途GET/v2/workflow-instances查询工作流实例列表可按状态、执行者、时间范围过滤POST/v2/workflow-instances/{id}/execute启停工作流实例GET/v2/projects/{projectCode}/task-instances查询任务实例列表POST/v2/projects/{projectCode}/task-instances/{id}/rerun重跑任务实例POST/v2/projects/{projectCode}/task-instances/{id}/kill杀死任务实例对接外部数据与管理数据源与用户权限接口覆盖数据源MySQL、PostgreSQL、Hive、ClickHouse、Doris 等类型、用户与权限授予、监控统计。方法路径用途POST/datasources创建数据源GET/datasources查询数据源列表可按类型过滤POST/users创建用户POST/users/{id}/grant-project授予用户项目权限GET/v2/statistics/task-state-count任务状态统计GET/v2/statistics/workflow-state-count工作流状态统计实战演练从建项目到查实例的请求与响应解读场景一新业务接入时创建项目先建项目后续的工作流定义和任务定义都挂在它的 projectCode 下。curl -X POST http://{host}:{port}/api/v2/projects \ -H Content-Type: application/json \ -H token: your-access-token \ -d { projectName: 数据分析平台, description: 用于大数据分析任务调度, userName: admin }{ code: 0, // 0 表示请求成功 msg: success, data: { code: projectCode, // 项目编码后续路径里的 {projectCode} name: 数据分析平台, createTime: timestamp } }重点看data.code它是之后所有路径参数要用的项目编码拿到后存下来。场景二筛出正在运行的工作流实例直说这是排障时最典型的现场查询先确认哪些实例还在 RUNNING再决定要不要干预。请求速记GET /v2/workflow-instances?pageNo1pageSize10stateTypeRUNNINGstartDatedateendDatedate同样带token请求头。{ code: 0, data: { totalList: [ { id: workflowInstanceId, // 实例ID直接用于 /execute 启停 stateType: RUNNING // 实例状态与查询过滤条件对应 } ] } }返回的id就是POST /v2/workflow-instances/{id}/execute里要填的实例 ID无需再做转换。排错速查API错误码现象与一步修复 非零 code 都有明确指向按表处理即可不用逐条翻日志。现象大概率原因一步修复返回code10000请求参数缺失或格式不对按接口约定修正请求体后重新提交返回code10001数据库异常检查数据库连接状态并重试返回code10002同一请求重复提交去掉重复请求只提交一次返回code10003用户未被授予对应权限核对角色与项目权限重新授权后重试返回code10004资源 ID 不存在先调列表接口取正确 ID再重试返回code10005系统繁忙稍后重试或扩容 master/worker 容量进阶与注意事项批量调度性能与版本兼容Token 复用token 一次获取、整个会话复用并配合 HTTP 连接池避免每次请求都重新认证。批量拆批批量创建任务时按约 50 个一批拆分批与批之间留短暂间隔避免触发 10005。热点数据加缓存数据源列表、项目列表这类高频查询在本地缓存定期刷新别反复打列表接口。重试策略瞬时失败用指数退避重试耗时操作走异步调用。聚合用统计接口问“今天成功失败各多少”时用监控统计接口不要循环列表接口自己数。版本策略优先使用 v2 接口升级后先回归测一遍集成点并核对官方版本变更说明。这组 DolphinScheduler API 覆盖的是建资产、看实例、授权、看统计这类日常诉求告警通道定制、插件扩展这类深度场景不在本指南范围内遇到时再单独处理对应模块即可。【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
DolphinScheduler API 实战指南：拿到可跑通请求的4步与3组关键接口
DolphinScheduler API 实战指南拿到可跑通请求的4步与3组关键接口【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler写自动化脚本、对接第三方系统时如果你想用 DolphinScheduler API 以编程方式创建工作流、查询任务实例、管理调度资产先拿一个 token再调几个 v2 接口就够了。快速上手API认证Token配置与可跑通请求的4步 三种认证方式的区别只在凭证怎么拿拿到之后请求侧是统一的Token 走请求头Session 走 CookieBasic 适合最简单的集成。项目取值/说明基础 URLhttp://{host}:{port}/api按部署的实际上下文路径调整请求头token: your-access-tokenToken 认证时使用内容格式application/jsonUTF-8 编码分页参数pageNo、pageSize拿到一个能跑通的请求只需要四步通过登录入口认证取得 access tokenWeb 会话同样可用每个请求都带上token请求头写操作用 POST/PUT 并带 JSON 请求体查询用 GET 加查询参数响应先看code等于 0 再处理data。一个最小可运行的查询示例curl -X GET http://{host}:{port}/api/v2/projects?pageNo1pageSize10 \ -H token: your-access-token能力全景项目管理与工作流定义管理的3组关键接口官方接口按资源划分数量不少按使用场景归拢只需要记三组——一组建资产、一组看现场、一组管数据与人。搭建调度资产项目与工作流定义管理接口覆盖项目、工作流定义、任务定义这三类静态资产。所有东西都挂在项目下所以第一步永远是建项目。方法路径用途POST/v2/projects创建新项目GET/v2/projects查询项目列表支持名称搜索、分页POST/projects/{projectCode}/workflow-definition创建工作流定义POST/projects/{projectCode}/workflow-definition/{code}/release发布工作流POST/projects/{projectCode}/task-definition创建任务定义观察运行现场工作流实例查询与任务实例重跑接口覆盖工作流实例、任务实例及其运行时操作是日常排障查得最多的一组。方法路径用途GET/v2/workflow-instances查询工作流实例列表可按状态、执行者、时间范围过滤POST/v2/workflow-instances/{id}/execute启停工作流实例GET/v2/projects/{projectCode}/task-instances查询任务实例列表POST/v2/projects/{projectCode}/task-instances/{id}/rerun重跑任务实例POST/v2/projects/{projectCode}/task-instances/{id}/kill杀死任务实例对接外部数据与管理数据源与用户权限接口覆盖数据源MySQL、PostgreSQL、Hive、ClickHouse、Doris 等类型、用户与权限授予、监控统计。方法路径用途POST/datasources创建数据源GET/datasources查询数据源列表可按类型过滤POST/users创建用户POST/users/{id}/grant-project授予用户项目权限GET/v2/statistics/task-state-count任务状态统计GET/v2/statistics/workflow-state-count工作流状态统计实战演练从建项目到查实例的请求与响应解读场景一新业务接入时创建项目先建项目后续的工作流定义和任务定义都挂在它的 projectCode 下。curl -X POST http://{host}:{port}/api/v2/projects \ -H Content-Type: application/json \ -H token: your-access-token \ -d { projectName: 数据分析平台, description: 用于大数据分析任务调度, userName: admin }{ code: 0, // 0 表示请求成功 msg: success, data: { code: projectCode, // 项目编码后续路径里的 {projectCode} name: 数据分析平台, createTime: timestamp } }重点看data.code它是之后所有路径参数要用的项目编码拿到后存下来。场景二筛出正在运行的工作流实例直说这是排障时最典型的现场查询先确认哪些实例还在 RUNNING再决定要不要干预。请求速记GET /v2/workflow-instances?pageNo1pageSize10stateTypeRUNNINGstartDatedateendDatedate同样带token请求头。{ code: 0, data: { totalList: [ { id: workflowInstanceId, // 实例ID直接用于 /execute 启停 stateType: RUNNING // 实例状态与查询过滤条件对应 } ] } }返回的id就是POST /v2/workflow-instances/{id}/execute里要填的实例 ID无需再做转换。排错速查API错误码现象与一步修复 非零 code 都有明确指向按表处理即可不用逐条翻日志。现象大概率原因一步修复返回code10000请求参数缺失或格式不对按接口约定修正请求体后重新提交返回code10001数据库异常检查数据库连接状态并重试返回code10002同一请求重复提交去掉重复请求只提交一次返回code10003用户未被授予对应权限核对角色与项目权限重新授权后重试返回code10004资源 ID 不存在先调列表接口取正确 ID再重试返回code10005系统繁忙稍后重试或扩容 master/worker 容量进阶与注意事项批量调度性能与版本兼容Token 复用token 一次获取、整个会话复用并配合 HTTP 连接池避免每次请求都重新认证。批量拆批批量创建任务时按约 50 个一批拆分批与批之间留短暂间隔避免触发 10005。热点数据加缓存数据源列表、项目列表这类高频查询在本地缓存定期刷新别反复打列表接口。重试策略瞬时失败用指数退避重试耗时操作走异步调用。聚合用统计接口问“今天成功失败各多少”时用监控统计接口不要循环列表接口自己数。版本策略优先使用 v2 接口升级后先回归测一遍集成点并核对官方版本变更说明。这组 DolphinScheduler API 覆盖的是建资产、看实例、授权、看统计这类日常诉求告警通道定制、插件扩展这类深度场景不在本指南范围内遇到时再单独处理对应模块即可。【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考