文档首页/ 数据安全中心 DSC/ API参考/ API/ 任务管理/ 添加扫描Job - CreateJob
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加扫描Job - CreateJob

功能介绍

功能介绍：添加扫描Job

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

扫描任务名称

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

asset_scope

否

Array of AssetScope objects

参数解释：

作业范围

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

asset_ids

否

Array of strings

参数解释：

资产ID列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

rule_group_ids

否

Array of strings

参数解释：

规则分组ID列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scan_template_ids

否

Array of strings

参数解释：

扫描模板ID列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

template_type

否

String

参数解释：

作业类型

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

sampling_proportion

否

Integer

参数解释：

采样比例

约束限制：

最大值2147483647

取值范围：

不涉及

默认取值：

不涉及

cycle

否

String

参数解释：

扫描周期

约束限制：

不涉及

取值范围：

  • ONCE-单次执行

  • DAY-每天

  • WEEK-每周

  • MONTH-每月

默认取值：

不涉及

time_zone

否

String

参数解释：

时间可用区

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

start_time

否

Long

参数解释：

开始时间

约束限制：

最大值2147483647

取值范围：

不涉及

默认取值：

不涉及

use_nlp

否

Boolean

参数解释：

已用自然语言处理

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

open

否

Boolean

参数解释：

是否开启扫描

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

topic_urn

否

String

参数解释：

主题URN

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

credential_types

否

Array of strings

参数解释：

凭证类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

incremental_only

否

Boolean

参数解释：

扫描时间范围

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scan_time_scope

否

Integer

参数解释：

扫描敏感度

约束限制：

最大值2147483647

取值范围：

不涉及

默认取值：

不涉及

scan_sensitivity

否

String

参数解释：

增量仅

约束限制：

不涉及

取值范围：

  • NULL-空

  • LOW-低

  • MIDDLE-中

  • HIGH-高

默认取值：

不涉及

scan_mode

否

String

参数解释：

作业模式

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及
表4 AssetScope

参数

是否必选

参数类型

描述

asset_id

否

Array of strings

参数解释：

资产ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scope

否

String

参数解释：

资产范围范围

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

pattern

否

String

参数解释：

匹配模式

约束限制：

最大长度1024字符

取值范围：

不涉及

默认取值：

不涉及

include

否

Boolean

参数解释：

是否包含

约束限制：

不涉及

取值范围：

true-是，false-否

默认取值：

不涉及

depth

否

Integer

参数解释：

扫描深度

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

index

否

Integer

参数解释：

资产索引

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

type

否

Integer

参数解释：

资产类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释：

操作结果状态

取值范围：

不涉及

msg

String

参数解释：

操作结果描述信息

取值范围：

不涉及

id

String

参数解释：

资源ID，唯一标识

取值范围：

不涉及

请求示例

添加扫描Job

{
  "name" : "scan-job-01",
  "asset_scope" : [ {
    "asset_id" : [ "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f", "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" ],
    "scope" : "scan-job-01",
    "pattern" : "\\d{11}",
    "include" : true,
    "depth" : 1,
    "index" : 100,
    "type" : 100
  }, {
    "asset_id" : [ "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f", "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" ],
    "scope" : "scan-job-01",
    "pattern" : "\\d{11}",
    "include" : true,
    "depth" : 1,
    "index" : 100,
    "type" : 100
  } ],
  "asset_ids" : [ "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f", "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" ],
  "rule_group_ids" : [ "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e", "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b" ],
  "scan_template_ids" : [ "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b", "0b4c5d6e-7f8a-4b9c-4d5e-3f2a1b0c9d8e" ],
  "template_type" : "BUILT_IN",
  "sampling_proportion" : 100,
  "cycle" : "DAY",
  "time_zone" : "Asia/Shanghai",
  "start_time" : 1700000000000,
  "use_nlp" : true,
  "open" : true,
  "topic_urn" : "urn:smn:cn-north-4:826314dd1b5b4037b9765f9b7a17df46:classification-notice",
  "credential_types" : [ "OBS" ],
  "incremental_only" : true,
  "scan_time_scope" : 1700000000000,
  "scan_sensitivity" : "HIGH",
  "scan_mode" : "AUTO"
}

响应示例

状态码：200

{
  "status" : "success",
  "msg" : "创建扫描任务成功",
  "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 任务管理

相关文档