调用ModifyMaskingRules修改脱敏规则_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

修改脱敏规则配置或新增脱敏规则。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardb:ModifyMaskingRules	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。说明您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。	pc-*****************
RuleName	string	否	脱敏规则名称。一次仅支持输入一个规则名称。说明您可以通过接口 DescribeMaskingRules 查看目标集群下的所有脱敏规则详情，包括规则名称。若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的脱敏规则。	testrule
RuleConfig	string	否	需要修改的脱敏规则的配置参数及其值的 JSON 串，参数的值都是字符串类型，例如：`{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}`。其中： `"auto"`：必填，表示支持动态脱敏算法。 `"databases"`：选填。需要应用当前规则的数据库名称，支持输入多个数据库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有数据库。 `"tables"`：选填。需要应用当前规则的表名称，支持输入多个表库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有表。 `"columns"`：必填。需要应用当前规则的字段名称，支持输入多个字段名称，多个名称间用英文逗号（,）分隔。 `"description"`：选填。脱敏规则的描述，选填。字符长度不能超过 64 个字符。 `"enabled"`：必填。启用或禁用目标脱敏规则。取值为 true（启用）或 false（禁用）。 `"applies_to"`：需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。 `"exempted"`：不需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。说明若输入了`RuleName`参数，`RuleConfig`参数必传。 `"applies_to"`和`"exempted"`，需要选择其中的一个进行输入。	{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}
RuleNameList	string	否	脱敏规则名称列表。支持一次输入一个或多个规则名称，多个名称间用英文逗号（,）分隔。说明 `RuleName`和`RuleNameList`参数，需要选择其中的一个进行输入。	testrule
Enable	string	否	启用或禁用目标脱敏规则。取值范围如下： true：启用。 false：禁用。说明仅当`RuleNameList`有参数值输入时，该参数生效。	true
RuleVersion	string	否	脱敏规则版本。取值范围如下： v1（默认） v2	v2

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	99B355CE-526C-478B-B730-AD9D7C******
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Message
Success	boolean	请求结果。取值： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "99B355CE-526C-478B-B730-AD9D7C******",
  "Message": "Message",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效

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

变更历史

变更时间

变更内容概要

操作

2024-01-02

OpenAPI 错误码发生变更、OpenAPI 入参发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：404
入参	OpenAPI 入参发生变更。
	新增入参：RuleVersion

2023-09-12

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	新增错误码：404