全部產品
Search
文件中心

PolarDB:ModifyFirewallRules - 修改防火牆規則

更新時間:Sep 17, 2025

修改sql防火牆配置

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:ModifyFirewallRules

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

叢集 ID。

pc-*****************

RuleName

string

防火牆規則名稱。一次僅支援輸入一個規則名稱。

說明
  • 您可以通過介面 DescribeFirewallRules 查看目的地組群下的所有防火牆規則詳情,包括規則名稱。

  • 若輸入的規則名稱不存在於當前叢集中,系統會自動根據該名稱和RuleConfig值建立一個新的防火牆規則。

test

RuleConfig

string

需要修改的防火牆規則的配置參數及其值的 JSON 串,參數的值都是字串類型,例如:{ "id": "test", "enabled": "true", "mode": "Defending", "users": { "applies_to": [] }, "endpoint": "[{"EndpointName":"pe-***************","EndpointType":"Cluster","DBEndpointDescription":"叢集地址"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"}]", "type": "BlackList", "sub_rules": [] }, "RuleName": "test" }。其中:

  • "id":必填,表示防火牆規則名稱。

  • "databases":選填。需要應用當前規則的資料庫名稱,支援輸入多個資料庫名稱,多個名稱間用英文逗號(,)分隔。若該參數留空,表示該規則將應用到當前叢集中的所有資料庫。

  • "tables":選填。需要應用當前規則的表名稱,支援輸入多個表庫名稱,多個名稱間用英文逗號(,)分隔。若該參數留空,表示該規則將應用到當前叢集中的所有表。

  • "columns":必填。需要應用當前規則的欄位名稱,支援輸入多個欄位名稱,多個名稱間用英文逗號(,)分隔。

  • "description":選填。脫敏規則的描述,選填。字元長度不能超過 64 個字元。

  • "enabled":必填。啟用或禁用目標脫敏規則。取值為 true(啟用)或 false(禁用)。

  • "applies_to":需要應用當前規則的資料庫帳號名稱,支援輸入多個資料庫帳號名,多個帳號間用英文逗號(,)分隔。

  • "exempted":不需要應用當前規則的資料庫帳號名稱,支援輸入多個資料庫帳號名,多個帳號間用英文逗號(,)分隔。

說明
  • 若輸入了RuleName參數,RuleConfig參數必傳。

  • "applies_to""exempted",需要選擇其中的一個進行輸入。

{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

A8DBA3A7-82FB-5CBE-A002-8959E47D1D61

Message

string

請求返回訊息。

說明

請求成功時該參數返回 Successful,請求失敗時會返回請求異常資訊(如錯誤碼等)。

Successful

Success

boolean

請求結果。取值:

  • true:請求成功。

  • false:請求失敗。

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A8DBA3A7-82FB-5CBE-A002-8959E47D1D61",
  "Message": "Successful",
  "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情