All Products
Search

This Product

    Data Management:ListDesensitizationRule

    Document Center

    Data Management:ListDesensitizationRule

    Last Updated:Aug 28, 2026

    Queries a list of masking rules.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dms:ListDesensitizationRule

    list

    *All Resource

    *

    		 None None

    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.

    Masking rule test
    RuleId

    integer

    No

    The ID of the masking rule.

    1
    Tid

    integer

    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 elements

    Element

    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.

    object

    RuleName

    string

    The name of the masking rule.

    Masking rule test
    RuleType

    string

    The algorithm used for masking.

    HASH
    RuleDesc

    string

    The description of the rule.

    Hash masking 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

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.