文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 主机管理/ 查询服务器列表-公共接口 - ListCommonHost
更新时间:2026-05-11 GMT+08:00
分享

查询服务器列表-公共接口 - ListCommonHost

功能介绍

查询服务器列表-公共接口

调用方法

请参见如何调用API

授权信息

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

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

URI

GET /v5/{project_id}/common/hosts

表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

默认取值:

不涉及

limit

Integer

参数解释:

每页显示个数

约束限制:

必填

取值范围:

取值10-200

默认取值:

10

host_id

String

参数解释:

服务器ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

host_name

String

参数解释:

服务器名称

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

private_ip

String

参数解释:

服务器私有IP

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

public_ip

String

参数解释:

服务器弹性IP地址

约束限制:

不涉及

取值范围:

IPv4格式(长度7-15位)、IPv6格式(长度15-39位)

默认取值:

feature_name

String

参数解释:

策略名称

约束限制:

不涉及

取值范围:

取值范围:

  • av_detect_feature:AV策略

默认取值:

group_id

String

参数解释:

服务器组的唯一标识ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

asset_value

String

参数解释:

资产重要性

约束限制:

不涉及

取值范围

  • important:重要资产

  • common:一般资产

  • test:测试资产

默认取值:

不涉及

agent_status

String

参数解释

Agent状态

约束限制:

不涉及

取值范围

  • installed:已安装

  • not_installed:未安装

  • online:在线

  • offline:离线

  • install_failed:安装失败

  • installing:安装中

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

cluster_name

String

参数解释:

集群名称

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

version_name_upper

String

参数解释

主机开通的版本,高于该版本

约束限制:

不涉及

取值范围

  • hss.version.basic:基础版。

  • hss.version.advanced:专业版。

  • hss.version.enterprise:企业版。

  • hss.version.premium:旗舰版。

  • hss.version.wtp:网页防篡改版。

  • hss.version.container.enterprise:容器版。

默认取值:

不涉及

version_name_lower

String

参数解释

主机开通的版本,低于该版本

约束限制:

不涉及

取值范围

  • hss.version.basic:基础版。

  • hss.version.advanced:专业版。

  • hss.version.enterprise:企业版。

  • hss.version.premium:旗舰版。

  • hss.version.wtp:网页防篡改版。

  • hss.version.container.enterprise:容器版。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值2147483647

data_list

Array of CommonHostResponseInfo objects

列表

表5 CommonHostResponseInfo

参数

参数类型

描述

host_id

String

参数解释:

服务器的唯一标识ID

取值范围:

字符长度1-64位

host_name

String

参数解释:

服务器名称

取值范围:

字符长度1-256位

public_ip

String

参数解释:

服务器弹性IP地址

取值范围:

IPv4格式(长度7-15位)、IPv6格式(长度15-39位)

private_ip

String

参数解释:

服务器私有IP

取值范围:

字符长度1-128位

agent_id

String

参数解释:

主机上安装的杀毒Agent的唯一标识ID,用于关联主机与杀毒服务

取值范围:

字符长度1-64位

os_type

String

参数解释

操作系统类型

取值范围

  • Linux:Linux

  • Windows:Windows

host_status

String

参数解释

服务器状态

取值范围

  • ACTIVE:运行中

  • SHUTOFF:关机

  • BUILDING:创建中

  • ERROR:故障

agent_status

String

参数解释

Agent状态

取值范围

  • installed:已安装

  • not_installed:未安装

  • online:在线

  • offline:离线

  • install_failed:安装失败

  • installing:安装中

os_name

String

参数解释:

操作系统名称

取值范围:

字符长度1-64位

os_version

String

参数解释:

操作系统版本

取值范围:

字符长度1-64位

asset_value

String

参数解释:

资产重要性

约束限制:

不涉及

取值范围

  • important:重要资产

  • common:一般资产

  • test:测试资产

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID

取值范围:

字符长度1-64位

cluster_name

String

参数解释:

集群名称

取值范围:

字符长度1-256位

group_id

String

参数解释:

服务器组ID

取值范围:

字符范围1-64位

group_name

String

参数解释:

集群名称

取值范围:

字符长度1-256位

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "c99059b9-a0c1-4314-ad0b-b0b23e173ca2",
    "host_name" : "host-10-0-0-116",
    "public_ip" : "",
    "private_ip" : "10.0.0.116,172.17.0.1",
    "agent_id" : "b3a68e22d489e46d7b4d3fc0706b8e196cfb337cf2a440e1baa6d49c5e321de3",
    "os_type" : "Linux"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档