文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 资产管理/ 查询指定Web服务、Web应用、数据库的服务器列表 - ListWebAppAndServices
更新时间:2025-10-31 GMT+08:00
分享

查询指定Web服务、Web应用、数据库的服务器列表 - ListWebAppAndServices

功能介绍

查询指定Web服务、Web应用、数据库的服务器列表

授权信息

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

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

URI

GET /v5/{project_id}/asset/web-app-and-services

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

offset

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

category

String

参数解释:

资产类别

约束限制:

不涉及

取值范围:

  • host:主机资产

  • container:容器资产

默认取值:

host

name

String

参数解释:

web应用,web服务或数据库名称

约束限制:

不涉及

取值范围:

字符长度0-256

默认取值:

不涉及

catalogue

String

参数解释:

资产类型

约束限制:

不涉及

取值范围:

  • web-app:web应用

  • web-service:web服务

  • database:数据库

默认取值:

不涉及

host_name

String

参数解释:

服务器名称(可选),可让用户根据主机名字搜索

约束限制:

不涉及

取值范围:

字符长度0-256

默认取值:

不涉及

host_id

String

参数解释:

服务器id(可选),可让用户根据主机id搜索

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

host_ip

String

参数解释:

服务器ip(可选),可让用户根据主机ip搜索

约束限制:

不涉及

取值范围:

字符长度0-256

默认取值:

不涉及

version

String

参数解释:

web应用,web服务或数据库版本,可让用户根据版本搜索

约束限制:

不涉及

取值范围:

字符长度0-256

默认取值:

不涉及

install_dir

String

参数解释:

web应用,web服务或数据库安装目录,可让用户根据安装目录搜索

约束限制:

不涉及

取值范围:

字符长度0-256

默认取值:

不涉及

part_match

Boolean

参数解释:

是否模糊匹配,默认false表示精确匹配

约束限制:

不涉及

取值范围:

  • true:模糊匹配

  • false:精确匹配

默认取值:

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释

总数

取值范围

最小值0,最大值300000

data_list

Array of WebAppAndServiceResponseInfo objects

参数解释

具有该web应用、web服务、数据库资产的主机及该资产信息列表

取值范围

最小值0,最大值10000

表5 WebAppAndServiceResponseInfo

参数

参数类型

描述

catalogue

String

参数解释:

web应用、web服务、数据库资产指纹种类

取值范围:

字符长度0-64

name

String

参数解释:

资产指纹名字

取值范围:

字符长度0-64

version

String

参数解释:

资产指纹版本

取值范围:

字符长度0-64

agent_id

String

参数解释

agent id

取值范围

字符长度1-64

install_path

String

参数解释

安装路径

取值范围

字符长度0-256

config_path

String

参数解释

配置文件路径

取值范围

字符长度0-256

uid

Integer

参数解释:

uid

取值范围:

最小值0,最大值2147483647

gid

Integer

参数解释:

gid

取值范围:

最小值0,最大值2147483647

mode

String

参数解释:

资产指纹文件权限

取值范围:

字符长度1-32

ctime

Long

参数解释:

资产指纹文件最近状态改变时间

取值范围:

最小值0,最大值2^63-1

mtime

Long

参数解释:

资产指纹文件最近修改时间

取值范围:

最小值0,最大值2^63-1

atime

Long

参数解释:

资产指纹文件最近访问时间

取值范围:

最小值0,最大值2^63-1

pid

Integer

参数解释:

pid

取值范围:

最小值0,最大值2147483647

proc_path

String

参数解释:

资产指纹进程路径

取值范围:

字符长度0-256

container_id

String

参数解释:

容器id

取值范围:

字符长度0-256

container_name

String

参数解释:

容器名称

取值范围:

字符长度0-256

record_time

Long

参数解释:

资产指纹扫描时间

取值范围:

最小值0,最大值2^63-1

host_id

String

参数解释

主机id

取值范围

字符长度1-64

host_name

String

参数解释

服务器名称

取值范围

字符长度1-64

host_ip

String

参数解释

服务器ip

取值范围

字符长度1-64

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "catalogue" : "database",
    "name" : "mysql",
    "version" : "5.7.22",
    "agent_id" : "64cdb070d5497fa64b1482ce5d91580006615f20eb373d7377ad6f34015ce49f",
    "install_path" : "/usr/sbin",
    "config_path" : "/etc/my.cnf",
    "uid" : 0,
    "gid" : 0,
    "mode" : "dr-xr-xr-x",
    "ctime" : 1739346659,
    "mtime" : 1739346659,
    "atime" : 1743392605,
    "pid" : 1310,
    "proc_path" : "/usr/sbin/mysqld",
    "container_id" : "",
    "container_name" : "",
    "record_time" : 1743972146053,
    "host_name" : "test-lmh-005",
    "host_id" : "44ba96ad-91e4-40d7-9f51-34f999755712",
    "host_ip" : "192.168.0.77"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档