查询指定识别模板的扫描规则列表
功能介绍
根据指定的模板ID和项目ID，查询与该模板关联的扫描规则信息，支持分页查询和多种过滤条件，如关键字、分类ID、风险等级等。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/scan-templates/{template_id}/scan-rules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，用于标识具体的项目。 |
|
template_id |
是 |
String |
模板ID，用于标识具体的扫描模板。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
页码，用于分页查询，默认值为0。 |
|
limit |
否 |
Integer |
分页大小，用于限制每页返回的结果数量，默认值为100。 |
|
keyword |
否 |
String |
敏感信息对象名称关键字，用于模糊查询。 |
|
classification_ids |
否 |
Array of strings |
分类ID数组，用于过滤结果。 |
|
security_level_ids |
否 |
Array of strings |
风险等级ID数组，用于过滤结果。 |
|
is_used |
否 |
Boolean |
是否启用，用于过滤结果。 |
|
rule_name |
否 |
String |
规则名称关键字，用于模糊查询。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Long |
规则总数，表示模板关联的规则数量。 |
|
template_rules_list |
Array of TemplateRule objects |
规则列表，包含每个规则的详细信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rule_id |
String |
规则ID，用于唯一标识该规则。 |
|
project_id |
String |
项目ID，用于标识具体的项目。 |
|
rule_name |
String |
规则名称，用于标识和管理规则。 |
|
template_id |
String |
模板ID，用于标识具体的扫描模板。 |
|
classification_id |
String |
分级分类ID，表示该规则所属的分类。 |
|
security_level_id |
String |
风险等级ID，表示该规则的风险等级。 |
|
security_level_name |
String |
风险等级名称，表示该规则的风险等级的名称。 |
|
security_level_color |
Integer |
风险等级颜色，用于在界面中显示风险等级的颜色标识。 |
|
is_used |
Boolean |
是否启用，表示该规则是否被启用。 |
|
rule_description |
String |
规则描述，对规则功能的简要说明。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，用于唯一标识具体的错误类型。 |
|
error_msg |
String |
错误信息，对错误的详细描述。 |
请求示例
查询模板规则关联关系
GET /v1/{project_id}/scan-templates/{template_id}/scan-rules
响应示例
状态码：200
请求成功，返回模板规则关联关系信息。
{
"template_rules_list" : [ {
"project_id" : "xxxxxxxxxxxx",
"template_id" : "xxxxxxxxxxxx",
"classification_id" : "xxxxxxxxxxxx",
"security_level_id" : "xxxxxxxxxxxx",
"security_level_name" : "L1",
"security_level_color" : 1,
"rule_id" : "xxxxxxxxxxxx",
"rule_name" : "xxxxxxxxxxxx",
"is_used" : true,
"rule_description" : "xxxxxxxxxxxx"
} ],
"total" : 1
}
状态码：400
无效请求，参数格式或内容不符合要求。
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功，返回模板规则关联关系信息。 |
|
400 |
无效请求，参数格式或内容不符合要求。 |
错误码
请参见错误码。
