文档首页/ 数据安全中心 DSC/ API参考/ API/ 识别规则/ 更新规则 - UpdateScanRules
更新时间:2026-10-20 GMT+08:00
分享

更新规则 - UpdateScanRules

功能介绍

功能介绍:更新识别规则信息。 关键参数说明:通过rule_id定位规则,请求体字段与新增规则一致。 返回值说明:返回操作状态。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

PUT /v1/{project_id}/scan-rules/{rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识用户在数据安全中心控制台中创建的项目

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

rule_id

是

String

参数解释:

规则ID,标识需要更新的识别规则,可通过调用查询规则列表接口获取,或可在数据安全中心控制台的规则管理页面查看

约束限制:

不涉及

取值范围:

长度1~64个字符

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

rule_name

是

String

参数解释:

规则名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

rule_desc

否

String

参数解释:

规则描述

约束限制:

1-255字符

取值范围:

不涉及

默认取值:

不涉及

rule_type

是

String

参数解释:

规则类型

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

category

是

String

参数解释:

类别

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

content

是

Array of ScanRuleContentInfo objects

参数解释:

规则内容列表,指定规则的匹配内容,列表元素为ScanRuleContentInfo对象,包含规则位置、扫描模式、规则内容等信息,详见ScanRuleContentInfo

约束限制:

数组最大100个元素

取值范围:

数组类型

默认取值:

不涉及

templates

否

Array of CreateTemplateRuleInfo objects

参数解释:

规则模板列表,指定规则关联的识别模板,列表元素为CreateTemplateRuleInfo对象,包含模板ID、分类ID、安全等级ID等信息,详见CreateTemplateRuleInfo

约束限制:

数组最大100个元素

取值范围:

数组类型

默认取值:

不涉及

logic_operator

是

String

参数解释:

逻辑操作符

约束限制:

不涉及

取值范围:

AND-且,OR-或

默认取值:

不涉及

min_match

是

Integer

参数解释:

最小匹配

约束限制:

取值范围1~100

最大值100

最小值1

取值范围:

不涉及

默认取值:

不涉及

match_rate

是

Integer

参数解释:

匹配率,规则内容匹配的比率,以百分比表示,100表示全部匹配

约束限制:

不涉及

取值范围:

1~100之间的整数,单位为百分比(%)

默认取值:

不涉及

whitelist_content

否

Array of ScanRuleContentInfo objects

参数解释:

白名单内容列表,指定规则的白名单匹配内容,列表元素为ScanRuleContentInfo对象,包含规则位置、扫描模式、规则内容等信息,详见ScanRuleContentInfo

约束限制:

不涉及

取值范围:

数组类型

默认取值:

不涉及

whitelist_rule_type

否

String

参数解释:

白名单规则类型

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

whitelist_logic_operator

否

String

参数解释:

白名单逻辑操作符

约束限制:

不涉及

取值范围:

AND-且,OR-或

默认取值:

不涉及

whitelist_min_match

否

Integer

参数解释:

白名单最小匹配

约束限制:

取值范围1~100

最大值100

最小值1

取值范围:

不涉及

默认取值:

不涉及

whitelist_match_rate

否

Integer

参数解释:

白名单匹配比率,白名单规则内容匹配的比率,以百分比表示,100表示全部匹配

约束限制:

不涉及

取值范围:

1~100之间的整数,单位为百分比(%)

默认取值:

不涉及

表4 CreateTemplateRuleInfo

参数

是否必选

参数类型

描述

template_id

是

String

参数解释:

模板ID,标识规则关联的识别模板,可通过调用查询模板列表接口获取

约束限制:

不涉及

取值范围:

字符串类型,长度不超过1024个字符

默认取值:

不涉及

classification_id

是

String

参数解释:

分类ID,标识规则归属的数据分类,可通过调用查询数据分类列表接口获取

约束限制:

不涉及

取值范围:

字符串类型,长度不超过1024个字符

默认取值:

不涉及

security_level_id

是

String

参数解释:

安全等级ID,标识规则所属的安全等级,可通过调用查询安全等级列表接口获取

约束限制:

不涉及

取值范围:

字符串类型,长度不超过1024个字符

默认取值:

不涉及

rule_id

是

String

参数解释:

规则ID,标识新增的识别规则,可通过创建规则接口返回获取,或通过查询规则列表接口获取

约束限制:

不涉及

取值范围:

字符串类型,长度不超过1024个字符

默认取值:

不涉及

is_used

否

Boolean

参数解释:

是否启用

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 ScanRuleContentInfo

参数

是否必选

参数类型

描述

location

否

String

参数解释:

规则位置

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

effective_mode

否

String

参数解释:

扫描规则内容信息模式

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

rule_content

是

String

参数解释:

规则内容

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态

取值范围:

不涉及

msg

String

参数解释:

操作结果描述信息

取值范围:

不涉及

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

请求示例

更新规则

{
  "rule_name" : "classification-rule-01",
  "rule_desc" : "scan-rule-01",
  "rule_type" : "KEYWORD",
  "category" : "BUILT_IN",
  "content" : [ {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  }, {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  } ],
  "templates" : [ {
    "template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
    "classification_id" : "9a3b4c5d-6e7f-4a8b-3c4d-2e1f0a9b8c7d",
    "security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
    "rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
    "is_used" : true
  }, {
    "template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
    "classification_id" : "9a3b4c5d-6e7f-4a8b-3c4d-2e1f0a9b8c7d",
    "security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
    "rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
    "is_used" : true
  } ],
  "logic_operator" : "AND",
  "min_match" : 100,
  "match_rate" : 100,
  "whitelist_content" : [ {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  }, {
    "location" : "scan-rule-01",
    "effective_mode" : "scan-rule-01",
    "rule_content" : "phone_number"
  } ],
  "whitelist_rule_type" : "OBS",
  "whitelist_logic_operator" : "AND",
  "whitelist_min_match" : 100,
  "whitelist_match_rate" : 100
}

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "更新扫描规则成功",
  "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档