All Products
Search
Document Center

Data Management:ModifyDesensitizationStrategy

Last Updated:Aug 28, 2026

Modifies the data masking rule that is bound to a field.

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

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

DbId

integer

Yes

The database ID. You can call the ListDatabases operation to query the ID.

123

IsLogic

boolean

Yes

Specifies whether the database is a logical database.

  • true: The database is a physical database.

  • false: The database is a logical database.

false

SchemaName

string

Yes

The name of the database. You can call the ListSensitiveColumns operation to query the database name.

Note

test_schema

TableName

string

Yes

The name of the table. You can call the ListSensitiveColumns operation to query the table name.

Note

You can also call the ListTables operation to query the table name.

test_table

ColumnName

string

Yes

The name of the field. You can call the ListSensitiveColumns operation to query the field name.

Note

You can also call the ListColumns operation to query the field name.

test_column

RuleId

integer

No

The ID of the masking rule.

53

IsReset

boolean

No

Specifies whether to reset the masking rule.

  • true: resets the masking rule.

  • false (default): does not reset the masking rule.

false

IsDefault

boolean

No

Specifies whether to use the default masking algorithm for the field. Default value: false.

  • true: uses the default masking algorithm.

  • false: uses a semi-masking algorithm.

false

Tid

integer

No

The tenant ID.

Note

To view the tenant ID, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.

3***

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

283C461F-11D8-48AA-B695-DF092DA32AF3

ErrorCode

string

The error code returned.

UnknownError

ErrorMessage

string

The error message returned.

UnknownError

Success

boolean

Indicates whether the request was successful.

  • true: The request was successful.

  • false: The request failed.

false

Result

boolean

The result of the operation.

True

Examples

Success response

JSON format

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": false,
  "Result": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.