使用AddRecognizeRule新增分类分级敏感字段-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

调用AddRecognizeRule接口新增数据保护伞分类分级定义的敏感字段。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:AddRecognizeRule

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TenantId	string	是	租户 ID。您可登录 DataWorks 控制台，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户 ID。	10241024
AccountName	string	是	创建敏感数据识别规则的阿里云用户。此处填写用户名称。	dsg-uat
SensitiveName	string	是	自定义的敏感字段名称。输入长度小于 128 的字符串。	name
TemplateId	string	是	模板 ID。调用 QueryDefaultTemplate 接口获取当前默认的模板 ID。	e1970541-6cf5-4d23-b101-****
NodeId	string	是	分类结点 ID。可调用 QuerySensClassification 接口获取所有结点 ID，选择一个结点新建敏感字段。此处输入所选的结点 ID。	0ce67949-0810-400f-a24a-****
NodeParent	string	是	分类结点的父结点信息。可调用 QuerySensClassification 接口获取。	Customer/personal/personal_Natural _Information/personal basic_profile_information
Level	string	是	敏感字段分级。根据模板定义的分级信息，选择其中一级作为新增敏感字段的等级。例如 1~10 级。	1
LevelName	string	否	分级名称。可调用 QueryDefaultTemplate 接口，获取所选分级在模板中对应的分级名称。注意：当前服务实际要求提供此参数；省略时返回 400（InternalError.Bad.Parameters：levelName not empty）。	Confidential
SensitiveDescription	string	否	敏感字段描述。长度小于 128 的字符串。	This is a sensitive field that identifies the name.
OperationType	integer	是	运算类型。取值如下： 0：或 1：与	0
RecognizeRulesType	string	否	敏感数据识别规则类型： 1：正则表达式。 2：内置规则。 3：样本库。 4：自生成模型。	1
RecognizeRules	string	否	敏感数据识别规则内容。可调用 QuerySensNodeInfo 接口，参考内置规则同字段的配置。	{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}
ContentScan	string	否	内容识别。可通过调用 QuerySensNodeInfo 接口，参考内置规则的同字段配置。	{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}
HitThreshold	integer	否	命中阈值。若抽样数据中，超过阈值百分比（例如，60%）的数据命中 NER 模型，则认为命中该敏感字段。取值：0~100 之间的整数。	50
ColScan	string	否	字段扫描，仅识别赋值的字段。取值格式：${项目空间}.${表名}.${字段名}或${项目空间}.${SCHEMA}.${表名}.${字段名}。支持通配符，如 default.table.column1可以匹配 default.table.column10 等*后面的任意内容。	default.qujian.*
ColExclude	string	否	字段排除，即不识别赋值的字段。取值格式：${项目空间}.${表名}.${字段名}或${项目空间}.${SCHEMA}.${表名}.${字段名}。支持通配符，如 default.table.column1可以匹配 default.table.column10 等*后面的任意内容。	default.qujian.*6
CommentScan	string	否	内容扫描。取值为您的数据资产中每个字段注释信息的文本，支持模糊匹配。	test
Status	integer	否	敏感字段的生效状态。取值如下： 0：草稿。 1：生效。	0

返回参数

名称	类型	描述	示例值
	object	返回数据。
Success	boolean	调用是否成功。 true：成功。 false：失败。	true
ErrorCode	string	错误码。	9990030003
ErrorMessage	string	错误信息。	Missing parameter
HttpStatusCode	integer	HTTP 状态码。	200
Data	any	返回结果，JSON 格式数据。	{ "HttpStatusCode": 200, "Success": true }
RequestId	string	请求 ID，一次请求的唯一标识。	10000001

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	BADPARAMETERS	Parameters are missing or in the wrong format.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。