发布API
本文将为您介绍如何发布数据服务中的API。
操作场景
为了安全起见,在数据服务中生成的API以及注册的API,都需要发布后才能对外提供服务。
前提条件
已调试成功待发布的API。
约束与限制
不支持单个或多个用户同时发布API到同一专享版集群,系统会提示“当前操作正在执行中,请稍后重试”。
操作步骤
- 在DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 进入 页面,在API服务列表操作列中,选择 。
- 在确认发布界面,您可以选择集群进行发布。
图1 选择集群发布
- 共享版默认发布到API网关共享版。发布成功后,您可以在API网关服务共享版控制台上查看所发布的API。
系统为API网关共享版的默认分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,此调试域名每天最多可以访问1000次。如果您不希望与其他API共享此规格,可以在APIG共享版控制台新建一个API分组(详情请参考创建API分组),然后在数据服务发布时选择对应API分组,独享每天最多访问1000次的规格。另外,您还可以为API分组绑定一个或多个独立域名(详情请参考绑定域名),API调用者通过访问独立域名来调用您开放的API,这样即可不受每天最多访问1000次的规格限制。
- 专享版默认发布到数据服务专享版集群上,支持按照API版本发布,发布成功后API调用者可以通过内网或公网调用该API。值得一提的是,只有将API发布到专享版集群上,才不存在每天最多可以访问1000次的限制,可自由调用API。
- 共享版默认发布到API网关共享版。发布成功后,您可以在API网关服务共享版控制台上查看所发布的API。
-
如果非审核人权限的用户发布API时,待审核人审核通过后,即可发布完成。
处于待审核状态的API无法修改数据连接,需要具有空间管理员角色的用户审批驳回才可进行修改。
审核人支持管理员、开发者、运维者,访客无法添加为审核人。
工作空间管理员角色的用户,无论是否被添加为审核人,都默认具备审核人权限。
- 发布完成后,您可以进入到“服务目录”,查看已发布API信息。
相关操作
批量发布API:您可以在专享版的
页面,勾选需要发布的API后,依次单击API列表上方的“批量操作 > 批量发布”,实现多个API的统一发布。