DsgWhiteListQueryList - DataWorks - Alibaba Cloud Documentation Center

Queries a data masking whitelist.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page. Maximum value: 100.	10
SceneId	long	Yes	The ID of the level-2 data masking scenario. You can call the DsgSceneQuerySceneListByName operation to query the list of IDs.	123
DataType	string	No	The keyword of the sensitive field type.	phone

Response parameters

Parameter	Type	Description	Example
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1029030003
ErrorMessage	string	The error message.	param error
HttpStatusCode	integer	The HTTP status code.	400
PageData	object	The pagination information.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of data masking whitelists.	100
Data	array<object>	A collection of whitelists.
Datas	object
Id	long	The ID of the data masking whitelist.	123
Type	string	The sensitive field type.	phone
UserGroups	array	A collection of user group names.
UserGroup	string	The name of the user group.	test_group
GmtCreate	string	The time when the whitelist was created.	2024-05-09 15:46:20
GmtModified	string	The time when the whitelist was modified.	2024-05-09 15:46:20
RuleId	long	The ID of the data masking rule.	123
SceneId	long	The ID of the level-2 data masking scenario.	123
StartTime	string	The time when the data masking whitelist takes effect cannot be earlier than the current time. Unit: days.	2024-05-09 15:46:20
EndTime	string	The expiration time of the data masking whitelist cannot be earlier than the time when the data masking whitelist takes effect. Unit: days.	2024-05-10 15:46:20
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	102400001

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
400	WHITELIST.DESENSID.ERROR	The desensitization rule ID does not match or does not exist with the tenant.	The scenario ID does not exist or does not belong to the tenant.
400	WHITELIST.ENDTIME.ERROR	end time cannot be earlier than start time.	The end time cannot be earlier than the start time.
400	WHITELIST.ID.ERROR	The whitelist ID does not match or does not exist with the tenant.	The whitelist ID does not exist or does not belong to the tenant.
400	WHITELIST.MCPROJECT.ERROR	The projectName on the bottom layer desensitization whitelist of MC cannot be empty.	ProjectName cannot be empty when creating MC desensitization whitelist
400	WHITELIST.PAGESIZE.ERROR	Page size is too large, maximum of 100.	Page size exceeded, cannot exceed 100
400	WHITELIST.SIZE.ERROR	The number of white list exceeds the limit.	Whitelist quantity exceeded
400	WHITELIST.STARTTIME.ERROR	start time cannot be earlier than today.	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.	The time parameter is formatted incorrectly. You need to use yyyy MM dd HH: mm: ss.
400	WHITELIST.USERGROUP.ERROR	The user group ID does not match or does not exist with the tenant.	The user group ID does not exist or does not belong to the tenant.
400	WHITELIST.USERGROUPEMPTY.ERROR	User group ID cannot be empty.	User group ID cannot be empty
400	WHITELIST.USERGROUPLISTSIZE.ERROR	The number of user group exceeds the limit.	The number of user groups exceeds the limit.
400	PARAMS.ERROR	param error.	-
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.
500	UNKNOWN.ERROR	unknown error.	Unknown error.

For a list of error codes, visit the Service error codes.