识别结果修正 - UpdateClassificationResults
功能介绍
功能介绍:修正扫描作业的分类识别结果,可调整资产的安全等级及命中规则信息。 关键参数说明:请求体需携带分类结果ID及修正后的安全等级、命中规则等信息。 返回值说明:返回操作状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/scan-jobs/{job_id}/classification-results
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 扫描作业ID,标识识别结果对应的扫描作业,可通过调用查询扫描作业列表接口获取,或通过创建扫描作业接口的返回值获取 约束限制: 不涉及 取值范围: 长度1~64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 否 | String | 参数解释: 识别结果资源ID,标识待修正的识别结果记录,可通过调用查询识别结果列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| project_id | 否 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目,获取方式可参考获取项目ID相关文档 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| job_id | 否 | String | 参数解释: 扫描作业ID,标识识别结果对应的扫描作业,可通过调用查询扫描作业列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| task_id | 否 | String | 参数解释: 扫描任务ID,标识识别结果对应的扫描任务,可通过调用查询扫描任务列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| ins_id | 否 | String | 参数解释: 实例ID,标识识别结果所属的实例,可通过调用查询实例列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| asset_id | 否 | String | 参数解释: 资产ID,标识识别结果所属的资产,可通过调用查询资产列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| asset_name | 否 | String | 参数解释: 资产名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| asset_type | 否 | String | 参数解释: 资产类型 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| object_name | 否 | String | 参数解释: 对象名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| object_full_path | 否 | String | 参数解释: 对象完整路径 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| security_level_name | 否 | String | 参数解释: 安全等级名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| security_level_id | 否 | String | 参数解释: 安全级别ID,标识识别结果的安全等级,可通过调用查询安全等级列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| security_level_color | 否 | Integer | 参数解释: 安全等级颜色编码,用于表示安全等级对应的显示颜色 约束限制: 不涉及 取值范围: 整数值,为颜色编码值 默认取值: 不涉及 |
| create_time | 否 | Long | 参数解释: 创建时间,识别结果记录的创建时间,为Unix时间戳,单位为毫秒 约束限制: 不涉及 取值范围: 毫秒级Unix时间戳 默认取值: 不涉及 |
| update_time | 否 | Long | 参数解释: 更新时间,识别结果记录的更新时间,为Unix时间戳,单位为毫秒 约束限制: 不涉及 取值范围: 毫秒级Unix时间戳 默认取值: 不涉及 |
| scan_time | 否 | Long | 参数解释: 扫描时间,本次扫描执行的时间,为Unix时间戳,单位为毫秒 约束限制: 不涉及 取值范围: 毫秒级Unix时间戳 默认取值: 不涉及 |
| match_info | 否 | Array of ClassificationMatchReqInfo objects | 参数解释: 匹配信息列表,指定识别结果的匹配明细,列表元素为ClassificationMatchReqInfo对象,包含规则ID、分类ID等匹配详情信息 约束限制: 不涉及 取值范围: 数组类型 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| template_id | 否 | String | 参数解释: 模板ID,标识识别结果对应的识别模板,可通过调用查询模板列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| template_name | 否 | String | 参数解释: 模板名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| rule_id | 否 | String | 参数解释: 规则ID,标识匹配的识别规则,可通过调用查询规则列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| rule_name | 否 | String | 参数解释: 规则名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| security_level_name | 否 | String | 参数解释: 安全等级名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| security_level_id | 否 | String | 参数解释: 安全级别ID,标识识别结果的安全等级,可通过调用查询安全等级列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| security_level_color | 否 | Integer | 参数解释: 安全等级颜色编码,用于表示安全等级对应的显示颜色 约束限制: 不涉及 取值范围: 整数值,为颜色编码值 默认取值: 不涉及 |
| classification_name | 否 | String | 参数解释: 分类匹配请求信息名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| classification_id | 否 | String | 参数解释: 分类ID,标识匹配结果归属的数据分类,可通过查询分类匹配信息接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| matched_detail | 否 | String | 参数解释: 匹配详情 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| match_content_cnt | 否 | Integer | 参数解释: 匹配内容数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| match_rate | 否 | Double | 参数解释: 匹配率,标识规则匹配结果的比例 约束限制: 不涉及 取值范围: 浮点数,以百分比表示,取值范围0~100 默认取值: 不涉及 |
| manual_modify | 否 | Boolean | 参数解释: 是否人工修改 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| matched_examples | 否 | Array of MatchedReqExamples objects | 参数解释: 匹配示例列表,展示匹配命中的敏感数据示例,列表元素为MatchedReqExamples对象,包含行号、匹配内容等信息 约束限制: 不涉及 取值范围: 数组类型 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
识别结果修正
{
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"project_id" : "2d52d09a-f0d3-4c1a-86b4-fc7e435e9c7a",
"job_id" : "3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d",
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"ins_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"asset_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
"asset_name" : "asset-obs-01",
"asset_type" : "OBS",
"object_name" : "user_info_table",
"object_full_path" : "/data/user_info",
"security_level_name" : "classification-result-01",
"security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
"security_level_color" : 3,
"create_time" : 1700000000000,
"update_time" : 1700000000000,
"scan_time" : 1700000000000,
"match_info" : [ {
"template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
"template_name" : "scan-template-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_name" : "classification-rule-01",
"security_level_name" : "classification-result-01",
"security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
"security_level_color" : 3,
"classification_name" : "classification-result-01",
"classification_id" : "9a3b4c5d-6e7f-4a8b-3c4d-2e1f0a9b8c7d",
"matched_detail" : "classification-result-01",
"match_content_cnt" : 100,
"match_rate" : 0.85,
"manual_modify" : true,
"matched_examples" : [ {
"line_number" : 10,
"matched_content" : "\\d{11}",
"context" : "classification-result-01"
}, {
"line_number" : 10,
"matched_content" : "\\d{11}",
"context" : "classification-result-01"
} ]
}, {
"template_id" : "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b",
"template_name" : "scan-template-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_name" : "classification-rule-01",
"security_level_name" : "classification-result-01",
"security_level_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
"security_level_color" : 3,
"classification_name" : "classification-result-01",
"classification_id" : "9a3b4c5d-6e7f-4a8b-3c4d-2e1f0a9b8c7d",
"matched_detail" : "classification-result-01",
"match_content_cnt" : 100,
"match_rate" : 0.85,
"manual_modify" : true,
"matched_examples" : [ {
"line_number" : 10,
"matched_content" : "\\d{11}",
"context" : "classification-result-01"
}, {
"line_number" : 10,
"matched_content" : "\\d{11}",
"context" : "classification-result-01"
} ]
} ]
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "更新分类结果成功",
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。