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

查询扫描任务列表

功能介绍

查询扫描任务列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

页码

limit

否

Integer

分页大小

content

否

String

内容

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

tasks

Array of ScanJob objects

本次返回的扫描任务列表

total

Long

任务总数
表4 ScanJob

参数

参数类型

描述

id

String

任务ID

name

String

任务名称

rule_groups

Array of strings

任务使用的规则组

cycle

String

任务执行方式

枚举值：

  • ONCE

  • DAY

  • WEEK

  • MONTH

status

String

任务当前状态

枚举值：

  • INIT

  • WAITING

  • RUNNING

  • FAILED

  • STOPPED

  • FINISHED

  • TERMINATED

last_run_time

Long

任务上一次执行时间

create_time

Long

任务创建时间

last_scan_risk

String

任务上一次扫描风险等级结果

use_nlp

Boolean

是否使用了NLP进行扫描

open

Boolean

任务开启状态

topic_urn

String

SMN服务通知主题

start_time

Long

任务启动时间

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询扫描任务列表

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

响应示例

状态码： 200

OK

{
  "total" : 1,
  "tasks" : [ {
    "id" : "xxxxxxx",
    "name" : "ScanDemo",
    "cycle" : "ONCE",
    "status" : "FINISHED",
    "open" : true,
    "rule_groups" : [ "PCI" ],
    "last_run_time" : 1634612489173,
    "create_time" : 1630982438506,
    "last_scan_risk" : "HIGH",
    "use_nlp" : false,
    "topic_urn" : "",
    "start_time" : 1630983532673
  } ]
}

状态码： 400

无效请求

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

状态码

状态码

描述

200

OK

400

无效请求

错误码

请参见错误码。

父主题： 敏感数据发现