DsgWhiteListQueryList - 查询脱敏白名单 - 大数据开发治理平台 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	long	是	二级脱敏场景 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>	白名单集合。
Datas	object	返回数据。
Id	long	脱敏白名单 ID。	123
Type	string	敏感字段类型。	phone
UserGroups	array	用户组名称集合。
UserGroup	string	用户组名称。	test_group
GmtCreate	string	脱敏白名单的创建时间。	2024-05-09 15:46:20
GmtModified	string	脱敏白名单的修改时间。	2024-05-09 15:46:20
RuleId	long	脱敏规则 ID。	123
SceneId	long	二级脱敏场景 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.	参数错误。
403	PERMISSION.DENIED.ERROR	Permission denied	权限不足。
500	UNKNOWN.ERROR	unknown error.	未知错误。

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