文档首页/ 数据安全中心 DSC/ API参考/ API说明/ 敏感数据识别/ 获取敏感数据识别结果Top10命中规则
更新时间:2025-08-01 GMT+08:00
分享

获取敏感数据识别结果Top10命中规则

功能介绍

根据指定的任务ID和项目ID,获取敏感数据识别结果中Top10命中规则的信息,包括规则ID、名称、命中次数和敏感信息对象名称。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

job_id

String

敏感数据识别任务ID,用于标识具体的任务。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

页码,用于分页查询,默认值为0。

limit

Integer

分页大小,用于限制每页返回的结果数量,默认值为100。

keyword

String

敏感信息对象名称关键字,用于模糊查询。

asset_type

String

资源类型,用于过滤结果。

asset_id

String

资产ID,用于过滤结果。

security_level_ids

Array of strings

风险等级ID数组,用于过滤结果。

marker

Array of strings

上一批/下一批信息,用于分页查询。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

统计命中规则总数,表示所有命中规则对象的总数。

hit_rule_list

Array of ClassificationHitInfo objects

命中规则列表,包含每个规则的详细统计信息。

表4 ClassificationHitInfo

参数

参数类型

描述

rule_id

String

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

rule_name

String

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

count

Integer

命中对象的个数。

top_objects

Array of strings

命中对象列表,表示该规则匹配到的敏感对象列表。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,用于唯一标识具体的错误类型。

error_msg

String

错误信息,对错误的详细描述。

请求示例

获取敏感数据识别结果Top10命中规则

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

响应示例

状态码:200

请求成功,返回Top10命中规则信息。

{
  "hit_rule_list" : [ {
    "rule_id" : "xxxxxxxxxxxx",
    "rule_name" : "xxxxxxxxxxxx",
    "count" : 5,
    "top_objects" : [ "xxxx", "xxxxxxx" ]
  } ],
  "total" : 1
}

状态码:400

无效请求,参数格式或内容不符合要求。

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

状态码

状态码

描述

200

请求成功,返回Top10命中规则信息。

400

无效请求,参数格式或内容不符合要求。

错误码

请参见错误码

相关文档