Modifies the masking rule bound to a specified field.

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 ModifyDesensitizationStrategy

The operation that you want to perform. Set the value to ModifyDesensitizationStrategy.

DbId Integer Yes 123

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

IsLogic Boolean Yes false

Specifies whether the database is a logical database. Valid values:

  • true: The database is a physical database.
  • false: The database is a logical database.
SchemaName String Yes test_schema

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

Note
TableName String Yes test_table

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.
ColumnName String Yes test_column

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.
RuleId Integer No 53

The ID of the masking rule.

IsReset Boolean No false

Specifies whether to reset the masking rule. Valid values:

  • true: resets the masking rule.
  • false: does not reset the masking rule. This is the default value.
Tid Long No 3***

The ID of the tenant.

Note To view the ID of the tenant, go 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.

Response parameters

Parameter Type Example Description
RequestId String 283C461F-11D8-48AA-B695-DF092DA32AF3

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 false

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
Result Boolean True

The returned result.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ModifyDesensitizationStrategy
&DbId=123
&IsLogic=false
&Common request parameters

Sample success responses

XML format

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

<ModifyDesensitizationStrategyResponse>
    <RequestId>283C461F-11D8-48AA-B695-DF092DA32AF3</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>false</Success>
    <Result>true</Result>
</ModifyDesensitizationStrategyResponse>

JSON format

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

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

Error codes

For a list of error codes, visit the API Error Center.