查询漏洞扫描任务对应的主机列表 - ListVulScanTaskHost
功能介绍
查询漏洞扫描任务对应的主机列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/vulnerability/scan-task/{task_id}/hosts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
task_id |
是 |
String |
任务ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为“0”，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参“all_granted_eps”。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 |
|
limit |
否 |
Integer |
每页显示个数 |
|
offset |
否 |
Integer |
偏移量：指定返回记录的开始位置 |
|
scan_status |
否 |
String |
主机的扫描状态，包含如下： -scanning : 扫描中 -success : 扫描成功 -failed : 扫描失败 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Long |
总数 |
|
data_list |
Array of VulScanTaskHostInfo objects |
漏洞扫描任务对应的主机列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
主机ID |
|
host_name |
String |
主机名称 |
|
public_ip |
String |
弹性公网IP地址 |
|
private_ip |
String |
私有IP地址 |
|
asset_value |
String |
资产重要性，包含如下:
|
|
scan_status |
String |
主机的扫描状态，包含如下： -scanning : 扫描中 -success : 扫描成功 -failed : 扫描失败 |
|
failed_reasons |
Array of failed_reasons objects |
扫描失败的原因列表 |
|
vul_scan_details |
Array of vul_scan_details objects |
该主机的扫描详情信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vul_type |
String |
扫描失败的漏洞类型，包含如下： -linux_vul : linux漏洞 -windows_vul : windows漏洞 -web_cms : Web-CMS漏洞 -app_vul : 应用漏洞 -urgent_vul : 应急漏洞 |
|
failed_reason |
String |
扫描失败的原因 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vul_type |
String |
扫描的漏洞类型，包含如下：
|
|
status |
String |
该类型漏洞的扫描状态，包含如下：
|
|
failed_reason |
String |
扫描失败的原因，只有扫描失败的漏洞类型有该字段 |
|
scan_vul_list |
Array of scan_vul_list objects |
扫描的漏洞列表，只有漏洞类型为应急漏洞有该字段 |
请求示例
查询漏洞扫描任务id为2b31ed520xxxxxxebedb6e57xxxxxxxx详情信息，展示失败的主机列表，包含失败原因，默认查询第一页10条
GET https://{endpoint}/v5/{project_id}/vulnerability/scan-task/{task_id}/hosts?offset=0&limit=10&scan_status=failed&enterprise_project_id=XXX
{
"scan_status" : "failed",
"task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
}
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"host_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"host_name" : "ecs-ubuntu-abc123",
"public_ip" : "112.10.10.3",
"private_ip" : "192.168.10.1",
"asset_value" : "important",
"scan_status" : "failed",
"failed_reasons" : [ {
"vul_type" : "linux_vul",
"failed_reason" : "this_is_failed_reason"
} ],
"vul_scan_details" : [ {
"vul_type" : "linux_vul",
"status" : "failed",
"failed_reason" : "this_is_failed_reason"
}, {
"vul_type" : "urgent_vul",
"status" : "scanning",
"scan_vul_list" : [ {
"vul_id" : "URGENT-CVE-2024-6387",
"vul_name" : "OpenSSH 条件竞争漏洞( CVE-2024-6387)",
"status" : "failed",
"failed_reason" : "this_is_vul_failed_reason"
}, {
"vul_id" : "URGENT-CVE-2024-3094",
"vul_name" : "XZ-Utils 5.6.0-5.6.1版本存在后门风险(CVE-2024-3094)",
"status" : "scanning"
} ]
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
