获取凭据泄露检测作业列表 - ShowLeakJobList
功能介绍
功能介绍:获取凭据泄露检测作业列表。按 project 分页查询凭据泄露检测作业,支持按作业名称模糊搜索,结果按创建时间倒序返回。
响应:请求成功返回HTTP 200及作业列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/credential-leakage/scan-jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页查询时每页返回的条目数量 约束限制: 不涉及 取值范围: 1-1000 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 分页查询的偏移量,表示从第几条记录开始查询 约束限制: 不涉及 取值范围: 0-2147483647 默认取值: 0 |
| content | 否 | String | 参数解释: 作业名称搜索关键字,用于按作业名称模糊匹配 约束限制: 不涉及 取值范围: 不涉及 默认取值: 空字符串 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Long | 参数解释: 总记录数 取值范围: 不涉及 |
| tasks | Array of ScanJobInfo objects | 参数解释: 凭据泄露检测作业列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 作业ID 取值范围: 不涉及 |
| name | String | 参数解释: 作业名称 取值范围: 不涉及 |
| rule_groups | Array of strings | 参数解释: 规则组ID列表 取值范围: 不涉及 |
| scan_templates | Map<String,String> | 参数解释: 扫描模板映射,键为模板ID,值为模板名称 取值范围: 不涉及 |
| cycle | String | 参数解释: 扫描周期 取值范围: |
| status | String | 参数解释: 作业状态 取值范围: |
| last_run_time | Long | 参数解释: 最近运行时间,13位毫秒级Unix时间戳 取值范围: 不涉及 |
| create_time | Long | 参数解释: 创建时间,13位毫秒级Unix时间戳 取值范围: 不涉及 |
| last_scan_risk | String | 参数解释: 最近一次扫描风险等级 取值范围: 不涉及 |
| use_nlp | Boolean | 参数解释: 是否启用 NLP 取值范围: true-启用,false-不启用 |
| open | Boolean | 参数解释: 是否开启作业 取值范围: true-开启,false-关闭 |
| topic_urn | String | 参数解释: SMN 通知主题 URN 取值范围: 不涉及 |
| start_time | Long | 参数解释: 任务下次启动时间,13位毫秒级Unix时间戳 取值范围: 不涉及 |
| task_source | String | 参数解释: 任务来源 取值范围: 不涉及 |
| workspace_id | String | 参数解释: 工作空间ID 取值范围: 不涉及 |
| security_level_name | String | 参数解释: 安全级别名称 取值范围: 不涉及 |
| security_level_color | Integer | 参数解释: 安全级别颜色编号 取值范围: 不涉及 |
| asset_infos | Array of ScanJobAssetInfo objects | 参数解释: 资产信息列表 取值范围: 不涉及 |
| scan_time_scope | Integer | 参数解释: 扫描时间范围 取值范围: 不涉及 |
| scan_sensitivity | String | 参数解释: 扫描敏感度 取值范围: |
| template_type | String | 参数解释: 扫描模板类型 取值范围: TRADITIONAL、LLM |
| scan_mode | String | 参数解释: 扫描模式 取值范围: FULL、INCREMENTAL |
| progress | Integer | 参数解释: 扫描进度 取值范围: 0-100 |
请求示例
获取凭据泄露检测作业列表请求示例
/v1/2b31ed5200000ebedb6e570000000000/credential-leakage/scan-jobs?limit=10&offset=0&content=scan-job
响应示例
状态码:200
{
"total" : 1,
"tasks" : [ {
"id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"name" : "scan-job-credential-01",
"rule_groups" : [ "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e" ],
"scan_templates" : {
"3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d" : "scan-template-01"
},
"cycle" : "DAY",
"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" : [ {
"asset_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"asset_type" : "OBS"
} ],
"scan_time_scope" : 7,
"scan_sensitivity" : "HIGH",
"template_type" : "TRADITIONAL",
"scan_mode" : "FULL",
"progress" : 100
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。