文档首页/ 数据安全中心 DSC/ API参考/ API/ 凭据泄露管理/ 添加凭据泄露检测作业 - AddLeakJob
更新时间:2026-11-13 GMT+08:00
分享

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

功能介绍

功能介绍:添加凭据泄露检测作业。创建凭据泄露扫描作业,需指定作业名称、资产、扫描周期与模板类型;凭据类型非空时按凭据泄露场景处理。

响应:请求成功返回HTTP 200,响应体仅包含 status。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释:

作业名称

约束限制:

长度4~255字符,满足正则匹配"^[a-zA-Z\u4e00-\u9fa5]+[0-9a-zA-Z\u4e00-\u9fa5_-]{3,254}$"

取值范围:

不涉及

默认取值:

不涉及

asset_scope

否

Array of AssetScope objects

参数解释:

扫描范围配置列表,数组元素为AssetScope对象

约束限制:

最多500个元素

取值范围:

不涉及

默认取值:

不涉及

asset_ids

是

Array of strings

参数解释:

待扫描资产ID列表,数组元素为String类型

约束限制:

最多500个元素,每个元素必须为合法 UUID

取值范围:

不涉及

默认取值:

不涉及

rule_group_ids

否

Array of strings

参数解释:

规则组ID列表,数组元素为String类型

约束限制:

最多500个元素,每个元素必须为合法 UUID

取值范围:

不涉及

默认取值:

不涉及

scan_template_ids

否

Array of strings

参数解释:

扫描模板ID列表,数组元素为String类型

约束限制:

非空时最多1个元素,且必须为合法 UUID;与 rule_group_ids 不能同时使用(凭据类型非空时除外)

取值范围:

不涉及

默认取值:

不涉及

template_type

是

String

参数解释:

扫描模板类型

约束限制:

取值必须为 TRADITIONAL、LLM 之一

取值范围:

  • TRADITIONAL-传统模板

  • LLM-大模型模板

默认取值:

不涉及

sampling_proportion

否

Integer

参数解释:

采样比例

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cycle

是

String

参数解释:

扫描周期

约束限制:

取值必须为 ONCE、DAY、WEEK、MONTH 之一

取值范围:

  • ONCE-仅一次

  • DAY-每天

  • WEEK-每周

  • MONTH-每月

默认取值:

不涉及

time_zone

否

String

参数解释:

时区

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

start_time

否

Long

参数解释:

任务下次启动时间,13位毫秒级Unix时间戳

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

use_nlp

否

Boolean

参数解释:

是否启用 NLP

约束限制:

不涉及

取值范围:

true-启用,false-不启用

默认取值:

不涉及

open

否

Boolean

参数解释:

是否开启作业

约束限制:

不涉及

取值范围:

true-开启,false-关闭

默认取值:

不涉及

topic_urn

否

String

参数解释:

SMN 通知主题 URN

约束限制:

非空时长度不超过512字符,按":"切分必须为5段且第4段等于 project_id

取值范围:

不涉及

默认取值:

不涉及

credential_types

否

Array of strings

参数解释:

凭据类型列表,数组元素为String类型

约束限制:

非空时按凭据泄露检测场景处理

取值范围:

  • AK-AK/SK凭据

  • IAM_ACCOUNT-IAM账号凭据

  • CUSTOM-自定义凭据

默认取值:

不涉及

incremental_only

否

Boolean

参数解释:

是否仅进行增量扫描

约束限制:

不涉及

取值范围:

true-仅增量扫描,false-全量扫描

默认取值:

false

scan_time_scope

否

Integer

参数解释:

扫描时间范围

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

scan_sensitivity

否

String

参数解释:

扫描敏感度

约束限制:

取值必须为 NULL、LOW、MIDDLE、HIGH 之一

取值范围:

  • NULL-未设置

  • LOW-低敏感

  • MIDDLE-中敏感

  • HIGH-高敏感

默认取值:

NULL

scan_mode

否

String

参数解释:

扫描模式

约束限制:

取值必须为 FULL、INCREMENTAL 之一

取值范围:

  • FULL-全量扫描

  • INCREMENTAL-增量扫描

默认取值:

FULL

表4 AssetScope

参数

是否必选

参数类型

描述

asset_id

否

Array of strings

参数解释:

资产ID列表,数组元素为String类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

scope

否

String

参数解释:

扫描范围类型

约束限制:

当 depth 为 0 时,scope 与 pattern 均不能为空

取值范围:

  • pre-前缀

  • post-后缀

  • dir-目录

默认取值:

不涉及

pattern

否

String

参数解释:

扫描范围匹配表达式

约束限制:

当 depth 为 0 时,scope 与 pattern 均不能为空

取值范围:

不涉及

默认取值:

不涉及

include

否

Boolean

参数解释:

是否包含匹配项

约束限制:

不涉及

取值范围:

true-包含,false-排除

默认取值:

不涉及

depth

否

Integer

参数解释:

扫描深度

约束限制:

取值范围 0~10

取值范围:

0-10

默认取值:

0

index

否

Integer

参数解释:

索引

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

type

否

Integer

参数解释:

范围类型编号

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求状态,success表示成功。

取值范围:

不涉及

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

资源ID,唯一标识操作返回对应的资源对象

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "status" : "success"
}

状态码

状态码

描述

200

添加凭据泄露检测作业成功

错误码

请参见错误码。

相关文档