获取指定project_id 和 job_id下的扫描结果 - ListResults
功能介绍
功能介绍:获取指定project_id 和 job_id下的扫描结果
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/scan/job/{job_id}/results
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32。 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 作业ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 不涉及 取值范围: 不涉及 默认取值: 100 |
| offset | 否 | Integer | 参数解释: 分页偏移 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| type | 否 | String | 参数解释: 结果类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: DATABASE |
| start_time | 否 | String | 参数解释: 开始时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| end_time | 否 | String | 参数解释: 结束时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释: 扫描结果响应ID 取值范围: 不涉及 |
| job_name | String | 参数解释: 扫描结果响应名称 取值范围: 不涉及 |
| type | String | 参数解释: 结果类型 取值范围: 不涉及 |
| asset_infos | Array of AssetInfo objects | 参数解释: 资产信息列表 取值范围: 不涉及 |
| db_scan_result | DbScanResult object | 参数解释: 数据库扫描结果 取值范围: 不涉及 |
| obs_scan_result | ObsScanResult object | 参数解释: OBS扫描结果 取值范围: 不涉及 |
| es_scan_result | EsScanResult object | 参数解释: ES扫描结果 取值范围: 不涉及 |
| asset_id | String | 参数解释: 资产ID 取值范围: 不涉及 |
| asset_type | String | 参数解释: 资产类型 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| db_scan_results | Array of DbScanResultInfo objects | 参数解释: 数据库扫描结果 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
| db_name | String | 参数解释: 数据库名称 取值范围: 不涉及 |
| table_id | String | 参数解释: 数据库扫描结果信息ID 取值范围: 不涉及 |
| table_name | String | 参数解释: 数据库扫描结果信息名称 取值范围: 不涉及 |
| risk_level | Integer | 参数解释: 数据库扫描结果信息等级 取值范围: 不涉及 |
| sensitive_data_type | Array of strings | 参数解释: 敏感数据类型 取值范围: 不涉及 |
| match_info | Array of DbMatchInfo objects | 参数解释: 匹配信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| column_name | String | 参数解释: 数据库匹配信息名称 取值范围: 不涉及 |
| rule_name | String | 参数解释: 规则名称 取值范围: 不涉及 |
| rule_id | String | 参数解释: 规则ID 取值范围: 不涉及 |
| rule_risk_level | Integer | 参数解释: 规则风险级别 取值范围: 不涉及 |
| column_line | Array of longs | 参数解释: 列行 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| obs_scan_results | Array of ObsScanResultInfo objects | 参数解释: OBS扫描结果 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
| bucket_id | String | 参数解释: 桶ID 取值范围: 不涉及 |
| bucket_name | String | 参数解释: 桶名称 取值范围: 不涉及 |
| file_path | String | 参数解释: 文件路径 取值范围: 不涉及 |
| file_name | String | 参数解释: 文件名称 取值范围: 不涉及 |
| md5 | String | 参数解释: MD5校验值 取值范围: 不涉及 |
| risk_level | Integer | 参数解释: 风险级别 取值范围: 不涉及 |
| sensitive_data_type | Array of strings | 参数解释: 敏感数据类型 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| es_scan_results | Array of EsScanResultInfo objects | 参数解释: ES扫描结果 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
| index_name | String | 参数解释: 索引名称 取值范围: 不涉及 |
| type_id | String | 参数解释: 类型ID 取值范围: 不涉及 |
| type_name | String | 参数解释: 类型名称 取值范围: 不涉及 |
| risk_level | Integer | 参数解释: 风险级别 取值范围: 不涉及 |
| sensitive_data_type | Array of strings | 参数解释: 敏感数据类型 取值范围: 不涉及 |
| match_info | Array of EsMatchInfo objects | 参数解释: 匹配信息 取值范围: 不涉及 |
请求示例
获取指定project_id 和 job_id下的扫描结果
/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/scan/job/{job_id}/results 响应示例
状态码:200
{
"job_id" : "3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d",
"job_name" : "scan-job-01",
"type" : "OBS",
"asset_infos" : [ {
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
}, {
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
} ],
"db_scan_result" : {
"total" : 100,
"db_scan_results" : [ {
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"db_name" : "database-01",
"table_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"table_name" : "user_info_table",
"risk_level" : 3,
"sensitive_data_type" : [ "OBS" ],
"match_info" : [ {
"column_name" : "phone_number",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3,
"column_line" : [ 1, 2 ]
}, {
"column_name" : "phone_number",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3,
"column_line" : [ 1, 2 ]
} ]
}, {
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"db_name" : "database-01",
"table_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"table_name" : "user_info_table",
"risk_level" : 3,
"sensitive_data_type" : [ "OBS" ],
"match_info" : [ {
"column_name" : "phone_number",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3,
"column_line" : [ 1, 2 ]
}, {
"column_name" : "phone_number",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3,
"column_line" : [ 1, 2 ]
} ]
} ]
},
"obs_scan_result" : {
"total" : 100,
"obs_scan_results" : [ {
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"bucket_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"bucket_name" : "obs-bucket-01",
"file_path" : "/data/user_info",
"file_name" : "classification-result-20231114.xlsx",
"md5" : "resource-01",
"risk_level" : 3,
"sensitive_data_type" : [ "OBS" ]
}, {
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"bucket_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"bucket_name" : "obs-bucket-01",
"file_path" : "/data/user_info",
"file_name" : "classification-result-20231114.xlsx",
"md5" : "resource-01",
"risk_level" : 3,
"sensitive_data_type" : [ "OBS" ]
} ]
},
"es_scan_result" : {
"total" : 100,
"es_scan_results" : [ {
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"index_name" : "resource-01",
"type_id" : "0b4c5d6e-7f8a-4b9c-4d5e-3f2a1b0c9d8e",
"type_name" : "resource-01",
"risk_level" : 3,
"sensitive_data_type" : [ "OBS" ],
"match_info" : [ {
"field_name" : "resource-01",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3
}, {
"field_name" : "resource-01",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3
} ]
}, {
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"index_name" : "resource-01",
"type_id" : "0b4c5d6e-7f8a-4b9c-4d5e-3f2a1b0c9d8e",
"type_name" : "resource-01",
"risk_level" : 3,
"sensitive_data_type" : [ "OBS" ],
"match_info" : [ {
"field_name" : "resource-01",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3
}, {
"field_name" : "resource-01",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3
} ]
} ]
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。