1. 概述
1.1 版本
FineDataLink 版本 | 功能变动 |
---|---|
4.0.28 | - |
4.2.8.1 | 支持为应用设置黑白名单 |
1.2 应用场景
在进行数据发布时,用户需要配置好发布环境,也就是设置当前 API 发布后,外部系统调用是否需要开通黑白名单,以保证发布的 API 接口在被外部系统调用时更安全。
1.3 功能简介
数据服务支持全局配置黑白名单,也支持应用维度配置黑白名单。拦截逻辑如下图所示:
具体设置 | 说明 | 备注 |
---|---|---|
全局配置黑白名单 | 保障服务整体安全性和稳定性,对所有 API 生效 | 若同时配置全局黑白名单、应用黑白名单,必须所有层级都允许访问当前 API ,最终才允许访问 |
应用维度配置黑白名单 | 可指定应用配置黑白名单,为不同访问者分配可访问的资源 |
2. 前提条件
1)有数据服务功能模块的入口权限,便可查看规则。详情请参见:数据平台使用权限
2)只有超管才能配置全局黑白名单、应用黑白名单,非超管仅可查看。
3. 设置黑白名单
点击「数据服务>规则管理」,进入黑白名单设置界面。如下图所示:
3.1 设置全局规则
1)点击「查看」按钮,再点击「编辑」按钮,可编辑全局规则。如下图所示:
2)为所有应用设置黑/白名单。如下图所示:
3)启用该规则。如下图所示:
相关配置说明如下:
注:全局规则固定且仅有一条供用户编辑;对所有用户可见;不可删除,超管可关闭「启用」按钮;非超管仅可查看,不可编辑。
注:建议 APPCode 和黑白名单同时使用,提升接口安全性。
配置项 | 说明 |
---|---|
黑名单/白名单 | 设置黑名单:黑名单内的 IP 无法访问 API 设置白名单:只有白名单内的 IP 能访问 API ,白名单以外的 IP 均无法访问 |
IP | 支持指定 IP 段和 IP 地址 1)IP 段举例:192.168.2.0/24(指定了192.168.2.1~192.168.2.254的地址范围(包含192.168.2.1和192.168.2.254)排除首部的网络地址(192.168.2.0)和尾部的广播地址(192.168.2.255)) 2)IP 地址举例:192.168.0.1 |
备注 | 允许为名单项添加备注 |
快速添加 | 4.2.8.1 及之后版本有该设置项,可快速添加 IP;如下图所示: |
3.2 为应用添加规则
1)点击「添加自定义规则」按钮,可为应用添加规则。如下图所示:
2)添加黑白名单:
3)设置完成后,界面如下图所示:
相关配置说明如下:
注:非超管仅可查看,不可编辑。
注:建议 APPCode 和黑白名单同时使用,提升接口安全性。
配置项 | 说明 |
---|---|
黑名单、白名单、IP、备注、快速添加按钮 | 请参见本文 3.1 节表格内容 |
作用对象 |
|
4)「应用列表」Tab 下,可查看某个应用的黑白名单规则。如下图所示: