文档首页/ 数据安全中心 DSC/ API参考/ API/ 扫描任务/ 获取查询单个数据库扫描状态的结果 - ListDataScanStatus
更新时间:2026-11-13 GMT+08:00
分享

获取查询单个数据库扫描状态的结果 - ListDataScanStatus

功能介绍

功能介绍:查询单个数据库的扫描状态。 关键参数说明:database_id、data_connection_id、instance_id、workspace_id必填。 返回值说明:返回数据库ID、是否已配置扫描作业及作业信息。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/data-scan-status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识用户在数据安全中心控制台中创建的项目

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

database_id

是

String

参数解释:

数据库ID,标识本次查询的数据库,可通过调用查询数据库列表接口获取

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

data_connection_id

是

String

参数解释:

数据连接ID,标识本次查询的数据库数据连接,可通过调用查询数据连接列表接口获取

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

instance_id

是

String

参数解释:

实例ID,标识本次查询的数据库实例,可通过调用查询实例列表接口获取

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间ID,标识本次查询的工作空间,可通过调用查询工作空间列表接口获取

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

database_id

String

参数解释:

数据库ID,标识本次扫描的数据库

取值范围:

字符串类型

has_scan_job

Boolean

参数解释:

是否有扫描作业

取值范围:

true-是,false-否

scan_job_info

ScanJobInfo object

参数解释:

扫描作业信息

取值范围:

不涉及

表5 ScanJobInfo

参数

参数类型

描述

job_id

String

参数解释:

扫描作业信息ID

取值范围:

不涉及

job_name

String

参数解释:

扫描作业信息名称

取值范围:

不涉及

rule_groups

Array of RuleGroup objects

参数解释:

规则分组

取值范围:

不涉及

created_time

Long

参数解释:

创建时间,扫描作业的创建时间,为毫秒级Unix时间戳

取值范围:

毫秒级Unix时间戳

last_run_time

Long

参数解释:

上次运行时间,扫描作业上次运行的时间,为毫秒级Unix时间戳

取值范围:

毫秒级Unix时间戳

status

String

参数解释:

操作结果状态

取值范围:

不涉及

num_of_tables_scanned

Long

参数解释:

已扫描表数量

取值范围:

不涉及

表6 RuleGroup

参数

参数类型

描述

id

String

参数解释:

规则组ID,标识规则组的唯一标识

取值范围:

不涉及

name

String

参数解释:

规则组名称

取值范围:

不涉及

name_en

String

参数解释:

规则组英文名称

取值范围:

不涉及

is_default

Boolean

参数解释:

是否为默认规则组,标识该规则组是否为默认分组

取值范围:

true-是,false-否

请求示例

获取查询单个数据库扫描状态的结果

/v1/2b31ed520aabbccddeedb6e571234567/data-scan-status?database_id=8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c&data_connection_id=8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c&instance_id=8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c&workspace_id=8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c

响应示例

状态码:200

{
  "database_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
  "has_scan_job" : true,
  "scan_job_info" : {
    "job_id" : "3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d",
    "job_name" : "scan-job-01",
    "rule_groups" : [ {
      "id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
      "name" : "status-01",
      "name_en" : "status-01",
      "is_default" : true
    } ],
    "created_time" : 1700000000000,
    "last_run_time" : 1700000000000,
    "status" : "FINISHED",
    "num_of_tables_scanned" : 10
  }
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档