調用DsgWhiteListQueryList API查詢脫敏白名單-巨量資料開發治理平台 DataWorks-阿里雲

調用DsgWhiteListQueryList介面，查詢資料保護傘中配置的脫敏白名單。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:DsgWhiteListQueryList

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	是	分頁的頁數。	1
PageSize	integer	是	每頁顯示的條數，最大 100 條。	10
SceneId	integer	是	二級脫敏情境 ID。您可調用 DsgSceneQuerySceneListByName 介面擷取。	123
DataType	string	否	敏感欄位類型的關鍵字。	phone

返回參數

名稱	類型	描述	樣本值
	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	每頁顯示的條數。	10
TotalCount	integer	返回的脫敏白名單總條數。	100
Data	array<object>	白名單集合。
	object	返回資料。
Id	integer	脫敏白名單 ID。	123
Type	string	敏感欄位類型。	phone
UserGroups	array	使用者組名稱集合。
	string	使用者組名稱。	test_group
GmtCreate	string	脫敏白名單的建立時間。	2024-05-09 15:46:20
GmtModified	string	脫敏白名單的修改時間。	2024-05-09 15:46:20
RuleId	integer	脫敏規則 ID。	123
SceneId	integer	二級脫敏情境 ID。	123
StartTime	string	脫敏白名單的生效時間，不能早於目前時間。單位為天。	2024-05-09 15:46:20
EndTime	string	脫敏白名單的失效時間，不能早於生效時間。單位為天。	2024-05-10 15:46:20
RequestId	string	請求的 ID。用於定位日誌，排查問題。	102400001

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Id": 123,
        "Type": "phone",
        "UserGroups": [
          "test_group"
        ],
        "GmtCreate": "2024-05-09 15:46:20",
        "GmtModified": "2024-05-09 15:46:20",
        "RuleId": 123,
        "SceneId": 123,
        "StartTime": "2024-05-09 15:46:20",
        "EndTime": "2024-05-10 15:46:20"
      }
    ]
  },
  "RequestId": "102400001"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	WHITELIST.DESENSID.ERROR	The desensitization rule ID does not match or does not exist with the tenant.	情境ID不存在或不屬於該租戶。
400	WHITELIST.ENDTIME.ERROR	end time cannot be earlier than start time.	結束時間不能早於開始時間。
400	WHITELIST.ID.ERROR	The whitelist ID does not match or does not exist with the tenant.	白名單ID不存在或不屬於該租戶。
400	WHITELIST.MCPROJECT.ERROR	The projectName on the bottom layer desensitization whitelist of MC cannot be empty.	ProjectName在建立MaxCompute脫敏白名單時不可為空。
400	WHITELIST.PAGESIZE.ERROR	Page size is too large, maximum of 100.	頁大小超限，不能超過100。
400	WHITELIST.SIZE.ERROR	The number of white list exceeds the limit.	白名單數量超限。
400	WHITELIST.STARTTIME.ERROR	start time cannot be earlier than today.	開始時間不能早於今天。
400	WHITELIST.TIMEFORMAT.ERROR	The time format is incorrect, please use yyyy MM dd HH: mm: ss format.	時間參數格式化錯誤，需使用yyyy MM dd HH: mm: ss。
400	WHITELIST.USERGROUP.ERROR	The user group ID does not match or does not exist with the tenant.	使用者組ID不存在或不屬於該租戶。
400	WHITELIST.USERGROUPEMPTY.ERROR	User group ID cannot be empty.	使用者組ID不可為空。
400	WHITELIST.USERGROUPLISTSIZE.ERROR	The number of user group exceeds the limit.	使用者組數量超限。
400	PARAMS.ERROR	param error.	參數錯誤。
500	UNKNOWN.ERROR	unknown error.	未知錯誤。
403	PERMISSION.DENIED.ERROR	Permission denied	許可權不足。

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

變更歷史

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