文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 主机管理/ 统计服务器数据 - ShowHostsStatistics
更新时间:2025-10-31 GMT+08:00
分享

统计服务器数据 - ShowHostsStatistics

功能介绍

统计服务器数据

授权信息

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

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

URI

GET /v5/{project_id}/host-management/host-statistics

表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)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

服务器总数

risk_num

Integer

有风险服务器数

unprotected_num

Integer

未防护服务器数

not_installed_num

Integer

Agent未安装数

installed_failed_num

Integer

Agent安装失败数

not_online_num

Integer

Agent不在线数

version_basic_num

Integer

开启基础版服务器数

version_advanced_num

Integer

开启专业版服务器数

version_enterprise_num

Integer

开启企业版服务器数

version_premium_num

Integer

开启旗舰版服务器数

version_wtp_num

Integer

开启网页防篡改版服务器数

version_container_num

Integer

开启容器版服务器数

host_group_num

Integer

服务器组总数

server_group_num

Integer

资产服务器组数量

asset_value_list

Array of AssetValueHostNumInfo objects

资产重要性列表

server_group_list

Array of ServerGroupItem objects

服务器组列表

ignore_host_num

Integer

已忽略服务器数

protected_num

Integer

防护中服务器数

protect_interrupt_num

Integer

防护中断服务器数

idle_num

Integer

空闲配额数

premium_non_sp_num

Integer

旗舰版主机未开启agent自保护数

表5 AssetValueHostNumInfo

参数

参数类型

描述

value_type

String

重要性类型

host_num

Integer

主机数量

表6 ServerGroupItem

参数

参数类型

描述

server_group_id

String

服务器组ID

server_group_name

String

服务器组名称

host_num

Integer

服务器组分配的主机数量

请求示例

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档