为了实现应用与数据服务之间的网络互通,在您开始调用API前需要配置网络。本文为您介绍如何配置网关。
功能说明
不同部署环境需配置的网关说明如下:
公共云多租户环境下,网关相关的所有配置在部署时已在数据库中写入,业务租户只需配置二级域名是否可见即可,您也可以根据需求绑定独立域名及配置VPC ID。VPC ID用于从该VPC网络下的API调用无需从公网访问;绑定独立域名后可用该域名访问API。
权限说明
仅超级管理员支持网络配置。
网络配置入口
在Dataphin首页的顶部菜单栏,选择服务 > 管理。
单击左侧导航栏的网络配置,进入网络配置页面。
在网络配置页面,选择内置API网关或阿里云API网关,选择后不可更改网关。
内置API网关:可快速提供服务,无需额外成本。
阿里云API网关:高性能、高可用的API托管服务,跨VPC访问、公网访问等均具有较好的配置性和兼容性。
查看域名
阿里云API网关
在二级域名区域,您可以管控用户查看域名的权限,支持仅超管可见和所有用户可见。另外,您还可以单独开启或关闭公网二级域名,并可快捷复制公网二级域名、内网VPC域名。
Dataphin默认提供二级域名用于调试。
公网二级域名支持API调用(包括调试API、测试API),每天调用不超过1000次;若用于线上正式调用,请绑定独立域名,绑定后,无调用次数限制。由于公网二级域名仅用于内部测试,建议关闭展示避免应用开发人员误用。
内网VPC用于VPC之间的调用,无调用次数限制。
API网关将为每个API分组分配公网域名及内网VPC域名,不可修改。
若域名展示不正确,请联系Dataphin运维团队。
绑定独立域名
在绑定独立域名区域,单击绑定域名按钮,进入绑定域名对话框。
若API网关为阿里公有云API网关,您可以查看API分组ID并快捷复制。
在绑定域名对话框中,配置参数。
参数
描述
域名
仅支持绑定已在阿里云备案的域名。例如:dataphin.aliyun.com。
环境
支持选择开发环境或生产环境。
单击确认,完成域名的绑定。
添加SSL证书。
单击SSL证书列下的添加。
在新增证书对话框,配置参数。
参数
描述
证书名称
填写证书名称。
证书内容
填写证书内容,示例如下。
-- BEGIN CERTIFICATE -- MIFRFGJLyrqtqWEE00cozR1pZ + ultKTANDFFLF9wddddddBGGTFAD -- END CERTIFICATE --
私钥
填写证书私钥,示例如下。
-- BEGIN RSAPRIVATE KEY -- ARTMIFRFGJLyrqtqWEE00cozR1pZultcvfsgsgsrAwREWDCFFGGCuD -- END RSAPRIVATE KEY --
单击确认,完成SSL证书的添加。
删除独立域名
在独立域名区域中,单击需要删除独立域名的操作列下图标。
在确认对话框中,单击确定,完成独立域名的删除。
授权VPC
当域名可见范围为所有用户可见且授权VPC后,支持从授权VPC内通过内网VPC域名访问API。
在授权VPC区域,单击新增按钮,再单击VPC id获取方式说明,获取VPC ID。如需添加多个VPC id,单击添加VPC id按钮,输入VPC ID,单击保存,完成VPC ID的添加。
删除VPC
在授权VPC区域,单击需要删除VPC的操作列下的图标。
在确认对话框中,单击确定,完成VPC ID的删除。
附录:说明
您可以单击右上角的说明按钮,查看关于二级域名、内网VPC域名、绑定独立域名、授权VPC的说明信息。