更新时间:2025-09-12 GMT+08:00
分享

查询扫描规则详情

功能介绍

根据指定的规则ID和项目ID,查询扫描规则的详细信息,包括规则名称、描述、类型、匹配逻辑等内容。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,用于标识具体的项目。

rule_id

String

规则ID,用于标识具体的扫描规则。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

category

String

规则类别,用于区分内置规则(BUILT_IN)和用户自定义规则(BUILT_SELF)。

content

Array of ScanRuleContentInfo objects

规则内容列表,包含规则的具体内容信息。

create_time

Long

创建时间,表示规则的创建时间戳。

logic_operator

String

逻辑运算符,支持"AND"(与)、"OR"(或)、"REGEX"(正则表达式)。

match_rate

Integer

匹配率,表示规则匹配的准确率或优先级。

min_match

Integer

最小匹配次数,表示规则匹配时需要满足的最小条件。

rule_desc

String

规则描述,对规则功能的简要说明。

rule_id

String

规则ID,用于唯一标识该规则。

rule_name

String

规则名称,用于标识和管理规则。

rule_type

String

规则类型,包括关键字(KEYWORD)、正则表达式(REGEX)或自然语言(NLP)。

templates

Array of ShowRuleTemplateInfo objects

模板关联信息,包含规则与模板的关联详情。

update_time

Long

更新时间,表示规则的最后更新时间戳。

表3 ScanRuleContentInfo

参数

参数类型

描述

effective_mode

String

规则生效模式,表示规则的应用方式。

location

String

规则应用位置,表示规则在数据中的具体应用位置。

rule_content

String

规则内容,表示规则的具体内容。

表4 ShowRuleTemplateInfo

参数

参数类型

描述

classification_id

String

分级分类ID,表示该规则所属的分类。

classification_name

String

分级分类名称,表示该规则所属的分类名称。

id

String

规则模板ID,用于唯一标识该规则模板。

is_used

Boolean

是否启用,表示该规则是否被启用。

rule_id

String

规则ID,用于唯一标识该规则。

security_level_color

Integer

风险等级颜色,用于在界面中显示风险等级的颜色标识。

security_level_id

String

风险等级ID,表示该规则的风险等级。

security_level_name

String

风险等级名称,表示该规则的风险等级的名称。

template_id

String

模板ID,用于标识具体的扫描模板。

template_name

String

模板名称,用于标识和管理模板。

请求示例

响应示例

状态码

状态码

描述

200

请求成功,返回扫描规则的详细信息。

401

未授权,用户未登录或令牌无效。

403

无权限访问该资源。

404

未找到指定的规则。

错误码

请参见错误码

相关文档