文档首页/ 数据安全中心 DSC/ API参考/ API/ API数据安全网关/ 返回所有扫描结果字段 - ShowDbScanResult
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

返回所有扫描结果字段 - ShowDbScanResult

功能介绍

功能介绍：返回所有扫描结果字段

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/server/scan/result

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

job_id

是

String

参数解释：

任务ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

limit

是

Integer

参数解释：

分页大小

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

offset

是

Integer

参数解释：

偏移量

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

show_all

是

Boolean

参数解释：

是否返回全部字段

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

总记录数

取值范围：

不涉及

results

Array of Result objects

参数解释：

扫描结果列表

取值范围：

不涉及

job_id

String

参数解释：

数据库扫描结果响应ID

取值范围：

不涉及

job_name

String

参数解释：

扫描任务名称

取值范围：

不涉及

database_name

String

参数解释：

数据库名称

取值范围：

不涉及

table_name

String

参数解释：

数据库表名

取值范围：

不涉及

column_name

String

参数解释：

数据库列名

取值范围：

不涉及

rules

Array of Rule objects

参数解释：

命中的识别规则列表

取值范围：

不涉及

rule_name_en

String

参数解释：

识别规则英文名称

取值范围：

不涉及

rule_name

String

参数解释：

规则名称

取值范围：

不涉及

rate

Double

参数解释：

敏感数据匹配率

取值范围：

不涉及

level

Integer

参数解释：

数据库扫描结果响应等级

取值范围：

不涉及
表5 Result

参数

参数类型

描述

result

String

参数解释：

执行结果

取值范围：

不涉及
表6 Rule

参数

参数类型

描述

rule_name

String

参数解释：

规则名称

取值范围：

不涉及

请求示例

无

响应示例

状态码：200

{
  "total" : 1,
  "results" : [ {
    "result" : "13800138000"
  } ],
  "job_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
  "job_name" : "customer-db-scan-01",
  "database_name" : "customer_db",
  "table_name" : "customer_info",
  "column_name" : "phone",
  "rules" : [ {
    "rule_name" : "手机号识别规则"
  } ],
  "rule_name_en" : "Phone Number",
  "rule_name" : "手机号识别规则",
  "rate" : 95,
  "level" : 3
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： API数据安全网关

相关文档