配置API黑白名單

  • 文檔創建者:Roxy
  • 編輯次數:4
  • 最近更新:Nikozhan 于 2025-07-17
  • 1. 概述

    1.1 版本

    FineDataLink 版本
    功能變動
    4.0.28-
    4.2.8.1支援為應用設定黑白名單

    1.2 應用場景

    在進行資料發佈時,使用者需要配置好發佈環境,也就是設定當前 API 發佈後,外部系統呼叫是否需要開通黑白名單,以保證發佈的 API API在被外部系統呼叫時更安全。

    1.3 功能簡介

    資料服務支援全局配置黑白名單,也支援應用維度配置黑白名單。攔截邏輯如下圖所示:

    具體設定
    說明備註
    全局配置黑白名單保障服務整體安全性和穩定性,對所有 API 生效若同時配置全局黑白名單、應用黑白名單,必須所有層級都允許存取當前 API ,最終才允許存取
    應用維度配置黑白名單可指定應用配置黑白名單,為不同存取者分配可存取的資源

    2. 前提條件

    1)有資料服務功能模組的入口權限,便可查看規則。詳情請參見:資料平台使用權限

    2)只有超管才能配置全局黑白名單、應用黑白名單,非超管僅可查看。

    3. 設定黑白名單

    點選「資料服務>規則管理」,進入黑白名單設定介面。如下圖所示:

    3.1 設定全局規則

    1)點選「查看」按鈕,再點選「編輯」按鈕,可編輯全局規則。如下圖所示:

    2)為所有應用設定黑/白名單。如下圖所示:

    3)啟動該規則。如下圖所示:

    相關配置說明如下:

    注:全局規則固定且僅有一條供使用者編輯;對所有使用者可見;不可刪除,超管可關閉「啟動按鈕;非超管僅可查看,不可編輯。

    注:建議 APPCode 和黑白名單同時使用,提升API安全性。

    配置項
    說明
    黑名單/白名單

    設定黑名單:黑名單內的 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 和黑白名單同時使用,提升API安全性。

    配置項
    說明
    黑名單、白名單、IP、備註、快速新增按鈕請參見本文 3.1 節表格內容
    作用物件
    • 配置物件:使用者有權限的應用

    • 作用物件:所選應用下的所有 API 

    4)「應用列表」Tab 下,可查看某個應用的黑白名單規則。如下圖所示:

    附件列表


    主題: 資料服務
    已經是第一篇
    已經是最後一篇
    • 有幫助
    • 沒幫助
    • 只是瀏覽
    • 评价文档,奖励 1 ~ 100 随机 F 豆!