天融信虛擬防火墻RESTFULAPI文檔v6天融信公司推出了最新版本的虛擬防火墻RESTFULAPI，為客戶提供強大的網(wǎng)絡安全管理解決方案。本文檔詳細介紹了該API的功能和使用方法。cc作者：chaichao本次文檔概述文檔概覽本文檔詳細介紹了天融信虛擬防火墻RESTFULAPI的各項功能和使用方法，內容涵蓋產品介紹、主要功能、接口規(guī)范等。API文檔為系統(tǒng)管理員和開發(fā)人員提供全面的RESTFULAPI參考,助力二次開發(fā)和系統(tǒng)集成。使用指引詳細介紹各類接口的請求格式、參數(shù)說明和響應數(shù)據(jù),幫助用戶快速掌握API的使用方法。產品介紹天融信虛擬防火墻是一款基于軟件定義的虛擬防火墻解決方案。它可以快速部署和靈活配置,支持跨云環(huán)境統(tǒng)一管理和快速編排,大幅提升IT運維效率。產品采用模塊化架構設計,支持多種虛擬化及容器化部署,提供豐富的API接口,便于與其他系統(tǒng)進行深度集成。產品特點1靈活多變支持各種網(wǎng)絡拓撲和應用場景,可以適應復雜的網(wǎng)絡環(huán)境。2高性能基于業(yè)界領先的硬件架構,可以提供卓越的性能和轉發(fā)能力。3高可用支持主備模式及容錯機制,可確保系統(tǒng)穩(wěn)定可靠運行。4安全可控采用可信的安全機制,保護網(wǎng)絡免受各類攻擊和威脅。主要功能可視化管理提供直觀的圖形化界面,支持快捷操作,輕松管理整個虛擬防火墻系統(tǒng)。多維安全防御結合諸多安全模塊,為企業(yè)提供深層次的網(wǎng)絡安全防護。敏捷部署配置靈活的配置模板和自動化部署工具,提升系統(tǒng)管理效率。統(tǒng)一集中管理實現(xiàn)對分布式防火墻的集中管控,簡化安全管理復雜度。模塊結構天融信虛擬防火墻系統(tǒng)采用模塊化架構設計，各個功能模塊之間解耦合，具有高度的靈活性和可擴展性。主要模塊包括用戶管理、角色管理、策略管理、對象組管理、區(qū)域管理、設備管理、網(wǎng)絡管理、安全組管理、訪問控制列表管理、事件管理、日志管理、調度任務管理等。每個模塊都提供豐富的RESTfulAPI供外部系統(tǒng)集成調用，實現(xiàn)了通過軟件編程的方式對系統(tǒng)進行配置和管理。RESTfulAPI總覽易集成天融信虛擬防火墻RESTfulAPI設計遵循行業(yè)標準,便于快速集成到各種管理平臺。功能全面涵蓋了虛擬防火墻的主要管理功能,如用戶管理、策略配置、事件監(jiān)控等,滿足企業(yè)多樣化需求。高可靠性采用JSON格式,數(shù)據(jù)傳輸穩(wěn)定可靠,同時支持多種鑒權方式確保接口安全性。簡單易用操作直觀,文檔清晰,開發(fā)者可快速熟悉并開始使用虛擬防火墻的各項功能。接口認證安全驗證系統(tǒng)采用OAuth2.0標準協(xié)議進行身份認證,確保數(shù)據(jù)傳輸過程的安全性。靈活鑒權支持用戶名/密碼、AccessToken等多種認證方式,滿足不同應用場景的需求。權限控制通過精細的角色權限管理,確保用戶只能訪問被授權的資源和操作。響應碼說明響應碼說明200請求成功400請求參數(shù)有誤401認證失敗403沒有權限訪問該資源404資源未找到500服務器內部錯誤服務器返回的響應碼用于指明請求處理的結果。常見的響應碼包括成功、參數(shù)錯誤、身份認證失敗、無權限訪問、資源未找到以及服務器內部錯誤等。通過分析響應碼可以快速了解請求處理情況并進行故障排查。錯誤碼說明5可恢復這類錯誤可通過操作進行修復15需重啟這類錯誤需要重新啟動系統(tǒng)100不可恢復這類錯誤需要聯(lián)系技術支持200未定義未知錯誤碼,請聯(lián)系技術支持天融信虛擬防火墻系統(tǒng)提供了豐富的錯誤碼信息,用戶可根據(jù)錯誤碼查找對應的問題和解決方案。常見錯誤碼包括可恢復錯誤、需要重啟的錯誤以及無法自行解決的錯誤。用戶相關接口用戶管理實現(xiàn)用戶的創(chuàng)建、修改、刪除和查看等基本操作,為系統(tǒng)管理員提供用戶管理功能。用戶登錄支持用戶通過用戶名/密碼進行身份驗證和登錄,確保系統(tǒng)安全性。用戶信息展示用戶的基本信息、角色權限和操作歷史等,為管理員提供用戶全面了解。角色相關接口用戶角色管理提供創(chuàng)建、修改、刪除、查詢角色信息的接口，用于管理平臺用戶的權限角色。角色權限配置支持為角色分配具體的操作權限，如查看、添加、修改、刪除等不同級別的權限。角色分配用戶可將用戶批量或單個地指定給特定角色，以便快速管理用戶權限。角色權限分析提供角色權限列表、角色用戶列表等分析功能，幫助管理員更好地了解和管控平臺權限。策略相關接口1策略管理提供策略的創(chuàng)建、修改、刪除等操作，幫助管理員靈活定制網(wǎng)絡安全規(guī)則。2策略部署支持策略的快速部署和一鍵應用，確保安全防護措施能及時生效。3策略優(yōu)化提供策略分析與優(yōu)化建議,幫助管理員不斷優(yōu)化和完善安全策略。4策略查詢通過靈活的查詢條件,管理員可快速定位和調閱所需的策略信息。對象組相關接口對象分組管理提供創(chuàng)建、修改、刪除對象組的功能,支持IP地址、端口、協(xié)議等多種對象類型的分組管理。組內對象操作可對對象組內的成員進行增刪改查,快速編輯和管理對象組內容。組間關聯(lián)配置支持對象組之間的引用和嵌套關系,方便構建復雜的對象關系網(wǎng)絡。區(qū)域相關接口區(qū)域管理提供對虛擬防火墻內的區(qū)域進行增刪改查的功能,支持設置區(qū)域的基本屬性和關聯(lián)規(guī)則。地理位置管理支持對區(qū)域內的地理位置進行定義和管理,可以綁定IP地址范圍、城市等信息。區(qū)域協(xié)作支持多用戶協(xié)作管理區(qū)域,通過角色權限控制可以有效劃分責任范圍。設備相關接口設備管理創(chuàng)建、修改、刪除和查詢虛擬防火墻設備信息。可管理設備的基礎配置、工作狀態(tài)等。設備連接建立、斷開和查詢虛擬防火墻設備的網(wǎng)絡連接。管理設備的網(wǎng)絡接口及其連接狀態(tài)。設備狀態(tài)實時監(jiān)控虛擬防火墻設備的運行狀態(tài)信息，包括資源利用率、性能指標等。設備升級對虛擬防火墻設備的軟件版本進行升級管理?？刹樵儺斍鞍姹静?zhí)行升級操作。網(wǎng)絡相關接口網(wǎng)絡配置管理通過對虛擬網(wǎng)絡拓撲結構的配置和管理,實現(xiàn)對虛擬網(wǎng)絡的創(chuàng)建、修改和刪除。網(wǎng)絡安全策略定義和管理虛擬網(wǎng)絡的訪問控制策略,保護網(wǎng)絡免受未授權訪問和攻擊。網(wǎng)絡流量監(jiān)控全面了解和分析虛擬網(wǎng)絡的實時流量情況,優(yōu)化網(wǎng)絡性能和安全。安全組相關接口1創(chuàng)建安全組允許管理員創(chuàng)建新的安全組,用于對虛擬資源的安全訪問控制。2更新安全組提供更新安全組基本信息和規(guī)則的功能,以調整安全策略。3刪除安全組支持刪除不再需要的安全組,避免資源浪費。4查看安全組允許查看已創(chuàng)建的安全組列表及其詳細信息,便于管理。訪問控制列表相關接口訪問控制設置通過訪問控制列表接口管理安全策略,控制對系統(tǒng)資源的訪問權限。網(wǎng)絡訪問管理支持基于IP地址、端口等條件設置訪問控制規(guī)則,嚴格管控網(wǎng)絡流量。策略管理可以對訪問控制列表進行增、刪、改、查等操作,靈活管理安全策略。日志審計訪問控制列表的操作記錄可用于事件溯源和合規(guī)性審查。事件相關接口查看事件列表可按事件類型、狀態(tài)、時間范圍等條件篩選查看事件列表，并對事件進行確認、關閉等操作。查看事件詳情查看單個事件的詳細信息,包括事件源、事件類型、事件內容、事件狀態(tài)等。事件告警設置可配置事件告警規(guī)則,當滿足條件時自動推送通知。事件處理記錄記錄對事件的處理過程和結果,便于事后分析和審計。日志相關接口實時監(jiān)控天融信虛擬防火墻提供完善的日志記錄功能,用戶可實時查看系統(tǒng)、安全和審計日志,及時掌握設備運行狀態(tài)和安全風險。高效篩選支持按時間、級別、關鍵字等條件篩選日志,快速定位并分析異常情況。智能提供多維度統(tǒng)計分析,洞見隱藏的安全威脅。靈活導出支持日志導出為CSV格式,方便進行進一步的分析和取證?？稍O置自動定期備份,確保關鍵日志安全存儲。觸發(fā)告警對于重要的安全事件和系統(tǒng)錯誤,系統(tǒng)可自動發(fā)送告警通知,幫助管理員及時發(fā)現(xiàn)和處理問題。調度任務相關接口計劃任務管理用戶可以創(chuàng)建、修改和刪除各種類型的計劃任務,如備份、報告生成等,并設置執(zhí)行時間和頻率。任務狀態(tài)監(jiān)控系統(tǒng)會實時監(jiān)控計劃任務的執(zhí)行狀態(tài),并提供詳細的任務歷史記錄和執(zhí)行結果。觸發(fā)條件設置用戶可以設置各種觸發(fā)條件來自動執(zhí)行計劃任務,如定時、系統(tǒng)事件或其他外部事件觸發(fā)。系統(tǒng)狀態(tài)相關接口性能監(jiān)控實時查看設備的CPU、內存、磁盤等性能指標，跟蹤系統(tǒng)資源利用情況。網(wǎng)絡狀態(tài)監(jiān)控網(wǎng)絡接口的流量、連接數(shù)等指標，及時發(fā)現(xiàn)網(wǎng)絡異常情況。安全態(tài)勢查看各種安全事件的發(fā)生情況，了解系統(tǒng)整體的安全風險狀況。日志查詢提供全面的系統(tǒng)日志查詢功能，方便排查問題和審計分析。系統(tǒng)配置相關接口系統(tǒng)基本配置包括設置系統(tǒng)名稱、時區(qū)、logo等基礎信息的接口。可實現(xiàn)個性化定制系統(tǒng)界面。網(wǎng)絡參數(shù)設置提供設置IP地址、網(wǎng)關、DNS等網(wǎng)絡參數(shù)的接口?？筛鶕?jù)用戶部署環(huán)境進行靈活配置。郵件服務配置支持設置SMTP服務器地址、端口、發(fā)件人信息等參數(shù),實現(xiàn)系統(tǒng)告警郵