文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 资产管理/ 查询软件的服务器列表 - ListApps
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询软件的服务器列表 - ListApps

功能介绍

查询软件的服务器列表

授权信息

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

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

URI

GET /v5/{project_id}/asset/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

host_id

否

String

参数解释:

服务器ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

host_name

否

String

参数解释:

服务器名称

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

app_name

否

String

参数解释:

软件名称

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

host_ip

否

String

参数解释:

服务器IP

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

version

否

String

参数解释:

软件版本号

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

install_dir

否

String

参数解释:

安装目录

约束限制:

不涉及

取值范围:

字符长度0-512位

默认取值:

不涉及

enterprise_project_id

否

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

limit

否

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

否

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

默认为0

category

否

String

参数解释:

类别

约束限制:

不涉及

取值范围:

  • host：主机

  • container：容器

默认取值:

不涉及

part_match

否

Boolean

参数解释:

是否模糊匹配

约束限制:

boolean类型

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0，最大值2147483647

data_list

Array of AppResponseInfo objects

参数解释:

软件列表

取值范围:

最小值0，最大值10000
表5 AppResponseInfo

参数

参数类型

描述

agent_id

String

参数解释：

agent ID

取值范围：

不涉及

host_id

String

参数解释：

服务器 ID

取值范围：

不涉及

host_name

String

参数解释：

服务器名称

取值范围：

不涉及

host_ip

String

参数解释：

服务器 IP

取值范围：

不涉及

app_name

String

参数解释：

软件名称

取值范围：

不涉及

version

String

参数解释：

软件版本

取值范围：

不涉及

install_dir

String

参数解释：

软件安装路径

取值范围：

不涉及

container_id

String

参数解释：

容器 ID

取值范围：

不涉及

container_name

String

参数解释：

容器名称

取值范围：

不涉及

recent_scan_time

Long

参数解释

最近扫描时间

取值范围

不涉及

update_time

Long

参数解释

更新时间

取值范围

不涉及

请求示例

默认查询前10条软件名称为acl的服务器列表

GET https://{endpoint}/v5/{project_id}/asset/apps?app_name=acl

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8",
    "host_id" : "55dac7fe-d81b-43bc-a4a7-4710fe673972",
    "host_name" : "xxxx",
    "host_ip" : "192.168.0.126",
    "app_name" : "acl",
    "version" : "2.2.51-14.eulerosv2r7",
    "update_time" : 1668150671981,
    "recent_scan_time" : 1668506044147,
    "container_id" : "ce794b8a6071f5fd7e4d142dab7b36bedf2c7a4f6083fb82e5bbc82709b50018",
    "container_name" : "hss_imagescan_W73V1WO6"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 资产管理

相关文档