文档首页/ 数据安全中心 DSC/ API参考/ API/ 凭据泄露检测/ 添加凭据泄露检测作业 - AddLeakJob
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加凭据泄露检测作业 - AddLeakJob

功能介绍

功能介绍：添加凭据泄露检测Job

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/credential-leakage/scan-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

任务名称

约束限制：

最大长度65535字符

取值范围：

1-255个字符，满足正则匹配"^[a-zA-Z\u4e00-\u9fa5]+[0-9a-zA-Z\u4e00-\u9fa5_-]*$"

默认取值：

不涉及

asset_scopes

否

Array of strings

参数解释：

资产范围

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

asset_ids

否

Array of strings

参数解释：

资产ID列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

rule_group_ids

否

Array of strings

参数解释：

规则组ID列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scan_template_ids

否

Array of strings

参数解释：

扫描模板ID列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

template_type

否

String

参数解释：

泄露作业类型

约束限制：

最大长度65535字符

取值范围：

不涉及

默认取值：

不涉及

sampling_proportion

否

Integer

参数解释：

采样比例

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cycle

否

String

参数解释：

检测周期

约束限制：

最大长度65535字符

取值范围：

  • ONCE-单次

  • DAILY-每天

  • WEEKLY-每周

默认取值：

不涉及

time_zone

否

String

参数解释：

任务时区

约束限制：

最大长度65535字符

取值范围：

不涉及

默认取值：

不涉及

start_time

否

Long

参数解释：

开始时间

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

use_nlp

否

Boolean

参数解释：

是否使用NLP

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

open

否

Boolean

参数解释：

是否开启检测

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

topic_urn

否

String

参数解释：

主题URN

约束限制：

最大长度65535字符

取值范围：

不涉及

默认取值：

不涉及

credential_types

否

Array of strings

参数解释：

凭据类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

incremental_only

否

Boolean

参数解释：

是否仅增量

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scan_time_scope

否

Integer

参数解释：

扫描时间范围

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scan_sensitivity

否

String

参数解释：

扫描敏感度

约束限制：

最大长度65535字符

取值范围：

  • NULL-无

  • LOW-低

  • MIDDLE-中

  • HIGH-高

默认取值：

不涉及

scan_mode

否

String

参数解释：

泄露作业模式

约束限制：

最大长度65535字符

取值范围：

  • FULL-全量扫描

  • INCREMENTAL-增量扫描

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释：

请求状态，success表示成功。

取值范围：

不涉及

msg

String

参数解释：

提示信息

取值范围：

不涉及

id

String

参数解释：

资源ID

取值范围：

不涉及

请求示例

请求示例

{
  "name" : "scan-job-credential-01",
  "asset_scopes" : [ "OBS", "DATABASE" ],
  "asset_ids" : [ "826314dd-1b5b-4037-b976-5f9b7a17df46", "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e" ],
  "rule_group_ids" : [ "826314dd-1b5b-4037-b976-5f9b7a17df46", "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e" ],
  "scan_template_ids" : [ "826314dd-1b5b-4037-b976-5f9b7a17df46", "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e" ],
  "template_type" : "SYSTEM",
  "sampling_proportion" : 100,
  "cycle" : "DAILY",
  "time_zone" : "Asia/Shanghai",
  "start_time" : 1700000000000,
  "use_nlp" : true,
  "open" : true,
  "topic_urn" : "urn:smn:cn-north-7:826314dd1b5b4037b9765f9b7a17df46:dsc-alarm-topic",
  "credential_types" : [ "AK", "IAM_ACCOUNT", "CUSTOM" ],
  "incremental_only" : false,
  "scan_time_scope" : 7,
  "scan_sensitivity" : "HIGH",
  "scan_mode" : "FULL"
}

响应示例

状态码：200

{
  "status" : "success",
  "msg" : "操作成功",
  "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46"
}

状态码

状态码

描述

200

添加凭据泄露检测Job成功

错误码

请参见错误码。

父主题： 凭据泄露检测

相关文档