ModifyFirewallRules - 修改防火墙规则_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

您可以在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
}

错误码

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

变更历史

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