DescribeMaskingRules - 查詢脫敏規則列表 -

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeMaskingRules

get

*DBCluster

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。說明您可以通過 DescribeDBClusters 介面查看帳號下所有叢集的詳細資料，包括叢集 ID。	pc-*****************
RuleNameList	string	否	脫敏規則名稱。	testrule
InterfaceVersion	string	否	擷取脫敏加密規則。取值範圍如下： v1：擷取脫敏規則。 v2：擷取加密規則。	v1

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	2F83D131-1C18-4599-889D-729A9D******
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
Success	boolean	請求結果。取值： true：請求成功。 false：請求失敗。	true
Data	object	結果集。
RuleList	array	脫敏規則詳情。
	string	脫敏規則詳細配置。說明關於各參數的詳細介紹，詳情請參見 ModifyMaskingRules 中`RuleConfig`的參數描述。	"{\"testrule\":{\"auto\":{\"databases\":[],\"tables\":[\"t1\"],\"columns\":[\"c1\"]},\"applies_to\":[],\"description\":\"This rule will be applied to the columns c1 in table t1\",\"enabled\":\"true\"}}"
RuleVersion	string	脫敏規則版本, 取值 v1、v2, 預設值 v1	v1
DBClusterId	string	叢集 ID。	pc-bp1s826a1up******

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2F83D131-1C18-4599-889D-729A9D******",
  "Message": "Successful",
  "Success": true,
  "Data": {
    "RuleList": [
      "\"{\\\"testrule\\\":{\\\"auto\\\":{\\\"databases\\\":[],\\\"tables\\\":[\\\"t1\\\"],\\\"columns\\\":[\\\"c1\\\"]},\\\"applies_to\\\":[],\\\"description\\\":\\\"This rule will be applied to the columns c1 in table t1\\\",\\\"enabled\\\":\\\"true\\\"}}\""
    ],
    "RuleVersion": "v1"
  },
  "DBClusterId": "pc-bp1s826a1up******"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Abs.InvalidAccount.NotFound	account is not found.	找不到帳戶
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的 DBClusterId。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的參數DBClusterId無效

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

變更歷史

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