查询漏洞扫描任务列表 - ListVulScanTask
功能介绍
查询漏洞扫描任务列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/vulnerability/scan-tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为“0”，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参“all_granted_eps”。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 |
|
limit |
否 |
Integer |
每页显示个数 |
|
offset |
否 |
Integer |
偏移量：指定返回记录的开始位置 |
|
scan_type |
否 |
String |
扫描任务的类型，包含如下： -manual : 手动扫描任务 -schedule : 定时扫描任务 |
|
task_id |
否 |
String |
扫描任务ID |
|
min_start_time |
否 |
Long |
扫描任务开始时间的最小值 |
|
max_start_time |
否 |
Long |
扫描任务开始时间的最大值 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Long |
总数 |
|
data_list |
Array of VulScanTaskInfo objects |
漏洞扫描任务列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
任务ID |
|
scan_type |
String |
扫描任务的类型，包含如下： -manual : 手动扫描任务 -schedule : 定时扫描任务 |
|
start_time |
Long |
扫描任务开始的时间 |
|
end_time |
Long |
扫描任务结束的时间 |
|
scan_vul_types |
Array of strings |
该任务扫描的漏洞类型列表 |
|
status |
String |
扫描任务的执行状态，包含如下： -running : 扫描中 -finished : 扫描完成 |
|
scanning_host_num |
Integer |
该任务处于扫描中状态的主机数量 |
|
success_host_num |
Integer |
该任务已扫描成功的主机数量 |
|
failed_host_num |
Integer |
该任务已扫描失败的主机数量 |
|
estimated_time |
Integer |
预计完成时间 |
请求示例
查询任务类型为手动扫描，task_id为195db604-2008-4e8b-a49e-389ab0175beb漏洞扫描任务信息，默认查询第一页10条
GET https://{endpoint}/v5/{project_id}/vulnerability/scan-tasks?offset=0&limit=10&enterprise_project_id=XXX
{
"scan_type" : "manual",
"task_id" : "195db604-2008-4e8b-a49e-389ab0175beb"
}
响应示例
状态码：200
请求已成功
{
"total_num" : 10,
"data_list" : [ {
"id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
"scan_type" : "manual",
"start_time" : 1679042408195,
"end_time" : 1679042408295,
"scan_vul_types" : [ "linux_vul" ],
"status" : "running",
"scanning_host_num" : 1,
"success_host_num" : 1,
"failed_host_num" : 1
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
