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

测试扫描规则

功能介绍

根据指定的规则信息,对敏感数据进行测试识别,验证规则的匹配效果。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/scan-rules/test

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

category

String

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

data

String

待测试数据,表示需要进行扫描测试的具体数据内容。

effective_mode

String

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

location

String

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

rule_content

Array of strings

规则内容列表,包含需要测试的规则内容。

rule_id

String

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

rule_name

String

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

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

is_match

Integer

是否匹配,表示测试数据是否与规则匹配。

match_group

String

匹配组,表示匹配到的具体规则组。

状态码:201

测试识别成功。

请求示例

POST /v1/{project_id}/scan-rules/test

{
  "category" : "string",
  "data" : "string",
  "effective_mode" : "string",
  "location" : "string",
  "rule_content" : [ "string" ],
  "rule_id" : "string",
  "rule_name" : "string"
}

响应示例

状态码

状态码

描述

200

请求成功,返回测试识别结果。

201

测试识别成功。

401

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

403

无权限访问该资源。

404

未找到指定的项目。

错误码

请参见错误码

相关文档