All Products
Search

This Product

    Data Management:AddDesensitizationRule

    Document Center

    Data Management:AddDesensitizationRule

    Last Updated:Apr 26, 2024

    Adds a masking rule.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RuleNamestringYes

    The name of the rule.

    		desensitization algorithm test
    RuleTypestringYes

    The masking algorithm.

    Valid values:

    • PLAINTEXT

    • TRANSFORM

    • ENCRYPT

    • REPLACE

    • HASH

    • MASK

    		HASH
    RuleDescriptionstringNo

    The description of the rule.

    		hash algorithm
    FunctionTypestringYes

    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
    FunctionParamsobject []No

    The parameters of the algorithm.

    objectNo

    The name of the parameter.

    stringNo

    The value of the parameter.

    		{paramName: salt, paramValue: 1}
    TidlongNo

    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

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    ErrorCodestring

    The error code that is returned.

    		UnknownError
    ErrorMessagestring

    The error message that is returned.

    		UnknownError
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    RuleIdinteger

    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 timeSummary of changesOperation
    No change history