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

获取任务列表 - ListJob

功能介绍

功能介绍:获取扫描任务列表(新接口),支持分页。 关键参数说明:支持limit(默认10,1~1000)/offset分页、content过滤、is_new是否查询新任务(默认1)。 返回值说明:返回任务总数及任务列表。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

每页返回的数量限制,用于指定分页查询时每页返回的任务条数,单位为条

约束限制:

不涉及

取值范围:

整数

默认取值:

不涉及

offset

否

Integer

参数解释:

分页偏移量,用于指定分页查询时跳过的记录条数,单位为条

约束限制:

不涉及

取值范围:

整数

默认取值:

不涉及

content

否

String

参数解释:

扫描内容,用于指定任务列表的扫描内容筛选或匹配条件

约束限制:

不涉及

取值范围:

字符串类型

默认取值:

不涉及

is_new

否

Boolean

参数解释:

是否查询新的任务,用于指定任务列表的查询范围

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Long

参数解释:

总记录数,标识符合查询条件的任务记录总量

取值范围:

整数

tasks

Array of ScanJob objects

参数解释:

扫描任务列表,列表元素为ScanJob对象,包含扫描作业的详细信息

取值范围:

数组类型

表5 ScanJob

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

扫描任务名称

取值范围:

不涉及

rule_groups

Array of strings

参数解释:

规则分组列表,列表元素为字符串类型

取值范围:

数组类型

scan_templates

Map<String,String>

参数解释:

扫描模板,为Map<String,String>类型,Key为模板标识,Value为模板名称

取值范围:

Map类型

cycle

String

参数解释:

扫描周期

取值范围:

不涉及

status

String

参数解释:

操作结果状态

取值范围:

  • INIT-初始化

  • WAITING-等待

  • RUNNING-运行中

  • FAILED-失败

  • STOPPED-已停止

  • FINISHED-已完成

  • TERMINATED-已终止

  • QUOTA_RESTRICTED-配额受限

  • OBS_QUOTA_RESTRICTED-OBS配额受限

  • DB_QUOTA_RESTRICTED-DB配额受限

  • LOCKED-已锁定

last_run_time

Long

参数解释:

上次运行时间,为Unix时间戳,单位为毫秒,表示任务上次运行的时间

取值范围:

Unix时间戳,单位为毫秒

create_time

Long

参数解释:

创建时间,为Unix时间戳,单位为秒,表示任务的创建时间

取值范围:

Unix时间戳,单位为秒

last_scan_risk

String

参数解释:

上次扫描风险

取值范围:

不涉及

use_nlp

Boolean

参数解释:

是否使用自然语言处理,标识任务扫描时是否启用NLP技术

取值范围:

true-使用,false-不使用

open

Boolean

参数解释:

是否开启扫描

取值范围:

true-是,false-否

topic_urn

String

参数解释:

主题URN

取值范围:

不涉及

start_time

Long

参数解释:

开始时间,为Unix时间戳,单位为秒,表示任务开始扫描的时间

取值范围:

Unix时间戳,单位为秒

task_source

String

参数解释:

任务来源,标识任务的来源方式或渠道

取值范围:

字符串类型

workspace_id

String

参数解释:

工作空间ID,标识任务所属的工作空间

取值范围:

字符串类型

security_level_name

String

参数解释:

安全等级名称

取值范围:

不涉及

security_level_color

Integer

参数解释:

安全级别颜色,为颜色编码值,标识任务对应安全级别的显示颜色

取值范围:

整数值

asset_infos

Array of AssetInfo objects

参数解释:

资产信息列表,列表元素为AssetInfo对象

取值范围:

数组类型

scan_time_scope

Integer

参数解释:

扫描时间范围,表示任务扫描覆盖的时间范围

取值范围:

整数,单位为天

scan_sensitivity

String

参数解释:

扫描敏感度

取值范围:

  • NULL-空

  • LOW-低

  • MIDDLE-中

  • HIGH-高

template_type

String

参数解释:

扫描作业类型

取值范围:

  • TRADITIONAL-传统识别模板

  • LLM-智能识别模板

scan_mode

String

参数解释:

扫描作业模式

取值范围:

  • FULL-全量扫描

  • INCREMENTAL-增量扫描

progress

Integer

参数解释:

扫描进度,表示任务当前扫描完成的比例

取值范围:

0~100之间的整数,单位为百分比(%)

表6 AssetInfo

参数

参数类型

描述

asset_id

String

参数解释:

资产ID,标识扫描资产的唯一标识

取值范围:

字符串类型

asset_type

String

参数解释:

资产类型,标识扫描资产的类型

取值范围:

不涉及

请求示例

获取任务列表

/v1/2b31ed520aabbccddeedb6e571234567/sdg/scan/job

响应示例

状态码:200

{
  "total" : 1,
  "tasks" : [ {
    "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
    "name" : "scan-job-01",
    "rule_groups" : [ "scan-job-01" ],
    "scan_templates" : {
      "scan-template-01" : "scan-job-01"
    },
    "cycle" : "DAY",
    "status" : "FINISHED",
    "last_run_time" : 1700000000000,
    "create_time" : 1700000000000,
    "last_scan_risk" : "scan-job-01",
    "use_nlp" : true,
    "open" : true,
    "topic_urn" : "urn:smn:cn-north-4:826314dd1b5b4037b9765f9b7a17df46:classification-notice",
    "start_time" : 1700000000000,
    "task_source" : "scan-job-01",
    "workspace_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
    "security_level_name" : "scan-job-01",
    "security_level_color" : 3,
    "asset_infos" : [ {
      "asset_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
      "asset_type" : "OBS"
    } ],
    "scan_time_scope" : 30,
    "scan_sensitivity" : "HIGH",
    "template_type" : "TRADITIONAL",
    "scan_mode" : "FULL",
    "progress" : 100
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档