Skip to content

Latest commit

 

History

History
59 lines (29 loc) · 3.23 KB

DataApiService使用文档.md

File metadata and controls

59 lines (29 loc) · 3.23 KB

数据服务

DSS目前支持将SQL脚本发布成数据服务API,分享给其他用户使用。业务用户可以在不用写代码和无大数据平台用户的情况下,设置参数,就可以执行数据服务的脚本,并直接浏览或者下载平台数据。

1、创建数据服务

由于业务的需要,需要建立一个数据服务,授权给他人使用,当发布用户进入Scriptis,编辑新建脚本文件,编写SQL语句,同时可以在SQL语句中嵌入变量,方便后续的业务人员自己设置参数后就可以获取数据。

在保存该Spark SQL脚本后,可在脚本编辑栏上方点击“发布为数据API”(该“发布为数据API”的功能,只有部分用户具有该权限,不具备权限的用户,该功能按钮不可见),在点击后需要填如以下API创建信息(其中带红色 * 标记为必填项),新建API信息填写如下图所示。

点击下一步,用于设置变量的信息。

发布用户可以在工作空间的主页,通过“进入数据服务开发”,和“更多应用工具”进入使用数据服务,在数据服务的标签点击“更多”,可以进入数据服务管理界面

2、使用数据服务

在进入数据服务页面后,可以看到该用户可使用的数据服务列表页面,其中default表示默认所有的数据服务,用户可以点击对应的标签筛选出自己需要使用的数据服务,同时可以在搜索框中,分别用名称、状态、提交人进行筛选,详情页面如下图所示。

使用用户点击“进入使用”,可以在筛选条件中,设置参数的值,由此可见,使用用户是发布用户数据集的一个子集。

3、修改数据服务

一个数据服务由于业务的需要可能发生修改,当发布用户对数据服务的脚本进行了修改,可以点击“更新数据API”。 更新数据服务,可以选择绑定的其他数据服务。

4、使用postman访问数据服务

数据服务发布后,支持使用api接口访问,可以给其它系统直接调用。提交查询如下图所示:

获取到任务执行ID, 再根据ID可以获取任务的执行进度,日志,结果集等。

说明:数据服务的token可以从/queryById?的接口返回(点击进入使用),字段为userToken. 所有接口的访问都是要经过GateWay认证的。数据服务的token只能用于数据服务的管理流程。使用postman的认证需要使用页面的cookie后者走linkis-gateway的秘钥认证方式。在head 里面加入Token-Code: XXX 这里指定linkis-gateway的登录秘钥 Token-User: XXX 这里指定linkis-gateway的登录用户。