数据服务 - 服务编排 - 《EasyData用户手册》

服务编排

更新时间: 2023-04-20 10:22:51 | 阅读 1712

扫码

复制

导出

功能使用前提
- 权限相关
- 服务编排资源组
功能入口
新建服务编排
- 基础信息
- 工作流配置
其它操作
服务编排使用注意事项

在实际业务使用过程中，有较多场景需要对API进行业务逻辑加工，或异构数据源实现表的关联查询等复杂场景，仅仅通过向导或脚本模式新建API已不能满足需求，服务编排正好能够解决这样的问题。

服务编排支持构建串行、并行的工作流，通过开始节点、结束节点、API节点、Python节点和条件节点满足更加复杂的加工逻辑处理。

功能使用前提

权限相关

使用服务编排功能之前，需前往安全中心 - 功能权限，由项目负责人或管理员设置API的新建、查看、导出下载、编辑、删除、复制等权限。

服务编排资源组

除了权限之外，还需在配置管理 - 资源组管理页面完成服务编排资源组的创建。

功能入口

在数据服务页面，点击左侧菜单栏服务开发 - API管理列表 - API列表，在右侧API列表页面，点击服务编排按钮即可进入新建服务编排页面。

新建服务编排

新建服务编排共包含两个步骤：基础信息和工作流配置。在基础信息配置页面主要完成名称、协议、请求方式、描述等信息的填写；工作流配置页面通过不同节点的组合完成复杂的加工逻辑。

基础信息

服务编排的基础信息配置页面同新建API的页面类似，如下：

基本信息	描述
服务编排名称	必填。格式要求：1~64个字符，需以中文、字母开头，仅支持中文、字母、数字、"-"、"_"。
API集合	选择已创建的API集合，如果未创建，可点击右侧创建集合按钮进行创建。
服务编排path	通过集合path和服务编排path生成唯一的请求地址path。
协议	支持HTTP和HTTPS两种协议。支持HTTPS协议要完成SSL证书配置，为避免无法调用，在使用之前需进行如下准备： 1. 拥有一个HTTPS可控域名且申请SSL证书； 2. 具备可接受外网请求的Nginx服务； 3. 配置SSL证书。
请求方式	支持GET和POST。 1. 若选择GET方式，入参位置为QUERY； 2. 若选择POST方式，入参位置为BODY。
返回类型	JSON
超时时间	默认10000ms。支持自定义设置。
描述	服务编排的描述。
API标签	可选择或输入标签，最多关联5个标签。
apiToken鉴权	API调用支持apiToken和应用两种鉴权方式。如果打开，可通过apiToken调用API，只需要在header中添加字段apiToken、appKey和version即可，适用于报表、数据大屏等安全性要求不高的使用场景。具体使用方法可参考SDK下载中示例说明文件。
API协助管理者	可指定当前API的协助管理者，等同于创建人，拥有对API的所有操作权限。
选择资源组	服务编排运行时使用的查询服务资源组，需事先在配置管理页面创建服务编排资源组。

工作流配置

在工作流配置页面可通过拖动左侧节点至画布上进行开发逻辑的编辑。画布默认节点为开始节点和结束节点，左侧节点有三种分别是：Python节点、API节点、条件节点和UDF节点。

开始节点
右键点击开始节点，选择编辑按钮可对开始节点进行编辑。节点配置包括node ID、节点名称以及参数输入配置。

说明：
1.node ID需要在执行运行后自动生成，每个节点的node ID唯一；
2.节点名称默认为开始，在开始节点中不允许修改；
3.输入参数配置根据下游节点的输入参数进行配置。

结束节点
右键结束节点，选择编辑按钮可对结束节点进行编辑。节点配置包括node ID、节点名称以及输出参数配置。

结束节点支持系统填充返回参数功能，且仅支持填充上游为API类型的节点数据。

说明：
1.node ID需要在执行运行后自动生成，每个节点的node ID唯一；
2.节点名称默认为结束，在结束节点中不允许修改；
3.输出参数配置根据最后想要的输出结果进行配置。

Python节点
将Python节点拖入至画布，右键节点选择编辑按钮可对节点进行编辑。节点配置包括node ID、节点名称、描述以及代码编辑区。

此处，节点名称支持自定义，可根据实际情况填写。代码编辑区默认代码如下：
```
  import json,time,random,pickle,re,math
  def handle(inputJson):
  # 入参字典
  input = json.loads(inputJson)
  # 统一用output字典封装返回结果
  output = {}
  #自定义代码区
  #XXXXXXX
  #XXXXXXX
  #XXXXXXX
  return json.dumps(output)
```
从代码可知，对于Python节点的要求输入和输出都是json格式。
此外，Python节点支持测试功能，在编辑页面点击测试节点按钮，输入样例，即可进行代码测试，也可右键节点选择测试功能进行测试。
API节点
将API节点拖入至画布，右键节点选择编辑按钮可对节点进行编辑。节点配置包括node ID、节点名称、选择API、描述以及参数信息。

其中，节点名称支持自定义输入。选择API需要绑定当前服务编排创建者具有发布和下线权限且处于已发布状态的API。选择了需要的API后，会自动在参数信息中填入入参定义和后端返回参数。
条件节点
将条件节点拖入至画布，右键节点选择编辑按钮可对节点进行编辑。节点配置包括node ID、节点名称、描述、代码编辑区以及条件配置。条件节点会根据输出结果结合执行条件执行下游节点，例如id>20执行下游节点a，则在节点a对应输入框中填写"id >20"。
UDF节点
服务编排支持UDF节点，可通过上传jar包处理更为复杂的编排业务逻辑。将UDF节点拖入至画布，右键节点选择编辑按钮可对节点进行编辑。节点配置包括节点名称、描述以及上传Jar包。