文档首页> 数据安全中心 DSC> API参考> API说明> 敏感数据发现> 查询指定任务扫描结果
更新时间：2024-03-29 GMT+08:00
在线调试
CLI示例
查看PDF

查询指定任务扫描结果

功能介绍

查询指定任务扫描结果

URI

GET /v1/{project_id}/sdg/scan/job/{job_id}/results

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

job_id

是

String

任务ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

页码

limit

否

Integer

分页大小

type

否

String

资产类型

枚举值：

  • DATABASE

  • OBS

  • BIGDATA

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

任务ID

job_name

String

任务名

type

String

查询资产类型

db_scan_result

DbScanResult object

数据库扫描结果

obs_scan_result

ObsScanResult object

OBS扫描结果

es_scan_result

EsScanResult object

ES扫描结果
表4 DbScanResult

参数

参数类型

描述

total

Integer

扫描结果总数

db_scan_results

Array of DbScanResultInfo objects

数据库扫描结果列表
表5 DbScanResultInfo

参数

参数类型

描述

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

表中各列匹配到的规则
表6 DbMatchInfo

参数

参数类型

描述

column_name

String

列名

rule_name

String

匹配的规则名

rule_id

String

匹配的规则ID

rule_risk_level

Integer

匹配规则风险等级

column_line

Array of longs

风险数据行
表7 ObsScanResult

参数

参数类型

描述

total

Integer

扫描结果总数

db_scan_results

Array of ObsScanResultInfo objects

OBS扫描结果列表
表8 ObsScanResultInfo

参数

参数类型

描述

task_id

String

任务ID

bucket_id

String

OBS桶ID

bucket_name

String

OBS桶名称

file_path

String

文件路径

file_name

String

文件名

md5

String

文件md5值

risk_level

Integer

风险等级

sensitive_data_type

Array of strings

风险数据类型
表9 EsScanResult

参数

参数类型

描述

total

Integer

扫描结果总数

db_scan_results

Array of EsScanResultInfo objects

ES扫描结果列表
表10 EsScanResultInfo

参数

参数类型

描述

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

规则匹配具体信息
表11 EsMatchInfo

参数

参数类型

描述

field_name

String

数据字段名

rule_name

String

规则名

rule_id

String

规则ID

rule_risk_level

Integer

规则风险等级

状态码： 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询指定任务扫描结果

GET /v1/{project_id}/sdg/scan/job/{job_id}/results

响应示例

状态码： 200

OK

{
  "job_id" : "xxxxxx",
  "job_name" : "xxxxxx",
  "type" : "DATABASE",
  "db_scan_result" : {
    "total" : 1,
    "db_scan_results" : [ {
      "task_id" : "xxxxxx",
      "db_name" : "xxxxxx",
      "table_id" : "xxxxxx",
      "table_name" : "student",
      "risk_level" : 6,
      "sensitive_data_type" : [ "xxxxxx", "xxxxxx" ],
      "match_info" : [ {
        "column_name" : "phone",
        "rule_name" : "xxxxxx",
        "rule_id" : "xxxxxx",
        "rule_risk_level" : 6,
        "column_line" : [ 1, 3 ]
      }, {
        "column_name" : "email",
        "rule_name" : "xxxxxx",
        "rule_id" : "xxxxxx",
        "rule_risk_level" : 1,
        "column_line" : [ 1, 3 ]
      } ]
    } ]
  },
  "obs_scan_result" : null,
  "es_scan_result" : null
}

状态码： 400

无效请求

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

状态码

状态码

描述

200

OK

400

无效请求

错误码

请参见错误码。

父主题： 敏感数据发现