All Products
Search

This Product

    Data Management:AddDesensitizationRule

    Document Center

    Data Management:AddDesensitizationRule

    Last Updated:Aug 27, 2026

    Adds a masking rule.

    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:AddDesensitizationRule

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RuleName

    string

    Yes

    The name of the rule.

    Masking algorithm test
    RuleType

    string

    Yes

    The masking algorithm.

    Valid values:

    • PLAINTEXT

    • TRANSFORM

    • ENCRYPT

    • REPLACE

    • HASH

    • MASK

    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.

    Valid values:

    • FIX_POS :
    • DATE_ROUNDING :
    • PLAINTEXT :
    • SHA1 :

      SHA1

    • HMAC :

      HMAC

    • STRING_TRANSFORM :
    • NUMBER_ROUNDING :
    • AES :

      AES

    • SHA256 :

      SHA256

    • DES :

      DES

    • MAP_REPLACE :
    • FIX_CHAR :
    • DEFAULT :
    • RANDOM_REPLACE :
    • MD5 :

      MD5

    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

    integer

    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 elements

    Element

    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

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.