All Products
Search

This Product

    Data Management:ModifyDesensitizationStrategy

    Document Center

    Data Management:ModifyDesensitizationStrategy

    Last Updated:Apr 26, 2024

    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.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    dms:ModifyDesensitizationStrategyRead
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DbIdintegerYes

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

    		123
    IsLogicbooleanYes

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

    • true: The database is a physical database.
    • false: The database is a logical database.
    		false
    SchemaNamestringYes

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

    Note
    		test_schema
    TableNamestringYes

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

    Note You can also call the ListTables operation to obtain the table name.
    		test_table
    ColumnNamestringYes

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

    Note You can also call the ListColumns operation to obtain the field name.
    		test_column
    RuleIdintegerNo

    The ID of the masking rule.

    		53
    IsResetbooleanNo

    Specifies whether to reset the masking rule. Valid value:

    • true: Reset the masking rule.
    • false: Do not reset the masking rule. This is the default value.
    		false
    IsDefaultbooleanNo

    The desensitization algorithm of the field setting. The default value is false. The values are as follows:

    • true: default desensitization algorithm.

    • false :semi-desensitization algorithm.

    		false
    TidlongNo

    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 in the topic "Manage DMS tenants."
    		3***

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

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

    The status code.

    		UnknownError
    ErrorMessagestring

    The error message returned.

    		UnknownError
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		false
    Resultboolean

    The returned result.

    		True

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-08-24The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: IsDefault