全部產品
Search

搜尋本產品

    PolarDB：ModifyMaskingRules - 修改脫敏規則

    文件中心

    PolarDB：ModifyMaskingRules - 修改脫敏規則

    更新時間：Apr 30, 2026

    修改脫敏規則配置或新增脫敏規則。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:ModifyMaskingRules

    update

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    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
    InterfaceVersion

    string

    否

    修改脫敏加密規則。取值範圍如下：

    v1：修改脫敏規則。 v2：修改加密規則。

    v1
    MaskingAlgo

    string

    否

    規則演算法，可選多個。脫敏演算法可以額外添加參數。 格式：｛name：演算法 1｝，｛name：演算法 2, params:｛加密位置，加密位元｝｝

    [{ "name": "aes-128-gcm" }]
    DefaultAlgo

    string

    否

    預設演算法。

    說明

    MaskingAlgo 與 DefaultAIgo 必須傳一個。

    aes-128-gcm

    返回參數

    名稱

    類型

    描述

    樣本值

    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無效

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。