文档首页/ 数据安全中心 DSC/ API参考/ API/ 凭据泄露检测/ 获取凭据泄露检测作业列表 - ShowLeakJobList
更新时间:2026-10-09 GMT+08:00
分享

获取凭据泄露检测作业列表 - ShowLeakJobList

功能介绍

功能介绍:获取凭据泄露检测Job列表

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

分页查询时每页返回的条目数量。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

10

offset

否

Integer

参数解释:

分页查询的偏移量,表示从第几条记录开始查询。

约束限制:

不涉及

取值范围:

0-2147483647

默认取值:

0

content

否

String

参数解释:

扫描内容

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

tasks

Array of ScanJobInfo objects

参数解释:

扫描任务列表

取值范围:

不涉及

表5 ScanJobInfo

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

扫描任务名称

取值范围:

不涉及

rule_groups

Array of strings

参数解释:

规则组ID列表

取值范围:

不涉及

scan_templates

String

参数解释:

扫描模板

取值范围:

不涉及

cycle

String

参数解释:

执行周期

取值范围:

  • ONCE-单次

  • DAILY-每天

  • WEEKLY-每周

  • MONTHLY-每月

status

String

参数解释:

操作结果状态

取值范围:

  • INIT-初始化

  • WAITING-等待中

  • RUNNING-运行中

  • FAILED-失败

  • STOPPED-已停止

  • FINISHED-已完成

  • TERMINATED-已终止

  • QUOTA_RESTRICTED-配额受限

  • OBS_QUOTA_RESTRICTED-OBS配额受限

  • DB_QUOTA_RESTRICTED-数据库配额受限

  • LOCKED-已锁定

last_run_time

Long

参数解释:

上次运行时间

取值范围:

不涉及

create_time

Long

参数解释:

创建时间

取值范围:

不涉及

last_scan_risk

String

参数解释:

上次扫描风险等级

取值范围:

不涉及

use_nlp

Boolean

参数解释:

是否使用NLP

取值范围:

true-是,false-否

open

Boolean

参数解释:

是否开启扫描

取值范围:

true-是,false-否

topic_urn

String

参数解释:

通知主题URN

取值范围:

不涉及

start_time

Long

参数解释:

开始时间

取值范围:

不涉及

task_source

String

参数解释:

任务来源

取值范围:

不涉及

workspace_id

String

参数解释:

扫描作业信息ID

取值范围:

不涉及

security_level_name

String

参数解释:

风险等级名称

取值范围:

不涉及

security_level_color

Integer

参数解释:

安全等级颜色

取值范围:

不涉及

asset_infos

Array of CommonIdNameInfo objects

参数解释:

资产信息列表

取值范围:

不涉及

scan_time_scope

Integer

参数解释:

扫描时间范围

取值范围:

不涉及

template_type

String

参数解释:

扫描作业信息类型

取值范围:

不涉及

scan_mode

String

参数解释:

扫描作业信息模式

取值范围:

不涉及

progress

Integer

参数解释:

扫描进度

取值范围:

不涉及

created_time

Long

参数解释:

创建时间

取值范围:

不涉及

is_default

Boolean

参数解释:

是否默认

取值范围:

true-是,false-否

job_id

String

参数解释:

作业ID

取值范围:

不涉及

job_name

String

参数解释:

作业名称

取值范围:

不涉及

name_en

String

参数解释:

英文名称

取值范围:

不涉及

num_of_tables_scanned

Long

参数解释:

已扫描表数量

取值范围:

不涉及

表6 CommonIdNameInfo

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

通用名称

取值范围:

不涉及

tag_gen_type

String

参数解释:

标签生成类型

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "total" : 2,
  "tasks" : [ {
    "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "name" : "scan-job-credential-01",
    "rule_groups" : [ "rule-group-encrypt-01", "rule-group-leakage-01" ],
    "scan_templates" : "scan-template-01",
    "cycle" : "DAILY",
    "status" : "FINISHED",
    "last_run_time" : 1700000000000,
    "create_time" : 1700000000000,
    "last_scan_risk" : "HIGH",
    "use_nlp" : true,
    "open" : true,
    "topic_urn" : "urn:smn:cn-north-7:826314dd1b5b4037b9765f9b7a17df46:dsc-alarm-topic",
    "start_time" : 1700000000000,
    "task_source" : "SYSTEM",
    "workspace_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "security_level_name" : "中风险",
    "security_level_color" : 2,
    "asset_infos" : [ {
      "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
      "name" : "scan-job-credential-01",
      "tag_gen_type" : "AUTO"
    }, {
      "id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
      "name" : "scan-job-credential-01",
      "tag_gen_type" : "AUTO"
    } ],
    "scan_time_scope" : 7,
    "template_type" : "SYSTEM",
    "scan_mode" : "FULL",
    "progress" : 100
  }, {
    "id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
    "name" : "scan-job-credential-01",
    "rule_groups" : [ "rule-group-encrypt-01", "rule-group-leakage-01" ],
    "scan_templates" : "scan-template-01",
    "cycle" : "DAILY",
    "status" : "FINISHED",
    "last_run_time" : 1700000000000,
    "create_time" : 1700000000000,
    "last_scan_risk" : "HIGH",
    "use_nlp" : true,
    "open" : true,
    "topic_urn" : "urn:smn:cn-north-7:826314dd1b5b4037b9765f9b7a17df46:dsc-alarm-topic",
    "start_time" : 1700000000000,
    "task_source" : "SYSTEM",
    "workspace_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
    "security_level_name" : "中风险",
    "security_level_color" : 2,
    "asset_infos" : [ {
      "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
      "name" : "scan-job-credential-01",
      "tag_gen_type" : "AUTO"
    }, {
      "id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
      "name" : "scan-job-credential-01",
      "tag_gen_type" : "AUTO"
    } ],
    "scan_time_scope" : 7,
    "template_type" : "SYSTEM",
    "scan_mode" : "FULL",
    "progress" : 100
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档