:AddRecognizeRule

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

The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.

The Alibaba Cloud account that is used to create a sensitive data identification rule. Enter the username of the Alibaba Cloud account.

The name of the custom sensitive field. Enter a string that is less than 128 characters in length.

The template ID. You can call the QueryDefaultTemplate operation to obtain the template ID.

The ID of the data category. You can call the QuerySensClassification operation to query the ID of all data categories. Then, you can select a data category to create a sensitive field. Enter the ID of the selected data category.

The information about the parent data category of the current data category. You can call the QuerySensClassification operation to obtain the ID of a data category.

The sensitivity level of the sensitive field. You can select one from all sensitivity levels that are defined in a template as the sensitivity level of the sensitive field, such as level 1 to level 10.

The name of the sensitivity level. You can call the QueryDefaultTemplate operation to obtain the name of the sensitivity level in the related template.

The description of the sensitive field. Enter a string that is less than 128 characters in length.

The type of the arithmetic operation. Valid values:

• 0: OR
• 1: AND

The type of the sensitive data identification rule. Valid values:

• 1: regular expression
• 2: built-in rule
• 3: sample library
• 4: self-generated data identification model

The content of the sensitive data identification rule. You can call the QuerySensNodeInfo operation to query the value of the current parameter for a built-in sensitive field.

Identifies content. You can call the QuerySensNodeInfo operation to query the value of the current parameter for a built-in sensitive field.

The hit ratio threshold. If more than 60%, which is a sample hit ratio threshold, of all sample data records hit the Name Entity Recognition (NER) model, the sensitive field is hit. The value can be an integer from 0 to 100.

Scans fields. The system identifies only fields that are assigned with values.

• The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.
• Wildcards are supported. For example, the asterisk (*) in default.table.column1* can be used to match any content following default.table.column1, such as default.table.column10.

Excludes fields. The system does not identify fields that are assigned with values.

• The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.
• Wildcards are supported. For example, the asterisk (*) in default.table.column1* can be used to match any content following default.table.column1, such as default.table.column10.

Scans content. The value is the text of each field comment in your data asset. Fuzzy match is supported.

The status of the sensitive field. Valid values:

• 0: draft
• 1: effective

Indicates whether the request was successful.

• true
• false

The error code.

The error message.

The HTTP status code.

The returned result in the JSON format.

The request ID.