规则测试 - CreateTest
功能介绍
功能介绍：对规则配置进行测试，验证规则能否正确识别指定测试数据。 关键参数说明：category（内置/自定义）和data（测试内容）必填。 返回值说明：返回是否匹配及匹配分组。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/scan-rules/test
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目ID，标识用户在数据安全中心控制台中创建的项目 约束限制： 不涉及 取值范围： 长度为32个字符的字符串 默认取值： 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token，用于接口请求鉴权，可通过调用IAM服务查询用户Token接口获取 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| location | 否 | String | 参数解释： 测试位置 约束限制： 最大长度1024字符 取值范围： 不涉及 默认取值： 不涉及 |
| effective_mode | 否 | String | 参数解释： 测试模式 约束限制： 最大长度1024字符 取值范围： 不涉及 默认取值： 不涉及 |
| rule_content | 否 | Array of strings | 参数解释： 规则内容列表，用于规则测试的匹配内容，列表中每个元素为一条规则表达式字符串 约束限制： 不涉及 取值范围： 数组类型 默认取值： 不涉及 |
| category | 是 | String | 参数解释： 类别 约束限制： 最大长度1024字符 取值范围： 不涉及 默认取值： 不涉及 |
| data | 是 | String | 参数解释： 测试内容 约束限制： 最大长度1024字符 取值范围： 不涉及 默认取值： 不涉及 |
| rule_id | 否 | String | 参数解释： 规则ID，标识需要测试的识别规则，可通过调用查询规则列表接口获取，或可在数据安全中心控制台规则管理页面查看 约束限制： 不涉及 取值范围： 字符串类型 默认取值： 不涉及 |
| rule_name | 否 | String | 参数解释： 规则名称 约束限制： 最大长度1024字符 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| is_match | Integer | 参数解释： 是否匹配，0-不匹配，1-匹配 取值范围： 0或1 |
| match_group | String | 参数解释： 匹配分组 取值范围： 不涉及 |
请求示例
规则测试
{
"location" : "resource-01",
"effective_mode" : "resource-01",
"rule_content" : [ "phone_number" ],
"category" : "BUILT_IN",
"data" : "resource-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_name" : "classification-rule-01"
} 响应示例
状态码：200
{
"is_match" : 1,
"match_group" : "resource-01"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。
