文档首页/ 数据安全中心 DSC/ API参考/ API/ 扫描任务/ 获取扫描作业下的扫描任务列表 - ListScanJobTasks
更新时间:2026-11-13 GMT+08:00
分享

获取扫描作业下的扫描任务列表 - ListScanJobTasks

功能介绍

功能介绍:获取扫描作业下的扫描任务列表,支持分页。 关键参数说明:通过job_id定位作业;支持limit/offset分页(默认10/0)、workspace_id过滤。 返回值说明:返回任务总数及任务列表(含任务状态、进度、扫描对象数等)。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

job_id

是

String

参数解释:

扫描作业ID,标识需要获取任务列表的扫描作业,可通过调用创建扫描作业接口获取,或通过查询作业列表接口获取

约束限制:

不涉及

取值范围:

长度1~64个字符

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

不涉及

默认取值:

10

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

workspace_id

否

String

参数解释:

工作空间ID,标识任务所属的工作空间,可通过调用查询工作空间列表接口获取,或可在数据安全中心控制台获取

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

tasks

Array of ScanTask objects

参数解释:

任务列表,每个元素为一个ScanTask对象,包含任务ID、任务名称、运行状态、扫描配置等扫描任务信息

取值范围:

数组类型

表5 ScanTask

参数

参数类型

描述

id

String

参数解释:

任务ID,标识扫描任务的唯一标识

取值范围:

不涉及

category

String

参数解释:

任务类别,标识任务的类别

取值范围:

不涉及

asset_name

String

参数解释:

资产名称,标识任务扫描的资产名称

取值范围:

不涉及

asset_id

String

参数解释:

资产ID,标识任务扫描的资产ID

取值范围:

不涉及

start_time

Long

参数解释:

开始时间,任务的开始扫描时间,为毫秒级Unix时间戳

取值范围:

毫秒级Unix时间戳

end_time

Long

参数解释:

结束时间,任务的结束扫描时间,为毫秒级Unix时间戳

取值范围:

毫秒级Unix时间戳

status

String

参数解释:

任务运行状态,标识扫描任务的当前运行状态

取值范围:

  • INIT-初始化

  • WAITING-等待

  • RUNNING-运行中

  • FAILED-失败

  • STOPPED-已停止

  • FINISHED-已完成

  • TERMINATED-已终止

  • QUOTA_RESTRICTED-配额受限

  • OBS_QUOTA_RESTRICTED-OBS配额受限

  • DB_QUOTA_RESTRICTED-DB配额受限

  • LOCKED-已锁定

progress

Integer

参数解释:

扫描进度,任务扫描的进度百分比

取值范围:

不涉及

scanned_object_num

Long

参数解释:

已扫描对象数,标识已扫描的数据对象数量

取值范围:

不涉及

to_be_scanned_object_num

Long

参数解释:

待扫描对象数,标识待扫描的数据对象数量

取值范围:

不涉及

scan_speed

Integer

参数解释:

扫描速度,任务扫描速度

取值范围:

不涉及

skip_object_num

Long

参数解释:

跳过对象数,标识扫描过程中跳过的数据对象数量

取值范围:

不涉及

last_scan_risk

String

参数解释:

上次扫描风险等级,资产上一次扫描出的风险等级

取值范围:

不涉及

security_level_name

String

参数解释:

安全等级名称,任务扫描结果的安全等级名称

取值范围:

不涉及

security_level_color

Integer

参数解释:

安全等级颜色编号,安全等级对应的颜色编号

取值范围:

不涉及

请求示例

获取扫描作业下的扫描任务列表

/v1/2b31ed520aabbccddeedb6e571234567/sdg/scan/job/3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d/task

响应示例

状态码:200

{
  "total" : 1,
  "tasks" : [ {
    "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
    "category" : "OBS",
    "asset_name" : "asset-obs-01",
    "asset_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
    "start_time" : 1700000000000,
    "end_time" : 1700000600000,
    "status" : "FINISHED",
    "progress" : 100,
    "scanned_object_num" : 1500,
    "to_be_scanned_object_num" : 1500,
    "scan_speed" : 300,
    "skip_object_num" : 0,
    "last_scan_risk" : "LOW",
    "security_level_name" : "内部公开",
    "security_level_color" : 3
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档