调用AddRecognizeRule接口新增数据保护伞分类分级定义的敏感字段。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
| Action | String | 是 | AddRecognizeRule | 系统规定参数。取值：AddRecognizeRule。 |
| TenantId | String | 否 | 10241024 | 租户ID。您可登录DataWorks控制台，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。 |
| AccountName | String | 否 | dsg-uat | 创建敏感数据识别规则的阿里云用户。此处填写用户名称。 |
| SensitiveName | String | 否 | 姓名 | 自定义的敏感字段名称。输入长度小于128的字符串。 |
| TemplateId | String | 否 | e1970541-6cf5-4d23-b101-d5b66f6e1024 | 模板ID。调用QueryDefaultTemplate接口获取当前默认的模板ID。 |
| NodeId | String | 否 | 0ce67949-0810-400f-a24a-cc5ffafe1024 | 分类结点ID。可调用QuerySensClassification接口获取所有结点ID，选择一个结点新建敏感字段。此处输入所选的结点ID。 |
| NodeParent | String | 否 | 客户/个人/个人自然信息/个人基本概况信息 | 分类结点的父结点信息。可调用QuerySensClassification接口获取。 |
| Level | String | 否 | 1 | 敏感字段分级。根据模板定义的分级信息，选择其中一级作为新增敏感字段的等级。例如1~10级。 |
| LevelName | String | 否 | 机密 | 分级名称。可调用QueryDefaultTemplate接口，获取所选分级在模板中对应的分级名称。 |
| SensitiveDescription | String | 否 | 这是一个识别姓名的敏感字段 | 敏感字段描述。长度小于128的字符串。 |
| OperationType | Integer | 否 | 0 | 运算类型。取值如下：
|
| RecognizeRulesType | String | 否 | 1 | 敏感数据识别规则类型：
|
| RecognizeRules | String | 否 | {"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"} | 敏感数据识别规则内容。可调用QuerySensNodeInfo接口，参考内置规则同字段的配置。 |
| ContentScan | String | 否 | {"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"} | 内容识别。可通过调用QuerySensNodeInfo接口，参考内置规则的同字段配置。 |
| HitThreshold | Integer | 否 | 50 | 命中阈值。若抽样数据中，超过阈值百分比（例如，60%）的数据命中NER模型，则认为命中该敏感字段。取值：0~100之间的整数。 |
| ColScan | String | 否 | default.qujian.* | 字段扫描，仅识别赋值的字段。
|
| ColExclude | String | 否 | default.qujian.*6 | 字段排除，即不识别赋值的字段。
|
| CommentScan | String | 否 | test | 内容扫描。取值为您的数据资产中每个字段注释信息的文本，支持模糊匹配。 |
| Status | Integer | 否 | 0 | 敏感字段的生效状态。取值如下：
|
返回数据
名称 |
类型 |
示例值 |
描述 |
| Success | Boolean | true | 调用是否成功。
|
| ErrorCode | String | 9990030003 | 错误码。 |
| ErrorMessage | String | 缺少参数 | 错误信息。 |
| HttpStatusCode | Integer | 200 | HTTP状态码。 |
| Data | Any | { "HttpStatusCode": 200, "Success": true } | 返回结果，JSON格式数据。 |
| RequestId | String | 10000001 | 请求ID，一次请求的唯一标识。 |
示例
请求示例
http(s)://[Endpoint]/?Action=AddRecognizeRule
&TenantId=10241024
&AccountName=dsg-uat
&SensitiveName=姓名
&TemplateId=e1970541-6cf5-4d23-b101-d5b66f6e1024
&NodeId=0ce67949-0810-400f-a24a-cc5ffafe1024
&NodeParent=客户/个人/个人自然信息/个人基本概况信息
&Level=1
&LevelName=机密
&SensitiveDescription=这是一个识别姓名的敏感字段
&OperationType=0
&RecognizeRulesType=1
&RecognizeRules={"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}
&ContentScan={"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}
&HitThreshold=50
&ColScan=default.qujian.*
&ColExclude=default.qujian.*6
&CommentScan=test
&Status=0
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AddRecognizeRuleResponse>
<Success>true</Success>
<ErrorCode>9990030003</ErrorCode>
<ErrorMessage>缺少参数</ErrorMessage>
<HttpStatusCode>200</HttpStatusCode>
<Data>{ "HttpStatusCode": 200, "Success": true }</Data>
<RequestId>10000001</RequestId>
</AddRecognizeRuleResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Success" : true,
"ErrorCode" : "9990030003",
"ErrorMessage" : "缺少参数",
"HttpStatusCode" : 200,
"Data" : "{ \"HttpStatusCode\": 200, \"Success\": true }",
"RequestId" : "10000001"
}错误码
|
HttpCode |
错误码 |
错误信息 |
描述 |
| 400 | BADPARAMETERS | Parameters are missing or in the wrong format. | 缺少参数 |
访问错误中心查看更多错误码。