調用DsgDesensPlanQueryList查詢脫敏規則列表-巨量資料開發治理平台 DataWorks-阿里雲

調用DsgDesensPlanQueryList介面，查詢資料保護傘的脫敏規則列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:DsgDesensPlanQueryList

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	是	分頁的頁數。	1
PageSize	integer	是	每頁顯示的資料條數，最大為 100。	10
SceneId	integer	是	二級脫敏情境 ID。您可調用 DsgSceneQuerySceneListByName 介面擷取。	123
RuleName	string	否	敏感欄位名稱。	phone
Owner	string	否	脫敏規則的負責人。	user1
Status	integer	否	脫敏規則的生效狀態。取值如下： 0：失效。 1：生效。	1
columns	array<object>	否
	object	否
dbType	string	否
project	string	否
table	string	否
column	string	否
emptyNotDesesn	string	否
dataType	string	否

返回參數

名稱	類型	描述	樣本值
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	調用是否成功。取值如下： true：調用成功。 false：調用失敗。	true
ErrorCode	string	錯誤碼。	1029030003
ErrorMessage	string	錯誤資訊。	param error
HttpStatusCode	integer	HTTP 狀態代碼。	400
PageData	object	分頁資料。
PageNumber	integer	頁碼。	1
PageSize	integer	每頁顯示的資料條數，最大為 100。	10
TotalCount	integer	返回的脫敏規則條數。	100
Data	array<object>	脫敏規則資訊。
	array<object>	脫敏規則資訊。
Id	integer	脫敏規則 ID。	123
DataType	string	敏感欄位類型。	phone
RuleName	string	脫敏規則名稱。	phone_hash
DesensPlan	object	脫敏規則詳情。
DesensPlanType	string	脫敏規則類型。	hash
ExtParam	object	脫敏規則參數。參數資訊可參考 DsgDesensPlanAddOrUpdate 介面文檔。
	any	脫敏規則參數詳情。	"extParam": { "algo":"MD5", "salt":"5" }
Owner	string	脫敏規則的負責人。	user1
GmtCreate	string	脫敏規則的建立時間。	2024-05-09 15:46:20
GmtModified	string	脫敏規則的修改時間。	2024-05-09 15:46:20
Status	integer	脫敏規則的生效狀態。取值如下： 0：失效。 1：生效。	1
DesensWay	string	脫敏方式。	HASH
DesenMode	string	脫敏方式類型。	HASH
DesensRule	string	脫敏規則。	HASH
SceneCode	string	脫敏規則所屬的一級脫敏情境 Code。取值如下：資料開發/資料地圖展示脫敏：dataworks_display_desense_code MaxCompute 引擎層脫敏：maxcompute_desense_code MaxCompute 引擎層脫敏（新）：maxcompute_new_desense_code Hologres 引擎層脫敏：hologres_display_desense_code Data Integration靜態脫敏：dataworks_data_integration_desense_code 資料分析展示脫敏：dataworks_analysis_desense_code	dataworks_display_desense_code
CheckWatermark	boolean	是否添加浮水印。取值如下： true：添加。 false：不添加。	true
SceneName	string	脫敏規則所屬的二級脫敏情境名稱。	test_scene
emptyNotDesesn	boolean
columns	array<object>
	object
dbType	string
project	string
table	string
column	string
RequestId	string	請求的 ID。用於定位日誌，排查問題。	102400001

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Id": 123,
        "DataType": "phone",
        "RuleName": "phone_hash",
        "DesensPlan": {
          "DesensPlanType": "hash",
          "ExtParam": {
            "key": "\"extParam\": {             \"algo\":\"MD5\",             \"salt\":\"5\"           }"
          }
        },
        "Owner": "user1",
        "GmtCreate": "2024-05-09 15:46:20",
        "GmtModified": "2024-05-09 15:46:20",
        "Status": 1,
        "DesensWay": "HASH",
        "DesenMode": "HASH",
        "DesensRule": "HASH",
        "SceneCode": "dataworks_display_desense_code",
        "CheckWatermark": true,
        "SceneName": "test_scene",
        "emptyNotDesesn": true,
        "columns": [
          {
            "dbType": "",
            "project": "",
            "table": "",
            "column": ""
          }
        ]
      }
    ]
  },
  "RequestId": "102400001"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	敏感類型已經配置脫敏規則。
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	敏感類型不存在。
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	脫敏規則ID不存在。
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	頁大小超限，最大為100。
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	脫敏規則參數錯誤。
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	情境碼不存在。
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	情境ID不存在。
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	情境不是二級情境。
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	脫敏規則數量超限。
400	PARAMS.ERROR	param error.	參數錯誤。
500	UNKNOWN.ERROR	unknown error.	未知錯誤。
403	PERMISSION.DENIED.ERROR	Permission denied	許可權不足。

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

變更歷史

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