DsgWhiteListAddOrUpdate - DataWorks - Alibaba Cloud Documentation Center

Adds or modifies 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
WhiteLists	array<object>	Yes	A collection of whitelists.
	object	Yes
RuleId	integer	Yes	The ID of the data masking rule. You can call the DsgDesensPlanQueryList operation to query the ID of the data masking rule.	123
Id	integer	No	The ID of the data masking whitelist. If you do not configure this parameter, the current operation is to add a data masking whitelist. If you configure this parameter, the current operation is to modify a data masking whitelist. You can call the DsgWhiteListQueryList operation to query the whitelist ID.	123
StartTime	string	Yes	The beginning of the time range to query.	2024-04-10 00:00:00
EndTime	string	No	The end of the time range to query. If you enter null, the whitelist is valid permanently.	null
UserGroupIds	array	Yes	A collection of user group IDs.
	integer	No	The user group ID. You can call the DsgUserGroupQueryList operation to query the user group ID.	123

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
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
Data	boolean	The operation result. Valid values: true: The operation is successful. false: The operation fails.	true
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	102400001

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "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.