管理聚合服务
您在创建聚合服务后,可对其进行一些日常管理操作,如修改、删除、修订、作废、另存等。
前提条件
已获取开发人员及以上权限用户的账号和密码。
修改聚合服务
仅支持修改正在工作状态的服务。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 您可参照以下任一方式进入编辑状态:
- 单击目标服务“操作”列处的。
- 单击目标服务“编码”链接,在弹出的情页单击“编辑”。
- 在目标服务详情页,您可根据实际业务需求进行如下操作:
- 选择“服务定义”,修改基本信息、编辑图结构、管理入参参数、管理过滤条件和管理出参参数等。
表1 修改基本信息 操作
说明
修改非纯脚本服务的基本信息
支持修改API英文名称、API中文名称、API英文描述、API中文描述、API责任人、维护人、初始数据实体、是否支持服务运行结果保存为数据集、API调用方式等。
说明:修改基本信息时,存在以下限制:
- 通过修订方式生成的聚合服务的API英文名称禁止修改。
- 已有图数据库数据源不支持删除,且禁止同时选择关系型数据库和图数据库。
修改纯脚本服务的基本信息
支持修改API英文名称、API中文名称、API英文描述、API中文描述、API责任人、维护人、数据源、是否支持服务运行结果保存为数据集、API调用方式等。
说明:修改基本信息时,存在以下限制:
- 通过修订方式生成的聚合服务的API英文名称禁止修改。
- 已有关系型数据库支持删除,但禁止同时选择关系型数据库和图数据库。
表2 编辑图结构 操作
说明
添加数据实体与关系
通过添加相关联的数据实体及关系,实现图形化编排数据模型的交互路径,系统会根据编排的图结构生成高效的查询脚本。
添加与目标实体相关联的数据实体及关系批量添加数据实体与关系- 在画布上方单击,弹出添加数据实体与关系窗口。
- 勾选一个或多个数据实体,单击“下一步”,选择需要添加的关系。
- 单击“确定”。
根据推荐路径添加数据实体- 在图结构中选中模型节点按鼠标右键调出快捷菜单,单击“设置起点”或“设置终点”,或者单击图结构右侧上方搜索栏后的,展开“路径查询”小窗,添加起始节点和终点节点。
- 单击“搜索”,结果显示推荐路径列表。
- 展开想要添加的路径,单击“选择”,将目标路径添加到图结构中。
关联模型节点
通过添加连线方式将本身存在关系的数据实体关联起来,没有关系的数据实体则不支持关联。
按住Ctrl键依次选中两个模型节点,在其中一个节点上按鼠标右键调出的快捷菜单中单击“添加连线”。
设置别名
设置模型节点或关系线的别名,便于记忆和区别。
- 选中模型节点或关系线按鼠标右键,在调出的快捷菜单中单击“设置别名”,弹出设置别名窗口。
- 输入“显示别名”,单击“确定”保存。
删除模型节点
删除图结构中不需要或已失效的模型节点或关系线。
- 删除单个模型节点或关系线:选中模型节点或关系线按鼠标右键,在调出的快捷菜单中单击“删除”。
- 批量删除模型节点:选中一个模型节点或按住Ctrl键依次选中多个模型节点,在画布上方单击“删除”。
数据探索
快速跳转进入“模型路径探索”页面,进行数据探索(了解更多模型路径探索使用详情)。
选中模型节点按鼠标右键,在调出的快捷菜单中单击“数据探索”或在图结构左上方单击。
保存图结构位置
保存并记录上次调整移动的图结构位置。
- 在画布中拖动调整数据实体的位置,当位置移到合适位置后,单击画布左上方的,可保存当前数据实体的位置。
- 如有需要,您可再次拖动其他节点,已保存的节点位置固定不随其他节点移动。
表3 管理入参参数 操作
说明
新增入参
非纯脚本服务支持通过自选入参和自定义入参方式新增入参,纯脚本服务仅支持自定义入参。
- 自选入参:在左侧“设置入参”处选中数据实体,右侧展示该目标实体的属性列表,在列表中勾选入参属性。
- 自定义入参:单击“自定义入参”,在入参汇总处填写入参信息。
修改入参
自选入参和自定义入参均支持修改,系统默认入参则不支持。
说明:并非所有入参字段都支持修改,且自选入参和自定义入参支持修改的字段有所不同。
删除入参
自选入参和自定义入参均支持删除,系统默认入参则不支持。
- 删除自选入参:取消勾选出参属性或单击目标出参操作列的。
- 删除自定义入参:单击目标出参操作列的。
表4 管理过滤条件 操作
说明
管理组
过滤条件组是用来存放过滤条件的容器,可以在过滤条件组内管理所有过滤条件。
- 新增过滤条件组:单击“添加组”,新增过滤条件组。
- 删除过滤条件组:单击“删除组”,删除过滤条件组。
管理过滤条件
当API接收到请求时,可以根据已设置的过滤条件,只检索符合过滤条件的数据。
- 新增过滤条件:单击“添加规则”,添加过滤条件的属性、匹配方式、过滤条件值等。
- 修改过滤条件:修改目标过滤条件的属性、匹配方式、过滤条件、各过滤条件之间的关系等。
- 删除过滤条件:在待删除的过滤条件后,单击“删除”。
表5 管理出参参数 操作
说明
新增出参
非纯脚本服务支持通过自选出参和自定义出参方式新增出参,纯脚本服务仅支持自定义出参。
- 自选出参:在左侧“设置出参”处选中数据实体,右侧展示该目标实体的属性列表,在列表中勾选出参属性。
说明:
出参勾选非入图属性会生成一段脚本使用数据实体ID获取数据,ID如果自定义名称将失效。
- 自定义出参:单击“自定义出参”,在出参汇总处填写出参信息。
修改出参
自选出参和自定义出参均支持修改,系统默认出参则不支持。
说明:并非所有出参字段都支持修改,且自选出参和自定义出参支持修改的字段有所不同。
删除出参
自选出参和自定义出参均支持删除,系统默认出参则不支持。
- 删除自选出参:取消勾选出参属性或单击目标出参操作列的。
- 删除自定义出参:单击目标出参操作列的。
- 选择“服务开发”,进行服务开发信息管理。具体操作可参考服务开发。
- 选择“服务测试”,进行测试用例管理。具体操作可参考服务测试。
- 选择“服务发布”,进行服务发布信息更新。具体操作可参考服务发布。
- 选择“服务定义”,修改基本信息、编辑图结构、管理入参参数、管理过滤条件和管理出参参数等。
- 修改完后单击“保存”。
删除聚合服务
仅支持删除正在工作状态的服务。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 您可根据实际情况选择以下方式:
- 单击目标服务后的。
- 勾选一个或多个服务,单击列表上方“删除”。
- 在弹出的提示框中单击“确定”,完成删除。
如需取消删除,单击“取消”。
修订聚合服务
仅支持修订已发布的服务,修订成功后生成一个新版本正在工作中的服务,版本号自动递增。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 找到要修订的目标服务,单击或单击“编码”链接,进入详情页单击“修订”。
- 修订完成后单击“保存”。
作废聚合服务
仅支持作废已发布的服务,作废后服务状态更新为“已作废”。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 您可根据实际情况选择以下方式:
- 找到要作废的服务,单击或单击“编码”链接,进入详情页单击“作废”。
- 勾选一个或多个服务,单击列表上方的“作废”。
- 单击“确定”。
另存聚合服务
您可使用另存功能来复制已有的服务。通过另存功能生成的目标服务副本,状态为正在工作且修订号为A,API中英文名称为原来的名称+“_副本1/_copy1”。
正在工作和已发布状态的服务都支持另存。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 找到要复制的聚合服务,单击“编码”链接,弹出详情页。
- 单击“另存”。
处理服务失效对象
当非脚本服务中引用的实体或关系失效后,请及时将失效对象在服务中删除。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 找到目标服务,单击“编码”链接,在详情页弹出失效提示。
图1 失效提示信息
- 根据失效提示汇总信息,在
中删除失效对象。
如果服务已发布,请修订服务后再操作。
更新服务出参
如果聚合服务引用的属性值对应的数据实体或关系实体版本升级,如出参类型、密级随实体等更新,此时需要您更新聚合服务的版本属性。
待更新成功后,即可重新部署API、进行服务开发、测试、发布。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 找到带有的聚合服务,单击“编码”链接,在详情页弹出更新提示。
图2 有待更新的出参
- 根据更新提示前往“设置出参”,单击“更新出参信息”更新服务。
图3 更新提示
- 单击“保存”,保存更新。
重新配置数据集参数
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 找到带有的聚合服务,单击“编码”链接,在详情页弹出更新提示。
图4 数据集参数待更新
- 根据更新提示前往“数据集配置”,修改数据集配置参数。
- 单击“保存”,保存更新。
管理服务标签
在列表中“标签”列您可查看所有聚合服务已添加的标签,也可通过具体聚合服务的“编码”进入详情页查看标签。
如果您需要管理服务标签,可以参考本节内容操作。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 管理单个服务的标签。
- 找到待操作的聚合服务,单击“编码”链接,默认进入目标服务详情页。
- 在“标签”处,进行标签添加或清除。 页面
- 管理多个服务的标签。
- 勾选多个服务,在列表上方“标签批量操作”下拉框中选择“添加标签”或“清除标签”。
- 根据弹出的操作框完成标签批量操作。
批量编辑责任人或维护人
如果您需要批量修改服务的责任人或维护人,可以参考本节内容操作。
- 仅企业级管理员或租户级管理员可进行“批量编辑责任人”和“批量编辑维护人”操作。
- 仅正在工作状态的服务支持编辑责任人,已发布状态的服务不支持。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 根据实际情况,选择批量编辑责任人或维护人。
- 批量编辑责任人:勾选一个或多个正在工作的聚合服务,单击“批量编辑责任人”,在弹出的“批量编辑责任人”窗口选择“责任人”后单击“确定”,即可更改责任人。
- 批量编辑维护人:勾选一个或多个聚合服务,单击“批量编辑维护人”,在弹出的“批量编辑维护人”窗口选择“维护人”后单击“确定”,即可更改维护人。
导出服务
您可根据需要导出部分或全部的聚合服务数据,查看导出结果请参见我的导出任务。
- 登录LinkX-F系统首页。
- 选择“聚合服务编排”页面。 ,进入
- 根据实际情况,选择导出部分服务或全部服务。
- 导出选中项:勾选一条或多条服务,单击 。
- 导出全部:单击 。