服务项目是数据服务的基本组织单元,是进行多用户隔离和访问控制的主要边界。后续您需要通过服务项目使用数据服务。本文为您介绍如何创建及管理服务项目。
使用限制
仅支持阿里云主账号(即Dataphin中的超级管理员)创建服务项目。
新建服务项目
在Dataphin首页,单击顶部菜单栏的服务 > 管理。
单击左侧导航栏的项目管理,再单击+新建服务项目按钮,进入新建服务项目对话框。
在新建服务项目对话框,配置参数。
参数
描述
服务项目名称
填写服务项目的名称。命名规则如下:
包含中文、字母、数字、下划线(_)及短划线(-)。
以中文或字母开头。
不能超过32个字符。
API发布管控
API发布到线上使用的过程中,有四种变更场景(新增必填请求参数、删减请求参数、删减返回参数、变更请求参数的数据类型),导致影响API以及关联的组合API的正常调用。因此,在API绑定应用或者被组合API引用后,API发布新版本到线上时,会与线上的版本进行对比,如果存在以上四种变更,可以选择不同的处理机制。
您可基于API的使用场景,针对不同项目下的API灵活使用发布管控机制。支持绑定应用或者被组合API引用时,拦截不允许发布、被组合API引用时,拦截不允许发布、绑定应用时,拦截不允许发布、不拦截,均可发布4种发布管控机制。
绑定应用或者被组合API引用时,拦截不允许发布:API绑定应用或者被组合API引用时,不允许新版本发布到线上,保证下游应用和组合API的正常调用。适用于使用范围广,影响面大的重要API,如果变更发布到线上会严重影响下游时可以拦截。
被组合API引用时,拦截不允许发布:API被组合API引用时,不允许新版本发布到线上,保证组合API的正常调用,调用受影响的应用由开发人员线下通知对应的负责人。适用于API变更发布到线上后,能及时通知应用负责人调整应用调用配置的情况,确保应用正常调用API。
说明若API被其他组合API引用又无法通知到组合API的负责人及时修正组合API时,为避免因子API的变更导致组合API不能正常调用的问题,则不允许API的变更发布到线上。
绑定应用时,拦截不允许发布:API绑定应用时,不允许新版本发布到线上,保证下游应用正常调用,调用受影响的组合API由开发人员线下通知组合API的负责人。适用于仅保证下游应用能正常调用API。
说明若API被其他组合API引用,则由开发人员告知对应组合API的负责人及时修正组合API来保证组合API的正常调用。
不拦截,均可发布:新版本均可发布到线上,调用受影响的组合API和下游应用,由开发人员通知对应负责人。适用于影响范围小,下游使用比较少的API,即使变更发布到线上导致API无法正常调用也不影响业务的API。
描述
填写对服务项目简单的描述。不超过128个字符。
单击提交,完成服务项目的创建。
管理服务项目
您可以在项目管理页面下进行添加项目成员、创建服务项目分组、编辑服务项目、删除服务项目等操作。
操作 | 描述 |
编辑 | 支持修改项目的名称、API发布管控、描述信息。API发布管控修改会影响新版本API的发布策略。 |
成员管理 | 支持为项目增加或删除成员并为其设置角色,详情请参见添加成员并设置角色。 |
分组管理 | 支持为项目设置服务单元、应用、API分组,便于项目管理,详情请参见创建服务项目分组。 |
删除 | 需将项目中所依赖的API、应用、服务单元删除后,才能将项目删除。 |
后续步骤
如果您需要其RAM用户协助开发时,可以将Dataphin成员列表中的RAM用户添加为服务项目的成员并设置角色。具体操作,请参见添加成员并设置角色。