Apache DolphinScheduler API调用说明

Apache DolphinScheduler 提供了API接口调用,适用于与第三方系统的集成。创建令牌是调用的前提,登录调度系统生成令牌,并设定有效期限和指定用户。完成创建后,可在API文档页面找到apiserver地址进行接口测试,如查询项目列表。使用时需在请求头中设置Content-Type为application/json,Host为apiserver IP,以及生成的token。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

背景

调度一般都是通过页面创建项目、流程等,但是需要和第三方系统集成就需要通过调度API管理项目、流程。

操作步骤

创建token

1) 登录调度系统,进入 安全中心->令牌管理 ,单击 创建令牌按钮,创建令牌。如下图所示
在这里插入图片描述

2) 选择失效时间(就是token有效期,自己内部系统就设置长点),选择用户(用户是指谁调的接口,比如创建项目需要指定谁创建)单击“生成令牌”,
拷贝token字符串,然后保存就 ok在这里插入图片描述

使用token

  1. 找到API文档页面
    apiserver地址:12345/dolphinscheduler/doc.html
    选一个测试的接口,本次测试选的查询项目projects/query-project-list

  2. 打开postman,填写地址,
    header中填写
    Content-Type:application/json
    Host:你 apiserver ip
    token: 你刚刚生成的tokne

在这里插入图片描述

上面是请求后返回结果,一切ok.

### 关于DolphinScheduler API调度 对于希望集成第三方系统的场景,可以利用DolphinScheduler提供的API来管理项目、流程等资源。由于涉及的API较多,建议专注于理解其大致框架与核心功能,而详细的API列表以及具体使用方式应当参照官方文档[^1]。 为了开始使用这些API,创建访问令牌(token)是一个必要的前置操作[^2]。这一步骤确保了安全性和权限控制机制的有效实施。 #### 获取并了解API文档 最直接的方式是查阅[DolphinScheduler官方网站](https://dolphinscheduler.apache.org/)上的相关资料[^4]。这里不仅提供了全面的任务调度指南,还包括了如何部署单机版环境的具体指导[^3],这对于初步探索API非常有帮助。 #### 示例:获取Token接口请求 下面给出一段Python代码片段作为示例,展示如何向DolphinScheduler发送HTTP POST请求以获得用于后续调用其他API所需的认证Token: ```python import requests from urllib.parse import urljoin def get_token(base_url, username, password): endpoint = '/users/login' full_url = urljoin(base_url, endpoint) payload = { 'userName': username, 'userPass': password } response = requests.post(full_url, json=payload) if response.status_code == 200: data = response.json() token = data.get('data', {}).get('id') return f'Bearer {token}' else: raise Exception(f"Failed to obtain token: {response.text}") ``` 此函数接收基础URL、用户名及密码参数,并返回一个带有`Bearer`前缀的字符串形式的Token,该Token可用于授权之后的所有API请求。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值