调用ModifyMaskingRules接口修改脱敏规则配置或新增脱敏规则。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyMaskingRules

系统规定参数。取值:ModifyMaskingRules。

DBClusterId String pc-*****************

集群ID。

说明 您可以通过DescribeDBClusters接口查看账号下所有集群的详细信息,包括集群ID。
RuleName String testrule

脱敏规则名称。一次仅支持输入一个规则名称。

说明
  • 您可以通过接口DescribeMaskingRules查看目标集群下的所有脱敏规则详情,包括规则名称。
  • 若输入的规则名称不存在于当前集群中,系统会自动根据该名称和RuleConfig值创建一个新的脱敏规则。
RuleConfig String {"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]}

需要修改的脱敏规则的配置参数及其值的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",需要选择其中的一个进行输入。
RuleNameList String testrule

脱敏规则名称列表。支持一次输入一个或多个规则名称,多个名称间用英文逗号(,)分隔。

说明 RuleNameRuleNameList参数,需要选择其中的一个进行输入。
Enable String true

启用或禁用目标脱敏规则。取值范围如下:

  • true:启用。
  • false:禁用。
说明 仅当RuleNameList有参数值输入时,该参数生效。

返回数据

名称 类型 示例值 描述
RequestId String 99B355CE-526C-478B-B730-AD9D7C******

请求ID。

Message String Message

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Success Boolean true

请求结果。取值:

  • true:请求成功。
  • false:请求失败。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyMaskingRules
&DBClusterId=pc-*****************
&RuleName=testrule
&RuleConfig={"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]}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyMaskingRulesResponse>
<Message>Successful</Message>
<RequestId>99B355CE-526C-478B-B730-AD9D7C******</RequestId>
<Success>true</Success>
</ModifyMaskingRulesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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