配置API黑白名单

  • 文档创建者:Roxy
  • 历史版本:3
  • 最近更新:Wendy123456 于 2024-09-06
  • 1. 概述

    在进行数据发布时,用户需要配置好发布环境,也就是设置当前 API 发布后,外部系统调用是否需要开通黑白名单,以保证发布的 API 接口在被外部系统调用时更安全。

    2. 操作步骤

    2.1 设置黑白名单

    点击「数据服务>」,进入黑白名单设置界面,如下图所示:

    设置黑名单或白名单:

    • 设置黑名单:黑名单内的 IP 无法访问 API 。

    • 设置白名单:只有白名单内的 IP 能访问 API ,白名单以外的 IP 均无法访问。

    如下图所示:

    相关认证配置说明如下:

    配置项
    说明
    黑白名单
    • 不启用

    • 黑名单

    • 白名单

    默认选择不启用。

    黑名单

    黑名单IP列表,黑名单内的 IP 无法访问 API 

    • IP:支持指定 IP 段和 IP 地址

    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))

    IP 地址举例:192.168.0.1 

    • 备注:允许为名单项添加备注。

    注:在保存设置时,如果黑名单启用,则校验黑名单列表不允许为空

    白名单

    白名单 IP 列表,只有白名单内的 IP 能访问 API,白名单以外的 IP 均无法访问

    • IP:支持指定 IP 段和 IP 地址

    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))

    IP地址举例:192.168.0.1 

    • 备注:允许为名单项添加备注

    注:在保存设置时,如果白名单启用,则校验白名单列表不允许为空

    注:建议 APPCode 和黑白名单同时使用,提升接口安全性。

    2.2 保存配置

    点击确定,对全局的认证配置设置进行保存,如下图所示:



    附件列表


    主题: 数据服务
    • 有帮助
    • 没帮助
    • 只是浏览
    • 评价文档,奖励 1 ~ 100 随机 F 豆!