DescribeFirewallRules - 查询防火墙规则_云原生数据库 PolarDB(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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。