全部产品
Search

搜索本产品

    云原生数据库 PolarDB：ModifyMaskingRules - 修改脱敏规则

    文档中心

    云原生数据库 PolarDB：ModifyMaskingRules - 修改脱敏规则

    更新时间：Jun 17, 2024

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    集群 ID。

    说明 您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。
    		pc-*****************
    RuleNamestring否

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

    说明
  • 您可以通过接口 DescribeMaskingRules 查看目标集群下的所有脱敏规则详情，包括规则名称。
  • 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和RuleConfig值创建一个新的脱敏规则。
    •
    		testrule
    RuleConfigstring否

    需要修改的脱敏规则的配置参数及其值的 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"]}
    RuleNameListstring否

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

    说明 RuleName和RuleNameList参数，需要选择其中的一个进行输入。
    		testrule
    Enablestring否

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

    • true：启用。
    • false：禁用。
    说明 仅当RuleNameList有参数值输入时，该参数生效。
    		true
    RuleVersionstring否

    脱敏规则版本。取值范围如下：

    • v1（默认）
    • v2
    		v2

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		99B355CE-526C-478B-B730-AD9D7C******
    Messagestring

    请求返回消息。

    说明 请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。
    		Message
    Successboolean

    请求结果。取值：

    • true：请求成功。

    • false：请求失败。

    		true

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2024-01-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：404
    入参OpenAPI 入参发生变更。
      新增入参：RuleVersion
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      新增错误码：404