文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 查询受影响服务器详情-软件列表 - ListVulHostApps
更新时间:2025-10-31 GMT+08:00
分享

查询受影响服务器详情-软件列表 - ListVulHostApps

功能介绍

查询受影响服务器详情-软件列表

授权信息

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

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

URI

GET /v5/{project_id}/vulnerability/{host_id}/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

host_id

String

参数解释:

主机id

约束限制:

不涉及

取值范围:

字符长度1-128

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

vul_id

String

参数解释:

漏洞ID

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

handle_status

String

参数解释:

漏洞处置状态

约束限制:

不涉及

取值范围:

  • handled : 已处理

  • unhandled : 未处理

默认取值:

不涉及

container_id

String

参数解释:

存在漏洞的容器ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

is_container

Boolean

参数解释:

是否是容器场景

约束限制:

不涉及

取值范围:

  • true:是容器场景

  • false:不是容器场景

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of data_list objects

参数解释:

软件信息列表

取值范围:

不涉及

total_num

Integer

参数解释:

总数

取值范围:

取值0-2147483647

表5 data_list

参数

参数类型

描述

app_name

String

参数解释:

app名称

取值范围:

字符长度1-128位

path

String

参数解释:

存在漏洞的软件路径,仅应用漏洞、应急漏洞等存在软件路径的漏洞类型查询时存在该字段(注:该字段即将弃用,请使用paths字段获取软件路径相关信息)

取值范围:

字符长度1-512位

paths

Array of paths objects

参数解释:

存在漏洞的软件路径列表,仅应用漏洞、应急漏洞等存在软件路径的漏洞类型查询时存在该字段

取值范围:

不涉及

rule

String

参数解释:

软件命中的漏洞匹配规则

取值范围:

字符长度1-512位

表6 paths

参数

参数类型

描述

app_path

String

参数解释:

存在漏洞的软件路径

取值范围:

字符长度1-512位

app_version

String

参数解释:

软件版本

取值范围:

字符长度1-64位

status

String

参数解释:

漏洞状态

取值范围:

  • vul_status_unfix:未处理

  • vul_status_ignored:已忽略

  • vul_status_verified:验证中

  • vul_status_fixing:修复中

  • vul_status_fixed:修复成功

  • vul_status_reboot:修复成功待重启

  • vul_status_failed:修复失败

  • vul_status_fix_after_reboot:请重启主机再次修复

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "mysql",
    "path" : "/usr/sbin",
    "paths" : [ {
      "app_path" : "/usr/sbin",
      "app_version" : "5.7.22",
      "status" : "vul_status_unfix"
    } ],
    "rule" : "Your mysql version has this vulnerability. Current version: 5.7.22 Versions with this vulnerability: (5.7.0,5.7.24)"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档