ListDesensitizationRule -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListDesensitizationRule	The operation that you want to perform. Set the value to ListDesensitizationRule.
PageNumber	Integer	No	1	The number of the page to return.
PageSize	Integer	No	20	The number of entries to return on each page. The maximum value is 100.
RuleType	String	No	HASH	The algorithm used for masking.
FuncType	String	No	MD5	The type of the masking algorithm.
RuleName	String	No	Masking Rule Test	The name of the masking rule.
RuleId	Integer	No	1	The ID of the masking rule.
Tid	Long	No	3***	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.

Response parameters


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

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ListDesensitizationRule
&PageNumber=1
&PageSize=20
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDesensitizationRuleResponse>
    <TotalCount>1</TotalCount>
    <RequestId>E76DD2E7-EBAC-5724-B163-19AAC233F8F2</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
    <DesensitizationRuleList>
        <RuleName>Masking Rule Test</RuleName>
        <RuleType>HASH</RuleType>
        <RuleDesc>Hash algorithm for data masking.</RuleDesc>
        <FunctionType>MD5</FunctionType>
        <FuncParams>{paramName: salt, paramValue: 1}</FuncParams>
        <FuncSample>[{paramName: testStr, paramValue: 1}]</FuncSample>
        <LastModifierId>2</LastModifierId>
        <LastModifierName>Test User</LastModifierName>
        <ReferenceCount>1</ReferenceCount>
        <RuleId>23</RuleId>
    </DesensitizationRuleList>
</ListDesensitizationRuleResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "E76DD2E7-EBAC-5724-B163-19AAC233F8F2",
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "Success" : true,
  "DesensitizationRuleList" : [ {
    "RuleName" : "Masking Rule Test",
    "RuleType" : "HASH",
    "RuleDesc" : "Hash algorithm for data masking.",
    "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 API Error Center.