更新时间:2022-12-29 GMT+08:00

创建扫描任务

功能介绍

根据指定的任务名称、扫描方式、扫描周期、扫描规则组、扫描时间创建扫描任务

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

asset_ids

Array of strings

资产ID列表

cycle

String

扫描周期,日(DAY),周(WEEK),月(MONTH),单次扫描(ONCE)

枚举值:

  • ONCE

  • DAY

  • WEEK

  • MONTH

name

String

扫描任务名

open

Boolean

是否开启任务

rule_group_ids

Array of strings

规则组ID列表

start_time

Long

扫描任务开始时间

time_zone

String

时区

topic_urn

String

主题的唯一资源标识符

use_nlp

Boolean

是否用nlp

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

msg

String

返回消息

status

String

返回状态,如'200','400'

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

创建敏感数据扫描任务

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

{
  "asset_ids" : "xxxxxxxxxxxx",
  "cycle" : "ONCE",
  "name" : "xxxx",
  "open" : true,
  "rule_group_ids" : "xxxxxxxxxxxx",
  "start_time" : 0,
  "time_zone" : 8,
  "topic_urn" : "xxxxxxxxxxxx",
  "use_nlp" : false
}

响应示例

状态码: 200

请求成功

{
  "msg" : "xxxx",
  "status" : "RESPONSE_SUCCESS"
}

状态码: 400

无效请求

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

状态码

状态码

描述

200

请求成功

400

无效请求

错误码

请参见错误码