文档首页/ 数据安全中心 DSC/ API参考/ API/ 任务管理/ 获取分类 - ListHitRules
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取分类 - ListHitRules

功能介绍

功能介绍：获取分类

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32。

默认取值：

不涉及

job_id

是

String

参数解释：

作业ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

template_type

否

String

参数解释：

模板类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

TRADITIONAL

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-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/2b31ed520xxxxxxebedb6e57xxxxxxxx/scan-jobs/{job_id}/hit-rules

响应示例

状态码：200

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 任务管理

相关文档