AddRecognizeRule-DataWorks(DataWorks)-阿里云帮助中心

Adds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.

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

dataworks:AddRecognizeRule

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	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 Data Studio page. On the Data Studio page, click the logon username in the upper-right corner and click User Info in the Menu section.	10241024
AccountName	string	Yes	The Alibaba Cloud account that is used to create a sensitive data identification rule. Enter the username of the Alibaba Cloud account.	dsg-uat
SensitiveName	string	Yes	The name of the custom sensitive field. Enter a string that is less than 128 characters in length.	name
TemplateId	string	Yes	The template ID. You can call the QueryDefaultTemplate operation to obtain the current default template ID.	e1970541-6cf5-4d23-b101-****
NodeId	string	Yes	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.	0ce67949-0810-400f-a24a-****
NodeParent	string	Yes	The information about the parent data category of the current data category. You can call the QuerySensClassification operation to obtain the parent data category information.	Customer/personal/personal_Natural _Information/personal basic_profile_information
Level	string	Yes	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.	1
LevelName	string	No	The name of the sensitivity level. You can call the QueryDefaultTemplate operation to obtain the name of the sensitivity level in the related template.	Confidential
SensitiveDescription	string	No	The description of the sensitive field. Enter a string that is less than 128 characters in length.	This is a sensitive field that identifies the name.
OperationType	integer	Yes	The type of the logical operation. Valid values: 0: OR 1: AND	0
RecognizeRulesType	string	No	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	1
RecognizeRules	string	No	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.	{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}
ContentScan	string	No	Identifies content. You can call the QuerySensNodeInfo operation to query the value of the current parameter for a built-in sensitive field.	{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}
HitThreshold	integer	No	The hit ratio threshold. If the percentage of sampled data that matches the Named Entity Recognition (NER) model exceeds this threshold (for example, 60%), the data is considered to match the sensitive field. Specify an integer from 0 to 100.	50
ColScan	string	No	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.	default.qujian.*
ColExclude	string	No	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.	default.qujian.*6
CommentScan	string	No	Scans content. The value is the text of each column comment in your data asset. Fuzzy match is supported.	test
Status	integer	No	The status of the sensitive field. Valid values: 0: draft 1: effective	0

Response elements

Element	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful. true false	true
ErrorCode	string	The error code.	9990030003
ErrorMessage	string	The error message.	Missing parameter
HttpStatusCode	integer	The HTTP status code.	200
Data	any	The returned result in the JSON format.	{ "HttpStatusCode": 200, "Success": true }
RequestId	string	The request ID.	10000001

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "9990030003",
  "ErrorMessage": "Missing parameter",
  "HttpStatusCode": 200,
  "Data": "{   \"HttpStatusCode\": 200,   \"Success\": true }",
  "RequestId": "10000001"
}

Error codes

HTTP status code	Error code	Error message	Description
400	BADPARAMETERS	Parameters are missing or in the wrong format.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.