通過DescribeFirewallRules查詢SQL防火牆規則 - 雲原生資料庫 PolarDB

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeFirewallRules

get

*DBCluster

acs:polardb:*:{#accountId}:dbcluster/{#dbclusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。	pc-*****************
RuleNameList	string	否	需要查詢的防火牆規則名稱。支援輸入多個規則名稱進行批量查詢，多個名稱間用英文逗號（,）分隔。說明您可以通過 DescribeFirewallRules 介面查看目的地組群下所有防火牆規則的詳情，包括規則名稱。	testrule

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Message
Success	boolean	請求結果。取值： true：請求成功。 false：請求失敗。	true
Data	object	結果集。
RuleList	array	防火牆規則列表。
	string	規則對象。	"{"mode":"Defending","endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-********","EndpointType":"Custom","DBEndpointDescription":"pc-*******"},{"EndpointName":"pe-**********","EndpointType":"Custom","DBEndpointDescription":"pc-*********"}]","id":"test","sub_rules":[],"type":"BlackList","enabled":"true","users":{"applies_to":[]}}"
DBClusterId	string	叢集 ID。	pc-*****************

樣本

正常返回樣本

JSON格式

{
  "RequestId": "84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264",
  "Message": "Message",
  "Success": true,
  "Data": {
    "RuleList": [
      "\"{\"mode\":\"Defending\",\"endpoint\":\"[{\"EndpointName\":\"pe-**************\",\"EndpointType\":\"Cluster\",\"DBEndpointDescription\":\"Cluster Address\"},{\"EndpointName\":\"pe-************\",\"EndpointType\":\"Custom\",\"DBEndpointDescription\":\"pc-***********\"},{\"EndpointName\":\"pe-**************\",\"EndpointType\":\"Custom\",\"DBEndpointDescription\":\"pc-***********\"}]\",\"id\":\"test\",\"sub_rules\":[],\"type\":\"BlackList\",\"enabled\":\"true\",\"users\":{\"applies_to\":[]}}\""
    ]
  },
  "DBClusterId": "pc-*****************\n"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

變更歷史

更多資訊，參考變更詳情。