本文将为您介绍如何将数据服务中的API发布到服务目录。
操作场景
数据服务是数据对外开放的最后一道防线,为了安全起见,在数据服务中生成的API以及注册的API,都需要发布到服务目录中才能对外提供服务。
操作步骤
1.在DataArts Studio控制台首页,选择实例,点击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。
详见下图: 选择数据服务
2.在左侧导航栏选择服务版本(例如:专享版),进入总览页。
3.进入“数据服务 > 总览 > 开发API > API管理”页面,在API服务列表操作列中,选择“更多 > 发布”。
4.在确认发布界面,您可以点击“更多”,选择发布详情。
详见下图: 发布详情
−专享版默认发布到数据服务专享版集群上,发布成功后API调用者可以通过内网调用该API。您也可以选择“更多”,将API发布到APIG专享版或ROMA Connect实例上。
- APIG专享版:如果您需要将API发布到APIG专享版上,则您需要提前在API网关服务上创建一个APIG实例。实例创建后,有一个默认API分组,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。如果您不希望与其他API共享此规格,可以在APIG控制台新建一个API分组(详情请参考“API网关APIG用户指南> API分组管理> 创建API分组”章节),然后在数据服务发布时选择对应API分组,独享每天最多访问1000次的规格。另外,您还可以为API分组绑定一个或多个独立域名(详情请参考“API网关APIG用户指南>API分组管理> 绑定域名”章节),API调用者通过访问独立域名来调用您开放的API,这样即可不受每天最多访问1000次的规格限制。
- ROMA Connect实例:如果您需要将API发布到ROMA Connect实例上,则您需要提前在ROMA Connect服务上创建一个ROMA实例,并创建API分组(详情请参考“应用与数据集成平台 ROMA Connect用户指南> 服务集成指导> 开放API> 创建API分组”章节)。API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。为了不受此规格限制,您可以为API分组绑定独立域名(详情请参考“应用与数据集成平台 ROMA Connect用户指南> 服务集成指导> 开放API> 绑定域名”章节),API调用者通过访问独立域名来调用您开放的API。
5.在发布API时,会触发审核,审核机制如下:
- 当发布人不具备审核人权限时,发布API时需要提交给审核人审核。
- 当发布人具备审核人权限时,可无需审批直接发布API。工作空间管理员角色的用户默认具备审核人权限。
如果非审核人权限的用户发布API时,待审核人审核通过后,即可发布完成。
后续操作
发布完成后,您可以进入到“服务目录”,查看API信息。
也可以对API进行管理,请参见"管理API",或进一步在“运营管理 > 流控策略”页面设置流量控制等功能,请参见"流量控制"。