文档首页/ 数据安全中心 DSC/ API参考/ API/ 扫描任务/ 获取分类 - ListHitRules
更新时间:2026-11-13 GMT+08:00
分享

获取分类 - ListHitRules

功能介绍

功能介绍:获取指定扫描作业的分类命中规则统计,支持按模板类型过滤。 关键参数说明:template_type指定模板类型(TRADITIONAL传统/MMP智能),默认TRADITIONAL。 返回值说明:返回命中规则总数及各规则的命中数量、TOP对象。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/scan-jobs/{job_id}/hit-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

job_id

是

String

参数解释:

扫描作业ID,标识需要获取分类命中规则的扫描作业,可通过创建扫描作业接口获取,或通过查询扫描作业列表接口获取

约束限制:

不涉及

取值范围:

长度1~64个字符

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

分页大小,每页返回的分类结果条数

约束限制:

取值范围 1 至 10000

取值范围:

1~10000

默认取值:

1000

offset

否

Integer

参数解释:

分页偏移量,用于指定查询结果的起始位置

约束限制:

大于等于 0

取值范围:

0~2147483647

默认取值:

0

keyword

否

String

参数解释:

关键字,用于按关键字过滤分类结果

约束限制:

最大长度255字符

取值范围:

不涉及

默认取值:

不涉及

asset_type

否

String

参数解释:

资产类型,用于按资产类型过滤分类结果

约束限制:

必须是支持的资产类型枚举值

取值范围:

不涉及

默认取值:

不涉及

asset_id

否

String

参数解释:

资产ID,用于按资产过滤分类结果

约束限制:

必须为UUID格式

取值范围:

不涉及

默认取值:

不涉及

database_name

否

String

参数解释:

数据库名称,用于按数据库过滤分类结果

约束限制:

最大长度255字符

取值范围:

不涉及

默认取值:

不涉及

table_name

否

String

参数解释:

表名称,用于按数据表过滤分类结果

约束限制:

最大长度255字符

取值范围:

不涉及

默认取值:

不涉及

filter_bucket_name

否

String

参数解释:

桶名称,用于按OBS桶过滤分类结果

约束限制:

最大长度255字符

取值范围:

不涉及

默认取值:

不涉及

sort

否

String

参数解释:

排序字段,用于指定分类结果的排序方式

约束限制:

仅支持asc或desc

取值范围:

  • asc-升序

  • desc-降序

默认取值:

不涉及

time_sort

否

String

参数解释:

时间排序,用于按时间字段对分类结果排序

约束限制:

仅支持asc或desc

取值范围:

  • asc-升序

  • desc-降序

默认取值:

不涉及

match_rate_sort

否

String

参数解释:

匹配率排序,用于按匹配率对分类结果排序

约束限制:

仅支持asc或desc

取值范围:

  • asc-升序

  • desc-降序

默认取值:

不涉及

security_level_ids

否

Array of strings

参数解释:

安全等级ID列表,用于按安全等级过滤分类结果

约束限制:

最多100个元素

取值范围:

不涉及

默认取值:

不涉及

marker

否

Array of strings

参数解释:

分页标记,用于指定分页查询的游标位置

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

mask

否

Boolean

参数解释:

是否遮盖敏感内容

约束限制:

不涉及

取值范围:

  • "True" 是

  • "False" 否

默认取值:

false

is_new

否

Boolean

参数解释:

是否仅查询新增的分类结果

约束限制:

不涉及

取值范围:

  • "True" 是

  • "False" 否

默认取值:

不涉及

template_type

否

String

参数解释:

模板类型,用于指定查询的分类命中规则对应的识别模板类型

约束限制:

不涉及

取值范围:

  • TRADITIONAL:传统识别模板

  • MMP:智能识别模板

默认取值:

TRADITIONAL

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

hit_rule_list

Array of ClassificationHitInfo objects

参数解释:

命中规则列表

取值范围:

不涉及

表5 ClassificationHitInfo

参数

参数类型

描述

rule_id

String

参数解释:

规则ID

取值范围:

不涉及

rule_name

String

参数解释:

规则名称

取值范围:

不涉及

count

Integer

参数解释:

命中数量

取值范围:

不涉及

top_objects

Array of strings

参数解释:

顶级对象列表,扫描命中规则的顶级数据对象名称列表

取值范围:

数组类型

请求示例

获取分类

/v1/2b31ed520aabbccddeedb6e571234567/scan-jobs/3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d/hit-rules

响应示例

状态码:200

{
  "total" : 1,
  "hit_rule_list" : [ {
    "rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
    "rule_name" : "classification-rule-01",
    "count" : 100,
    "top_objects" : [ "hit-rule-01" ]
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档