AddDesensitizationRule - Data Management - Alibaba Cloud Documentation Center

Adds a masking rule.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:AddDesensitizationRule	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RuleName	string	Yes	The name of the rule.	desensitization algorithm test
RuleType	string	Yes	The masking algorithm. Valid values: PLAINTEXT TRANSFORM ENCRYPT REPLACE HASH MASK	HASH
RuleDescription	string	No	The description of the rule.	hash algorithm
FunctionType	string	Yes	The type of the masking algorithm. Valid values: FIX_POS : masks characters in the specified position. DATE_ROUNDING: rounds the date. PLAINTEXT: does not mask data. SHA1: masks characters by using the secure hash algorithm 1 (SHA-1) HMAC: masks characters by using the hash-based message authentication code (HMAC). STRING_TRANSFORM: shift characters. NUMBER_ROUNDING: rounds numbers. AES: masks characters by using the advanced encryption standard (AES) algorithm. SHA256: masks characters by using SHA-256 algorithm. DES: masks characters by using the data encryption standard (DES) algorithm. MAP_REPLACE: masks the mapped data. FIX_CHAR: masks fixed characters. DEFAULT: masks all characters. RANDOM_REPLACE: randomly replaces characters. MD5: masks characters by using the MD5 algorithm.	MD5
FunctionParams	array<object>	No	The parameters of the algorithm.
	object	No	The name of the parameter.
	string	No	The value of the parameter.	{paramName: salt, paramValue: 1}
Tid	long	No	The tenant ID. Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3***

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code that is returned.	UnknownError
ErrorMessage	string	The error message that is returned.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
RuleId	integer	The ID generated for the data masking rule.	35***

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "RuleId": 0
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history