更新时间：2024-03-29 GMT+08:00
查看规则列表
功能介绍
查询扫描规则列表，返回扫描规则总数和扫描规则列表
URI
GET /v1/{project_id}/sdg/server/scan/rules
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
页码 |
limit |
否 |
Integer |
分页大小 |
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
rules |
Array of ResponseRule objects |
规则列表 |
total |
Integer |
规则总数 |
参数 |
参数类型 |
描述 |
|---|---|---|
category |
String |
规则类别，内置规则(BUILT_IN)或自建规则(BUILT_SELF) 枚举值：
|
delete_allowed |
Boolean |
是否允许删除 |
group_names |
String |
相关的规则组 |
id |
String |
规则ID |
logic_operator |
String |
逻辑运算符，"AND","OR","REGEX" |
min_match |
Integer |
最小匹配次数 |
risk_level |
Integer |
风险等级 |
rule_content |
String |
规则内容 |
rule_desc |
String |
规则描述 |
rule_name |
String |
规则名称 |
rule_type |
String |
规则类型，关键字(KEYWORD)、正则表达式(REGEX)或自然语言(NLP) 枚举值：
|
selected |
Boolean |
是否可选 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询扫描规则列表
GET /v1/{project_id}/sdg/server/scan/rules
响应示例
状态码： 200
请求成功
{
"total" : 1,
"rules" : [ {
"category" : "BUILT_SELF",
"delete_allowed" : true,
"group_names" : "xxxx",
"id" : "xxxxxxxxxxxx",
"logic_operator" : "AND",
"min_match" : 1,
"risk_level" : 1,
"rule_content" : "xxxx",
"rule_desc" : "xxxx",
"rule_name" : "xxxx",
"rule_type" : "KEYWORD",
"selected" : true
} ]
}
状态码： 400
无效请求
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
}
状态码
状态码 |
描述 |
|---|---|
200 |
请求成功 |
400 |
无效请求 |
错误码
请参见错误码。
