更新时间:2026-10-09 GMT+08:00
分享

添加规则 - CreateRules

功能介绍

功能介绍:添加规则

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/server/scan/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

id

否

String

参数解释:

资源ID,唯一标识

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

rule_name

否

String

参数解释:

规则名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

rule_type

否

String

参数解释:

规则类型

约束限制:

不涉及

取值范围:

  • KEYWORD-关键字

  • REGEX-正则

  • NLP-自然语言处理

默认取值:

不涉及

logic_operator

否

String

参数解释:

逻辑操作符

约束限制:

不涉及

取值范围:

AND-且,OR-或

默认取值:

不涉及

rule_content

否

String

参数解释:

规则内容

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

risk_level

否

Integer

参数解释:

规则等级

约束限制:

最大值2147483647

取值范围:

不涉及

默认取值:

不涉及

rule_desc

否

String

参数解释:

规则描述

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

category

否

String

参数解释:

类别

约束限制:

不涉及

取值范围:

  • BUILT_IN-内置

  • BUILT_IN_COPY-内置复制

  • BUILT_SELF-自定义

默认取值:

不涉及

min_match

否

Integer

参数解释:

最小匹配

约束限制:

最大值2147483647

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态

取值范围:

不涉及

msg

String

参数解释:

操作结果描述信息

取值范围:

不涉及

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

请求示例

添加规则

{
  "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
  "rule_name" : "classification-rule-01",
  "rule_type" : "KEYWORD",
  "logic_operator" : "scan-rule-01",
  "rule_content" : "phone_number",
  "risk_level" : 3,
  "rule_desc" : "scan-rule-01",
  "category" : "BUILT_IN",
  "min_match" : 100
}

响应示例

状态码:200

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档