ListDesensitizationRule - Data Management - Alibaba Cloud Documentation Center

Queries a list of masking rules.

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	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 100.	20
RuleType	string	No	The algorithm used for masking.	HASH
FuncType	string	No	The type of the masking algorithm.	MD5
RuleName	string	No	The name of the masking rule.	default desensitization rule test
RuleId	integer	No	The ID of the masking rule.	1
Tid	long	No	The ID of the tenant. 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 View information about the current tenant.	3***

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned. By default, this parameter is not returned.	1
RequestId	string	The ID of the request.	E76DD2E7-EBAC-5724-B163-19AAC233F8F2
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
DesensitizationRuleList	array<object>	The list of masking rules.
DesensitizationRule	object
RuleName	string	The name of the masking rule.	default desensitization rule test
RuleType	string	The algorithm used for masking.	HASH
RuleDesc	string	The description of the rule.	hash desensitization algorithm
FunctionType	string	The algorithm type.	MD5
FuncParams	string	The parameter.	{paramName: salt, paramValue: 1}
FuncSample	string	The example.	[{paramName: testStr, paramValue: 1}]
LastModifierId	string	The ID of the user who last modified the masking rule.	2
LastModifierName	string	The name of the user who last modified the masking rule.	test user
ReferenceCount	integer	The number of times that the masking was used.	1
RuleId	integer	The ID of the masking rule.	23

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "E76DD2E7-EBAC-5724-B163-19AAC233F8F2",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "DesensitizationRuleList": [
    {
      "RuleName": "default desensitization rule test",
      "RuleType": "HASH",
      "RuleDesc": "hash desensitization algorithm",
      "FunctionType": "MD5",
      "FuncParams": "{paramName: salt, paramValue: 1}",
      "FuncSample": "[{paramName: testStr, paramValue: 1}]",
      "LastModifierId": "2",
      "LastModifierName": "test user",
      "ReferenceCount": 1,
      "RuleId": 23
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history